Skip to content

G
gitlab-ce
Commit 0c144a6e authored by Sean Arnold's avatar Sean Arnold Committed by charlie ablett
Browse files
Options

Deprecate lowercase enums in BaseEnum 

- Update docs
parent 75544577
Hide whitespace changes
Inline Side-by-side
Showing with 73 additions and 68 deletions
app/graphql/types/sort_enum.rb
View file @ 0c144a6e
...@@ -7,10 +7,10 @@ module Types ...@@ -7,10 +7,10 @@ module Types
# Deprecated, as we prefer uppercase enums # Deprecated, as we prefer uppercase enums
# https://gitlab.com/groups/gitlab-org/-/epics/1838 # https://gitlab.com/groups/gitlab-org/-/epics/1838
value 'updated_desc', 'Updated at descending order' value 'updated_desc', 'Updated at descending order', deprecated: { reason: 'Use UPDATED_DESC', milestone: '13.5' }
value 'updated_asc', 'Updated at ascending order' value 'updated_asc', 'Updated at ascending order', deprecated: { reason: 'Use UPDATED_ASC', milestone: '13.5' }
value 'created_desc', 'Created at descending order' value 'created_desc', 'Created at descending order', deprecated: { reason: 'Use CREATED_DESC', milestone: '13.5' }
value 'created_asc', 'Created at ascending order' value 'created_asc', 'Created at ascending order', deprecated: { reason: 'Use CREATED_ASC', milestone: '13.5' }
value 'UPDATED_DESC', 'Updated at descending order', value: :updated_desc value 'UPDATED_DESC', 'Updated at descending order', value: :updated_desc
value 'UPDATED_ASC', 'Updated at ascending order', value: :updated_asc value 'UPDATED_ASC', 'Updated at ascending order', value: :updated_asc
......
changelogs/unreleased/sarnold-deprecate-lowercase-enums.yml 0 → 100644
View file @ 0c144a6e
---
title: Deprecate lowercase values for sort enums in GraphQL
merge_request: 43650
author:
type: changed
doc/api/graphql/reference/gitlab_schema.graphql
View file @ 0c144a6e
...@@ -527,22 +527,22 @@ enum AlertManagementAlertSort { ...@@ -527,22 +527,22 @@ enum AlertManagementAlertSort {
""" """
Created at ascending order Created at ascending order
""" """
created_asc created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
""" """
Created at descending order Created at descending order
""" """
created_desc created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
""" """
Updated at ascending order Updated at ascending order
""" """
updated_asc updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
""" """
Updated at descending order Updated at descending order
""" """
updated_desc updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
} }
""" """
...@@ -9342,22 +9342,22 @@ enum IssueSort { ...@@ -9342,22 +9342,22 @@ enum IssueSort {
""" """
Created at ascending order Created at ascending order
""" """
created_asc created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
""" """
Created at descending order Created at descending order
""" """
created_desc created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
""" """
Updated at ascending order Updated at ascending order
""" """
updated_asc updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
""" """
Updated at descending order Updated at descending order
""" """
updated_desc updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
} }
""" """
...@@ -11203,22 +11203,22 @@ enum MergeRequestSort { ...@@ -11203,22 +11203,22 @@ enum MergeRequestSort {
""" """
Created at ascending order Created at ascending order
""" """
created_asc created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
""" """
Created at descending order Created at descending order
""" """
created_desc created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
""" """
Updated at ascending order Updated at ascending order
""" """
updated_asc updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
""" """
Updated at descending order Updated at descending order
""" """
updated_desc updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
} }
""" """
...@@ -17522,22 +17522,22 @@ enum Sort { ...@@ -17522,22 +17522,22 @@ enum Sort {
""" """
Created at ascending order Created at ascending order
""" """
created_asc created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
""" """
Created at descending order Created at descending order
""" """
created_desc created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
""" """
Updated at ascending order Updated at ascending order
""" """
updated_asc updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
""" """
Updated at descending order Updated at descending order
""" """
updated_desc updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
} }
type Submodule implements Entry { type Submodule implements Entry {
......
doc/api/graphql/reference/gitlab_schema.json
View file @ 0c144a6e
...@@ -1227,26 +1227,26 @@ ...@@ -1227,26 +1227,26 @@
{ {
"name": "updated_desc", "name": "updated_desc",
"description": "Updated at descending order", "description": "Updated at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "updated_asc", "name": "updated_asc",
"description": "Updated at ascending order", "description": "Updated at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "created_desc", "name": "created_desc",
"description": "Created at descending order", "description": "Created at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "created_asc", "name": "created_asc",
"description": "Created at ascending order", "description": "Created at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "UPDATED_DESC", "name": "UPDATED_DESC",
...@@ -25468,26 +25468,26 @@ ...@@ -25468,26 +25468,26 @@
{ {
"name": "updated_desc", "name": "updated_desc",
"description": "Updated at descending order", "description": "Updated at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "updated_asc", "name": "updated_asc",
"description": "Updated at ascending order", "description": "Updated at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "created_desc", "name": "created_desc",
"description": "Created at descending order", "description": "Created at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "created_asc", "name": "created_asc",
"description": "Created at ascending order", "description": "Created at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "UPDATED_DESC", "name": "UPDATED_DESC",
...@@ -30807,26 +30807,26 @@ ...@@ -30807,26 +30807,26 @@
{ {
"name": "updated_desc", "name": "updated_desc",
"description": "Updated at descending order", "description": "Updated at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "updated_asc", "name": "updated_asc",
"description": "Updated at ascending order", "description": "Updated at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "created_desc", "name": "created_desc",
"description": "Created at descending order", "description": "Created at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "created_asc", "name": "created_asc",
"description": "Created at ascending order", "description": "Created at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "UPDATED_DESC", "name": "UPDATED_DESC",
...@@ -50993,26 +50993,26 @@ ...@@ -50993,26 +50993,26 @@
{ {
"name": "updated_desc", "name": "updated_desc",
"description": "Updated at descending order", "description": "Updated at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "updated_asc", "name": "updated_asc",
"description": "Updated at ascending order", "description": "Updated at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "created_desc", "name": "created_desc",
"description": "Created at descending order", "description": "Created at descending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
}, },
{ {
"name": "created_asc", "name": "created_asc",
"description": "Created at ascending order", "description": "Created at ascending order",
"isDeprecated": false, "isDeprecated": true,
"deprecationReason": null "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
}, },
{ {
"name": "UPDATED_DESC", "name": "UPDATED_DESC",
doc/api/graphql/reference/index.md
View file @ 0c144a6e
...@@ -3032,10 +3032,10 @@ Values for sorting alerts. ...@@ -3032,10 +3032,10 @@ Values for sorting alerts.
| `UPDATED_DESC` | Updated at descending order | | `UPDATED_DESC` | Updated at descending order |
| `UPDATED_TIME_ASC` | Created time by ascending order | | `UPDATED_TIME_ASC` | Created time by ascending order |
| `UPDATED_TIME_DESC` | Created time by descending order | | `UPDATED_TIME_DESC` | Created time by descending order |
| `created_asc` | Created at ascending order | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
| `created_desc` | Created at descending order | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
| `updated_asc` | Updated at ascending order | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
| `updated_desc` | Updated at descending order | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
### AlertManagementSeverity ### AlertManagementSeverity
...@@ -3272,10 +3272,10 @@ Values for sorting issues. ...@@ -3272,10 +3272,10 @@ Values for sorting issues.
| `UPDATED_DESC` | Updated at descending order | | `UPDATED_DESC` | Updated at descending order |
| `WEIGHT_ASC` | Weight by ascending order | | `WEIGHT_ASC` | Weight by ascending order |
| `WEIGHT_DESC` | Weight by descending order | | `WEIGHT_DESC` | Weight by descending order |
| `created_asc` | Created at ascending order | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
| `created_desc` | Created at descending order | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
| `updated_asc` | Updated at ascending order | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
| `updated_desc` | Updated at descending order | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
### IssueState ### IssueState
...@@ -3355,10 +3355,10 @@ Values for sorting merge requests. ...@@ -3355,10 +3355,10 @@ Values for sorting merge requests.
| `PRIORITY_DESC` | Priority by descending order | | `PRIORITY_DESC` | Priority by descending order |
| `UPDATED_ASC` | Updated at ascending order | | `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order | | `UPDATED_DESC` | Updated at descending order |
| `created_asc` | Created at ascending order | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
| `created_desc` | Created at descending order | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
| `updated_asc` | Updated at ascending order | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
| `updated_desc` | Updated at descending order | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
### MergeRequestState ### MergeRequestState
...@@ -3587,10 +3587,10 @@ Common sort values. ...@@ -3587,10 +3587,10 @@ Common sort values.
| `CREATED_DESC` | Created at descending order | | `CREATED_DESC` | Created at descending order |
| `UPDATED_ASC` | Updated at ascending order | | `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order | | `UPDATED_DESC` | Updated at descending order |
| `created_asc` | Created at ascending order | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
| `created_desc` | Created at descending order | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
| `updated_asc` | Updated at ascending order | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
| `updated_desc` | Updated at descending order | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
### TestReportState ### TestReportState
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7