GraphQL schema update

2026-01-22 18:03:38 -05:00 · 2021-06-21 11:43:59 +10:00
parent e713a3a4b9 f5a322856f
commit 53c596dd43
9 changed files with 545 additions and 4 deletions
--- a/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml
+++ b/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml
@@ -120,3 +120,9 @@ upcoming_changes:
    date: '2021-06-21'
    criticality: breaking
    owner: reybard
+  - location: ReactionGroup.users
+    description: '`users` will be removed. Use the `reactors` field instead.'
+    reason: Reactors can now be mannequins, bots, and organizations.
+    date: '2021-10-01T00:00:00+00:00'
+    criticality: breaking
+    owner: synthead
--- a/data/graphql/ghae/schema.docs-ghae.graphql
+++ b/data/graphql/ghae/schema.docs-ghae.graphql
@@ -26787,6 +26787,31 @@ type ReactionGroup {
  """
  createdAt: DateTime

+  """
+  Reactors to the reaction subject with the emotion represented by this reaction group.
+  """
+  reactors(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+  ): ReactorConnection!
+
  """
  The subject that was reacted to.
  """
@@ -26816,6 +26841,9 @@ type ReactionGroup {
    """
    last: Int
  ): ReactingUserConnection!
+    @deprecated(
+      reason: "Reactors can now be mannequins, bots, and organizations. Use the `reactors` field instead. Removal on 2021-10-01 UTC."
+    )

  """
  Whether or not the authenticated user has left a reaction on the subject.
@@ -26848,6 +26876,56 @@ enum ReactionOrderField {
  CREATED_AT
 }

+"""
+Types that can be assigned to reactions.
+"""
+union Reactor = Bot | Mannequin | Organization | User
+
+"""
+The connection type for Reactor.
+"""
+type ReactorConnection {
+  """
+  A list of edges.
+  """
+  edges: [ReactorEdge]
+
+  """
+  A list of nodes.
+  """
+  nodes: [Reactor]
+
+  """
+  Information to aid in pagination.
+  """
+  pageInfo: PageInfo!
+
+  """
+  Identifies the total count of items in the connection.
+  """
+  totalCount: Int!
+}
+
+"""
+Represents an author of a reaction.
+"""
+type ReactorEdge {
+  """
+  A cursor for use in pagination.
+  """
+  cursor: String!
+
+  """
+  The author of the reaction.
+  """
+  node: Reactor!
+
+  """
+  The moment when the user made the reaction.
+  """
+  reactedAt: DateTime!
+}
+
 """
 Represents a 'ready_for_review' event on a given pull request.
 """
--- a/data/graphql/graphql_upcoming_changes.public.yml
+++ b/data/graphql/graphql_upcoming_changes.public.yml
@@ -128,3 +128,9 @@ upcoming_changes:
    date: '2021-06-21'
    criticality: breaking
    owner: reybard
+  - location: ReactionGroup.users
+    description: '`users` will be removed. Use the `reactors` field instead.'
+    reason: Reactors can now be mannequins, bots, and organizations.
+    date: '2021-10-01T00:00:00+00:00'
+    criticality: breaking
+    owner: synthead
--- a/data/graphql/schema.docs.graphql
+++ b/data/graphql/schema.docs.graphql
@@ -28982,6 +28982,31 @@ type ReactionGroup {
  """
  createdAt: DateTime

+  """
+  Reactors to the reaction subject with the emotion represented by this reaction group.
+  """
+  reactors(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+  ): ReactorConnection!
+
  """
  The subject that was reacted to.
  """
@@ -29011,6 +29036,9 @@ type ReactionGroup {
    """
    last: Int
  ): ReactingUserConnection!
+    @deprecated(
+      reason: "Reactors can now be mannequins, bots, and organizations. Use the `reactors` field instead. Removal on 2021-10-01 UTC."
+    )

  """
  Whether or not the authenticated user has left a reaction on the subject.
@@ -29043,6 +29071,56 @@ enum ReactionOrderField {
  CREATED_AT
 }

+"""
+Types that can be assigned to reactions.
+"""
+union Reactor = Bot | Mannequin | Organization | User
+
+"""
+The connection type for Reactor.
+"""
+type ReactorConnection {
+  """
+  A list of edges.
+  """
+  edges: [ReactorEdge]
+
+  """
+  A list of nodes.
+  """
+  nodes: [Reactor]
+
+  """
+  Information to aid in pagination.
+  """
+  pageInfo: PageInfo!
+
+  """
+  Identifies the total count of items in the connection.
+  """
+  totalCount: Int!
+}
+
+"""
+Represents an author of a reaction.
+"""
+type ReactorEdge {
+  """
+  A cursor for use in pagination.
+  """
+  cursor: String!
+
+  """
+  The author of the reaction.
+  """
+  node: Reactor!
+
+  """
+  The moment when the user made the reaction.
+  """
+  reactedAt: DateTime!
+}
+
 """
 Represents a 'ready_for_review' event on a given pull request.
 """
--- a/lib/graphql/static/changelog.json
+++ b/lib/graphql/static/changelog.json
@@ -1,4 +1,27 @@
 [
+  {
+    "schemaChanges": [
+      {
+        "title": "The GraphQL schema includes these changes:",
+        "changes": [
+          "Type `Reactor` was added",
+          "Type `ReactorConnection` was added",
+          "Type `ReactorEdge` was added",
+          "Field `reactors` was added to object type `ReactionGroup`"
+        ]
+      }
+    ],
+    "previewChanges": [],
+    "upcomingChanges": [
+      {
+        "title": "The following changes will be made to the schema:",
+        "changes": [
+          "On member `ReactionGroup.users`:`users` will be removed. Use the `reactors` field instead. **Effective 2021-10-01**."
+        ]
+      }
+    ],
+    "date": "2021-06-20"
+  },
  {
    "schemaChanges": [
      {
--- a/lib/graphql/static/prerendered-objects.json
+++ b/lib/graphql/static/prerendered-objects.json
--- a/lib/graphql/static/schema-dotcom.json
+++ b/lib/graphql/static/schema-dotcom.json
@@ -41421,6 +41421,56 @@
          "kind": "scalars",
          "href": "/graphql/reference/scalars#datetime"
        },
+        {
+          "name": "reactors",
+          "description": "<p>Reactors to the reaction subject with the emotion represented by this reaction group.</p>",
+          "type": "ReactorConnection!",
+          "id": "reactorconnection",
+          "kind": "objects",
+          "href": "/graphql/reference/objects#reactorconnection",
+          "arguments": [
+            {
+              "name": "after",
+              "description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
+              "type": {
+                "name": "String",
+                "id": "string",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#string"
+              }
+            },
+            {
+              "name": "before",
+              "description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
+              "type": {
+                "name": "String",
+                "id": "string",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#string"
+              }
+            },
+            {
+              "name": "first",
+              "description": "<p>Returns the first <em>n</em> elements from the list.</p>",
+              "type": {
+                "name": "Int",
+                "id": "int",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#int"
+              }
+            },
+            {
+              "name": "last",
+              "description": "<p>Returns the last <em>n</em> elements from the list.</p>",
+              "type": {
+                "name": "Int",
+                "id": "int",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#int"
+              }
+            }
+          ]
+        },
        {
          "name": "subject",
          "description": "<p>The subject that was reacted to.</p>",
@@ -41477,7 +41527,9 @@
                "href": "/graphql/reference/scalars#int"
              }
            }
-          ]
+          ],
+          "isDeprecated": true,
+          "deprecationReason": "<p>Reactors can now be mannequins, bots, and organizations. Use the <code>reactors</code> field instead. Removal on 2021-10-01 UTC.</p>"
        },
        {
          "name": "viewerHasReacted",
@@ -41489,6 +41541,80 @@
        }
      ]
    },
+    {
+      "name": "ReactorConnection",
+      "kind": "objects",
+      "id": "reactorconnection",
+      "href": "/graphql/reference/objects#reactorconnection",
+      "description": "<p>The connection type for Reactor.</p>",
+      "fields": [
+        {
+          "name": "edges",
+          "description": "<p>A list of edges.</p>",
+          "type": "[ReactorEdge]",
+          "id": "reactoredge",
+          "kind": "objects",
+          "href": "/graphql/reference/objects#reactoredge"
+        },
+        {
+          "name": "nodes",
+          "description": "<p>A list of nodes.</p>",
+          "type": "[Reactor]",
+          "id": "reactor",
+          "kind": "unions",
+          "href": "/graphql/reference/unions#reactor"
+        },
+        {
+          "name": "pageInfo",
+          "description": "<p>Information to aid in pagination.</p>",
+          "type": "PageInfo!",
+          "id": "pageinfo",
+          "kind": "objects",
+          "href": "/graphql/reference/objects#pageinfo"
+        },
+        {
+          "name": "totalCount",
+          "description": "<p>Identifies the total count of items in the connection.</p>",
+          "type": "Int!",
+          "id": "int",
+          "kind": "scalars",
+          "href": "/graphql/reference/scalars#int"
+        }
+      ]
+    },
+    {
+      "name": "ReactorEdge",
+      "kind": "objects",
+      "id": "reactoredge",
+      "href": "/graphql/reference/objects#reactoredge",
+      "description": "<p>Represents an author of a reaction.</p>",
+      "fields": [
+        {
+          "name": "cursor",
+          "description": "<p>A cursor for use in pagination.</p>",
+          "type": "String!",
+          "id": "string",
+          "kind": "scalars",
+          "href": "/graphql/reference/scalars#string"
+        },
+        {
+          "name": "node",
+          "description": "<p>The author of the reaction.</p>",
+          "type": "Reactor!",
+          "id": "reactor",
+          "kind": "unions",
+          "href": "/graphql/reference/unions#reactor"
+        },
+        {
+          "name": "reactedAt",
+          "description": "<p>The moment when the user made the reaction.</p>",
+          "type": "DateTime!",
+          "id": "datetime",
+          "kind": "scalars",
+          "href": "/graphql/reference/scalars#datetime"
+        }
+      ]
+    },
    {
      "name": "ReadyForReviewEvent",
      "kind": "objects",
@@ -68023,6 +68149,35 @@
        }
      ]
    },
+    {
+      "name": "Reactor",
+      "kind": "unions",
+      "id": "reactor",
+      "href": "/graphql/reference/unions#reactor",
+      "description": "<p>Types that can be assigned to reactions.</p>",
+      "possibleTypes": [
+        {
+          "name": "Bot",
+          "id": "bot",
+          "href": "/graphql/reference/objects#bot"
+        },
+        {
+          "name": "Mannequin",
+          "id": "mannequin",
+          "href": "/graphql/reference/objects#mannequin"
+        },
+        {
+          "name": "Organization",
+          "id": "organization",
+          "href": "/graphql/reference/objects#organization"
+        },
+        {
+          "name": "User",
+          "id": "user",
+          "href": "/graphql/reference/objects#user"
+        }
+      ]
+    },
    {
      "name": "ReferencedSubject",
      "kind": "unions",
--- a/lib/graphql/static/schema-ghae.json
+++ b/lib/graphql/static/schema-ghae.json
@@ -38139,6 +38139,56 @@
          "kind": "scalars",
          "href": "/graphql/reference/scalars#datetime"
        },
+        {
+          "name": "reactors",
+          "description": "<p>Reactors to the reaction subject with the emotion represented by this reaction group.</p>",
+          "type": "ReactorConnection!",
+          "id": "reactorconnection",
+          "kind": "objects",
+          "href": "/graphql/reference/objects#reactorconnection",
+          "arguments": [
+            {
+              "name": "after",
+              "description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
+              "type": {
+                "name": "String",
+                "id": "string",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#string"
+              }
+            },
+            {
+              "name": "before",
+              "description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
+              "type": {
+                "name": "String",
+                "id": "string",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#string"
+              }
+            },
+            {
+              "name": "first",
+              "description": "<p>Returns the first <em>n</em> elements from the list.</p>",
+              "type": {
+                "name": "Int",
+                "id": "int",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#int"
+              }
+            },
+            {
+              "name": "last",
+              "description": "<p>Returns the last <em>n</em> elements from the list.</p>",
+              "type": {
+                "name": "Int",
+                "id": "int",
+                "kind": "scalars",
+                "href": "/graphql/reference/scalars#int"
+              }
+            }
+          ]
+        },
        {
          "name": "subject",
          "description": "<p>The subject that was reacted to.</p>",
@@ -38195,7 +38245,9 @@
                "href": "/graphql/reference/scalars#int"
              }
            }
-          ]
+          ],
+          "isDeprecated": true,
+          "deprecationReason": "<p>Reactors can now be mannequins, bots, and organizations. Use the <code>reactors</code> field instead. Removal on 2021-10-01 UTC.</p>"
        },
        {
          "name": "viewerHasReacted",
@@ -38207,6 +38259,80 @@
        }
      ]
    },
+    {
+      "name": "ReactorConnection",
+      "kind": "objects",
+      "id": "reactorconnection",
+      "href": "/graphql/reference/objects#reactorconnection",
+      "description": "<p>The connection type for Reactor.</p>",
+      "fields": [
+        {
+          "name": "edges",
+          "description": "<p>A list of edges.</p>",
+          "type": "[ReactorEdge]",
+          "id": "reactoredge",
+          "kind": "objects",
+          "href": "/graphql/reference/objects#reactoredge"
+        },
+        {
+          "name": "nodes",
+          "description": "<p>A list of nodes.</p>",
+          "type": "[Reactor]",
+          "id": "reactor",
+          "kind": "unions",
+          "href": "/graphql/reference/unions#reactor"
+        },
+        {
+          "name": "pageInfo",
+          "description": "<p>Information to aid in pagination.</p>",
+          "type": "PageInfo!",
+          "id": "pageinfo",
+          "kind": "objects",
+          "href": "/graphql/reference/objects#pageinfo"
+        },
+        {
+          "name": "totalCount",
+          "description": "<p>Identifies the total count of items in the connection.</p>",
+          "type": "Int!",
+          "id": "int",
+          "kind": "scalars",
+          "href": "/graphql/reference/scalars#int"
+        }
+      ]
+    },
+    {
+      "name": "ReactorEdge",
+      "kind": "objects",
+      "id": "reactoredge",
+      "href": "/graphql/reference/objects#reactoredge",
+      "description": "<p>Represents an author of a reaction.</p>",
+      "fields": [
+        {
+          "name": "cursor",
+          "description": "<p>A cursor for use in pagination.</p>",
+          "type": "String!",
+          "id": "string",
+          "kind": "scalars",
+          "href": "/graphql/reference/scalars#string"
+        },
+        {
+          "name": "node",
+          "description": "<p>The author of the reaction.</p>",
+          "type": "Reactor!",
+          "id": "reactor",
+          "kind": "unions",
+          "href": "/graphql/reference/unions#reactor"
+        },
+        {
+          "name": "reactedAt",
+          "description": "<p>The moment when the user made the reaction.</p>",
+          "type": "DateTime!",
+          "id": "datetime",
+          "kind": "scalars",
+          "href": "/graphql/reference/scalars#datetime"
+        }
+      ]
+    },
    {
      "name": "ReadyForReviewEvent",
      "kind": "objects",
@@ -63054,6 +63180,35 @@
        }
      ]
    },
+    {
+      "name": "Reactor",
+      "kind": "unions",
+      "id": "reactor",
+      "href": "/graphql/reference/unions#reactor",
+      "description": "<p>Types that can be assigned to reactions.</p>",
+      "possibleTypes": [
+        {
+          "name": "Bot",
+          "id": "bot",
+          "href": "/graphql/reference/objects#bot"
+        },
+        {
+          "name": "Mannequin",
+          "id": "mannequin",
+          "href": "/graphql/reference/objects#mannequin"
+        },
+        {
+          "name": "Organization",
+          "id": "organization",
+          "href": "/graphql/reference/objects#organization"
+        },
+        {
+          "name": "User",
+          "id": "user",
+          "href": "/graphql/reference/objects#user"
+        }
+      ]
+    },
    {
      "name": "ReferencedSubject",
      "kind": "unions",
--- a/lib/graphql/static/upcoming-changes.json
+++ b/lib/graphql/static/upcoming-changes.json
@@ -1,5 +1,15 @@
 {
  "dotcom": {
+    "2021-10-01": [
+      {
+        "location": "ReactionGroup.users",
+        "description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
+        "reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
+        "date": "2021-10-01",
+        "criticality": "breaking",
+        "owner": "synthead"
+      }
+    ],
    "2021-06-21": [
      {
        "location": "PackageType.DOCKER",
@@ -1262,6 +1272,16 @@
    ]
  },
  "ghae": {
+    "2021-10-01": [
+      {
+        "location": "ReactionGroup.users",
+        "description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
+        "reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
+        "date": "2021-10-01",
+        "criticality": "breaking",
+        "owner": "synthead"
+      }
+    ],
    "2021-06-21": [
      {
        "location": "PackageType.DOCKER",