Merge branch 'sarnold-deprecate-lowercase-enums' into 'master'

Deprecate lowercase enums in BaseEnum

See merge request gitlab-org/gitlab!43650

app/graphql/types/sort_enum.rb

@@ -7,10 +7,10 @@ module Types
 
     # Deprecated, as we prefer uppercase enums
     # https://gitlab.com/groups/gitlab-org/-/epics/1838
-    value 'updated_desc', 'Updated at descending order'
-    value 'updated_asc', 'Updated at ascending order'
-    value 'created_desc', 'Created at descending order'
-    value 'created_asc', 'Created at ascending order'
+    value 'updated_desc', 'Updated at descending order', deprecated: { reason: 'Use UPDATED_DESC', milestone: '13.5' }
+    value 'updated_asc', 'Updated at ascending order', deprecated: { reason: 'Use UPDATED_ASC', milestone: '13.5' }
+    value 'created_desc', 'Created at descending order', deprecated: { reason: 'Use CREATED_DESC', milestone: '13.5' }
+    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_ASC', 'Updated at ascending order', value: :updated_asc

changelogs/unreleased/sarnold-deprecate-lowercase-enums.yml

+---
+title: Deprecate lowercase values for sort enums in GraphQL
+merge_request: 43650
+author:
+type: changed

doc/api/graphql/reference/gitlab_schema.graphql

@@ -527,22 +527,22 @@ enum AlertManagementAlertSort {
   """
   Created at ascending order
   """
-  created_asc
+  created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
 
   """
   Created at descending order
   """
-  created_desc
+  created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
 
   """
   Updated at ascending order
   """
-  updated_asc
+  updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
 
   """
   Updated at descending order
   """
-  updated_desc
+  updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
 }
 
 """
@@ -9342,22 +9342,22 @@ enum IssueSort {
   """
   Created at ascending order
   """
-  created_asc
+  created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
 
   """
   Created at descending order
   """
-  created_desc
+  created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
 
   """
   Updated at ascending order
   """
-  updated_asc
+  updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
 
   """
   Updated at descending order
   """
-  updated_desc
+  updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
 }
 
 """
@@ -11203,22 +11203,22 @@ enum MergeRequestSort {
   """
   Created at ascending order
   """
-  created_asc
+  created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
 
   """
   Created at descending order
   """
-  created_desc
+  created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
 
   """
   Updated at ascending order
   """
-  updated_asc
+  updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
 
   """
   Updated at descending order
   """
-  updated_desc
+  updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
 }
 
 """
@@ -17522,22 +17522,22 @@ enum Sort {
   """
   Created at ascending order
   """
-  created_asc
+  created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5")
 
   """
   Created at descending order
   """
-  created_desc
+  created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5")
 
   """
   Updated at ascending order
   """
-  updated_asc
+  updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5")
 
   """
   Updated at descending order
   """
-  updated_desc
+  updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5")
 }
 
 type Submodule implements Entry {

doc/api/graphql/reference/gitlab_schema.json

@@ -1227,26 +1227,26 @@
             {
               "name": "updated_desc",
               "description": "Updated at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "updated_asc",
               "description": "Updated at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "created_desc",
               "description": "Created at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "created_asc",
               "description": "Created at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "UPDATED_DESC",
@@ -25468,26 +25468,26 @@
             {
               "name": "updated_desc",
               "description": "Updated at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "updated_asc",
               "description": "Updated at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "created_desc",
               "description": "Created at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "created_asc",
               "description": "Created at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "UPDATED_DESC",
@@ -30807,26 +30807,26 @@
             {
               "name": "updated_desc",
               "description": "Updated at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "updated_asc",
               "description": "Updated at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "created_desc",
               "description": "Created at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "created_asc",
               "description": "Created at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "UPDATED_DESC",
@@ -50993,26 +50993,26 @@
             {
               "name": "updated_desc",
               "description": "Updated at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "updated_asc",
               "description": "Updated at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "created_desc",
               "description": "Created at descending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5"
             },
             {
               "name": "created_asc",
               "description": "Created at ascending order",
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5"
             },
             {
               "name": "UPDATED_DESC",

doc/api/graphql/reference/index.md

@@ -3032,10 +3032,10 @@ Values for sorting alerts.
 | `UPDATED_DESC` | Updated at descending order |
 | `UPDATED_TIME_ASC` | Created time by ascending order |
 | `UPDATED_TIME_DESC` | Created time by descending order |
-| `created_asc` | Created at ascending order |
-| `created_desc` | Created at descending order |
-| `updated_asc` | Updated at ascending order |
-| `updated_desc` | Updated at descending order |
+| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
+| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
+| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
+| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
 
 ### AlertManagementSeverity
 
@@ -3272,10 +3272,10 @@ Values for sorting issues.
 | `UPDATED_DESC` | Updated at descending order |
 | `WEIGHT_ASC` | Weight by ascending order |
 | `WEIGHT_DESC` | Weight by descending order |
-| `created_asc` | Created at ascending order |
-| `created_desc` | Created at descending order |
-| `updated_asc` | Updated at ascending order |
-| `updated_desc` | Updated at descending order |
+| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
+| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
+| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
+| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
 
 ### IssueState
 
@@ -3355,10 +3355,10 @@ Values for sorting merge requests.
 | `PRIORITY_DESC` | Priority by descending order |
 | `UPDATED_ASC` | Updated at ascending order |
 | `UPDATED_DESC` | Updated at descending order |
-| `created_asc` | Created at ascending order |
-| `created_desc` | Created at descending order |
-| `updated_asc` | Updated at ascending order |
-| `updated_desc` | Updated at descending order |
+| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
+| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
+| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
+| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
 
 ### MergeRequestState
 
@@ -3587,10 +3587,10 @@ Common sort values.
 | `CREATED_DESC` | Created at descending order |
 | `UPDATED_ASC` | Updated at ascending order |
 | `UPDATED_DESC` | Updated at descending order |
-| `created_asc` | Created at ascending order |
-| `created_desc` | Created at descending order |
-| `updated_asc` | Updated at ascending order |
-| `updated_desc` | Updated at descending order |
+| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5 |
+| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5 |
+| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5 |
+| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5 |
 
 ### TestReportState