feat: deprecation of suggested topics (#875)

octokit · Dec 21, 2023 · 62c4e61 · 62c4e61
1 parent 6c550c8
commit 62c4e61
Show file tree

Hide file tree

Showing 3 changed files with 111 additions and 75 deletions.
diff --git a/schema.d.ts b/schema.d.ts
@@ -96,18 +96,33 @@ export type AcceptEnterpriseAdministratorInvitationPayload = {
 export type AcceptTopicSuggestionInput = {
   /** A unique identifier for the client performing the mutation. */
   clientMutationId?: InputMaybe<Scalars['String']['input']>;
-  /** The name of the suggested topic. */
-  name: Scalars['String']['input'];
-  /** The Node ID of the repository. */
-  repositoryId: Scalars['ID']['input'];
+  /**
+   * The name of the suggested topic.
+   *
+   * **Upcoming Change on 2024-04-01 UTC**
+   * **Description:** `name` will be removed.
+   * **Reason:** Suggested topics are no longer supported
+   */
+  name?: InputMaybe<Scalars['String']['input']>;
+  /**
+   * The Node ID of the repository.
+   *
+   * **Upcoming Change on 2024-04-01 UTC**
+   * **Description:** `repositoryId` will be removed.
+   * **Reason:** Suggested topics are no longer supported
+   */
+  repositoryId?: InputMaybe<Scalars['ID']['input']>;
 };
 
 /** Autogenerated return type of AcceptTopicSuggestion */
 export type AcceptTopicSuggestionPayload = {
   __typename?: 'AcceptTopicSuggestionPayload';
   /** A unique identifier for the client performing the mutation. */
   clientMutationId?: Maybe<Scalars['String']['output']>;
-  /** The accepted topic. */
+  /**
+   * The accepted topic.
+   * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC.
+   */
   topic?: Maybe<Topic>;
 };
 
@@ -4499,20 +4514,41 @@ export type CrossReferencedEvent = Node & UniformResourceLocatable & {
 export type DeclineTopicSuggestionInput = {
   /** A unique identifier for the client performing the mutation. */
   clientMutationId?: InputMaybe<Scalars['String']['input']>;
-  /** The name of the suggested topic. */
-  name: Scalars['String']['input'];
-  /** The reason why the suggested topic is declined. */
-  reason: TopicSuggestionDeclineReason;
-  /** The Node ID of the repository. */
-  repositoryId: Scalars['ID']['input'];
+  /**
+   * The name of the suggested topic.
+   *
+   * **Upcoming Change on 2024-04-01 UTC**
+   * **Description:** `name` will be removed.
+   * **Reason:** Suggested topics are no longer supported
+   */
+  name?: InputMaybe<Scalars['String']['input']>;
+  /**
+   * The reason why the suggested topic is declined.
+   *
+   * **Upcoming Change on 2024-04-01 UTC**
+   * **Description:** `reason` will be removed.
+   * **Reason:** Suggested topics are no longer supported
+   */
+  reason?: InputMaybe<TopicSuggestionDeclineReason>;
+  /**
+   * The Node ID of the repository.
+   *
+   * **Upcoming Change on 2024-04-01 UTC**
+   * **Description:** `repositoryId` will be removed.
+   * **Reason:** Suggested topics are no longer supported
+   */
+  repositoryId?: InputMaybe<Scalars['ID']['input']>;
 };
 
 /** Autogenerated return type of DeclineTopicSuggestion */
 export type DeclineTopicSuggestionPayload = {
   __typename?: 'DeclineTopicSuggestionPayload';
   /** A unique identifier for the client performing the mutation. */
   clientMutationId?: Maybe<Scalars['String']['output']>;
-  /** The declined topic. */
+  /**
+   * The declined topic.
+   * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC.
+   */
   topic?: Maybe<Topic>;
 };
 

diff --git a/schema.graphql b/schema.graphql
@@ -108,13 +108,21 @@ input AcceptTopicSuggestionInput {
 
   """
   The name of the suggested topic.
+
+  **Upcoming Change on 2024-04-01 UTC**
+  **Description:** `name` will be removed.
+  **Reason:** Suggested topics are no longer supported
   """
-  name: String!
+  name: String
 
   """
   The Node ID of the repository.
+
+  **Upcoming Change on 2024-04-01 UTC**
+  **Description:** `repositoryId` will be removed.
+  **Reason:** Suggested topics are no longer supported
   """
-  repositoryId: ID!
+  repositoryId: ID
 }
 
 """
@@ -129,7 +137,7 @@ type AcceptTopicSuggestionPayload {
   """
   The accepted topic.
   """
-  topic: Topic
+  topic: Topic @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
 }
 
 """
@@ -8631,18 +8639,30 @@ input DeclineTopicSuggestionInput {
 
   """
   The name of the suggested topic.
+
+  **Upcoming Change on 2024-04-01 UTC**
+  **Description:** `name` will be removed.
+  **Reason:** Suggested topics are no longer supported
   """
-  name: String!
+  name: String
 
   """
   The reason why the suggested topic is declined.
+
+  **Upcoming Change on 2024-04-01 UTC**
+  **Description:** `reason` will be removed.
+  **Reason:** Suggested topics are no longer supported
   """
-  reason: TopicSuggestionDeclineReason!
+  reason: TopicSuggestionDeclineReason
 
   """
   The Node ID of the repository.
+
+  **Upcoming Change on 2024-04-01 UTC**
+  **Description:** `repositoryId` will be removed.
+  **Reason:** Suggested topics are no longer supported
   """
-  repositoryId: ID!
+  repositoryId: ID
 }
 
 """
@@ -8657,7 +8677,7 @@ type DeclineTopicSuggestionPayload {
   """
   The declined topic.
   """
-  topic: Topic
+  topic: Topic @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
 }
 
 """
@@ -53742,22 +53762,22 @@ enum TopicSuggestionDeclineReason {
   """
   The suggested topic is not relevant to the repository.
   """
-  NOT_RELEVANT
+  NOT_RELEVANT @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
 
   """
   The viewer does not like the suggested topic.
   """
-  PERSONAL_PREFERENCE
+  PERSONAL_PREFERENCE @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
 
   """
   The suggested topic is too general for the repository.
   """
-  TOO_GENERAL
+  TOO_GENERAL @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
 
   """
   The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1).
   """
-  TOO_SPECIFIC
+  TOO_SPECIFIC @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
 }
 
 """

diff --git a/schema.json b/schema.json
@@ -238,29 +238,21 @@
         "inputFields": [
           {
             "name": "repositoryId",
-            "description": "The Node ID of the repository.",
+            "description": "The Node ID of the repository.\n\n**Upcoming Change on 2024-04-01 UTC**\n**Description:** `repositoryId` will be removed.\n**Reason:** Suggested topics are no longer supported\n",
             "type": {
-              "kind": "NON_NULL",
-              "name": null,
-              "ofType": {
-                "kind": "SCALAR",
-                "name": "ID",
-                "ofType": null
-              }
+              "kind": "SCALAR",
+              "name": "ID",
+              "ofType": null
             },
             "defaultValue": null
           },
           {
             "name": "name",
-            "description": "The name of the suggested topic.",
+            "description": "The name of the suggested topic.\n\n**Upcoming Change on 2024-04-01 UTC**\n**Description:** `name` will be removed.\n**Reason:** Suggested topics are no longer supported\n",
             "type": {
-              "kind": "NON_NULL",
-              "name": null,
-              "ofType": {
-                "kind": "SCALAR",
-                "name": "String",
-                "ofType": null
-              }
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
             },
             "defaultValue": null
           },
@@ -305,8 +297,8 @@
               "name": "Topic",
               "ofType": null
             },
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Suggested topics are no longer supported Removal on 2024-04-01 UTC."
           }
         ],
         "inputFields": null,
@@ -22116,43 +22108,31 @@
         "inputFields": [
           {
             "name": "repositoryId",
-            "description": "The Node ID of the repository.",
+            "description": "The Node ID of the repository.\n\n**Upcoming Change on 2024-04-01 UTC**\n**Description:** `repositoryId` will be removed.\n**Reason:** Suggested topics are no longer supported\n",
             "type": {
-              "kind": "NON_NULL",
-              "name": null,
-              "ofType": {
-                "kind": "SCALAR",
-                "name": "ID",
-                "ofType": null
-              }
+              "kind": "SCALAR",
+              "name": "ID",
+              "ofType": null
             },
             "defaultValue": null
           },
           {
             "name": "name",
-            "description": "The name of the suggested topic.",
+            "description": "The name of the suggested topic.\n\n**Upcoming Change on 2024-04-01 UTC**\n**Description:** `name` will be removed.\n**Reason:** Suggested topics are no longer supported\n",
             "type": {
-              "kind": "NON_NULL",
-              "name": null,
-              "ofType": {
-                "kind": "SCALAR",
-                "name": "String",
-                "ofType": null
-              }
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
             },
             "defaultValue": null
           },
           {
             "name": "reason",
-            "description": "The reason why the suggested topic is declined.",
+            "description": "The reason why the suggested topic is declined.\n\n**Upcoming Change on 2024-04-01 UTC**\n**Description:** `reason` will be removed.\n**Reason:** Suggested topics are no longer supported\n",
             "type": {
-              "kind": "NON_NULL",
-              "name": null,
-              "ofType": {
-                "kind": "ENUM",
-                "name": "TopicSuggestionDeclineReason",
-                "ofType": null
-              }
+              "kind": "ENUM",
+              "name": "TopicSuggestionDeclineReason",
+              "ofType": null
             },
             "defaultValue": null
           },
@@ -22197,8 +22177,8 @@
               "name": "Topic",
               "ofType": null
             },
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Suggested topics are no longer supported Removal on 2024-04-01 UTC."
           }
         ],
         "inputFields": null,
@@ -138070,26 +138050,26 @@
           {
             "name": "NOT_RELEVANT",
             "description": "The suggested topic is not relevant to the repository.",
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Suggested topics are no longer supported Removal on 2024-04-01 UTC."
           },
           {
             "name": "TOO_SPECIFIC",
             "description": "The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1).",
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Suggested topics are no longer supported Removal on 2024-04-01 UTC."
           },
           {
             "name": "PERSONAL_PREFERENCE",
             "description": "The viewer does not like the suggested topic.",
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Suggested topics are no longer supported Removal on 2024-04-01 UTC."
           },
           {
             "name": "TOO_GENERAL",
             "description": "The suggested topic is too general for the repository.",
-            "isDeprecated": false,
-            "deprecationReason": null
+            "isDeprecated": true,
+            "deprecationReason": "Suggested topics are no longer supported Removal on 2024-04-01 UTC."
           }
         ],
         "possibleTypes": null