UNPKG

spectaql

Version:

A powerful library for autogenerating static GraphQL API documentation

1,173 lines (1,172 loc) 95.1 kB
{ "__schema": { "queryType": { "name": "Query" }, "mutationType": { "name": "Mutation" }, "subscriptionType": { "name": "Subscription" }, "types": [ { "kind": "SCALAR", "name": "DateTime", "description": "This is a `DateTime` scalar", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null, "documentation": { "example": "2016-10-07T01:08:03.420Z" } }, { "kind": "SCALAR", "name": "PhoneNumber", "description": "This is a Phone", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "URL", "description": null, "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "JSON", "description": null, "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "JSONObject", "description": null, "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Void", "description": null, "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Byte", "description": null, "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "Node", "description": "Anything with an ID can be a node", "fields": [ { "name": "id", "description": "A unique identifier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SimpleTypeOne", "ofType": null } ] }, { "kind": "SCALAR", "name": "String", "description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SimpleTypeOne", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "fields": [ { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "myType", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MyType", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SimpleTypeTwo", "description": null, "fields": [ { "name": "simpleTypeTwoField", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SimpleTypes", "description": "A Union of `SimpleTypeOne` and `SimpleTypeTwo`. `Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SimpleTypeOne", "ofType": null }, { "kind": "OBJECT", "name": "SimpleTypeTwo", "ofType": null } ] }, { "kind": "OBJECT", "name": "MyType", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) and [`myQuery`]({{Queries.myQuery}}) and [`myMutation`]({{Mutations.myMutation}}) are supported", "fields": [ { "name": "url", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "json", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "JSON", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "jso", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "JSONObject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vd", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Void", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "byte", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Byte", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "nonRequiredField", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "args": [ { "name": "nonRequiredArg", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "\"some default string\"" }, { "name": "reqArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "reqArrayArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "dblReqArrayArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null, "documentation": { "example": "Metadata example of `nonRequiredField`" } }, { "name": "requiredField", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "`requiredField` is going away" }, { "name": "episode", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "EpisodeEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiredArrayField", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "doubleRequiredArrayField", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SecretType", "description": "This is a type that should probably be undocumented. Metadata will indicate this should be hidden", "fields": [ { "name": "secret", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null, "documentation": { "undocumented": true } }, { "kind": "ENUM", "name": "EpisodeEnum", "description": "These are very important `enum`s. `Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NEWHOPE", "description": "Who is Luke? `Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "isDeprecated": true, "deprecationReason": "`NEWHOPE` is going away" }, { "name": "EMPIRE", "description": "Who is Darth?", "isDeprecated": false, "deprecationReason": null }, { "name": "JEDI", "description": "Who are the Ewoks?", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Query", "description": "Something interesting about my `Queries`.", "fields": [ { "name": "secrets", "description": "This will be removed due to SecretType being removed", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SecretType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "myQuery", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "args": [ { "name": "nonReqQueryArg", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "\"some default string\"", "documentation": { "example": "Metadata example of `nonReqQueryArg`" } }, { "name": "reqQueryArg", "description": null, "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reqQueryArrayArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "dblReqQueryArrayArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "`myQuery` is going away" }, { "name": "stringThing", "description": "This Query has the same name as a Mutation", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "getInts", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "simpleTypes", "description": "I return a list of the SimpleType Union", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "UNION", "name": "SimpleTypes", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "optionalsQuery", "description": "I'm the optionals query", "args": [ { "name": "optionalArg", "description": null, "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiredsQuery", "description": null, "args": [ { "name": "dblReqArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "myTypes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MyType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enumsQuery", "description": null, "args": [ { "name": "enums", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "EpisodeEnum", "ofType": null } } } }, "defaultValue": "[EMPIRE, JEDI]" }, { "name": "enum", "description": "enum defaults should get literalized", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "EpisodeEnum", "ofType": null } }, "defaultValue": "EMPIRE" }, { "name": "ints", "description": "everything else should get JSON5.parsed", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": "[1, 2, 3]" } ], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodeQuery", "description": null, "args": [ { "name": "id", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "INTERFACE", "name": "Node", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "filterInputQuery", "description": "Without this Query, the `FilterInput` would not be shown", "args": [ { "name": "filter", "description": "Without this Query, the `FilterInput` would not be shown", "type": { "kind": "INPUT_OBJECT", "name": "FilterInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MyType", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "contactInfoInputQuery", "description": "Without this Query, the `ContactInfoInput` would not be shown", "args": [ { "name": "input", "description": "Without this arg, the `ContactInfoInput` would not be shown", "type": { "kind": "INPUT_OBJECT", "name": "ContactInfoInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MyType", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Int", "description": "The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Mutation", "description": null, "fields": [ { "name": "stringThing", "description": "This Mutation has the same name as a Query", "args": [ { "name": "anArgument", "description": null, "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "myMutation", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "args": [ { "name": "nonReqMutationArg", "description": "`Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "\"some default string\"" }, { "name": "reqMutationArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "reqMutationArrayArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "dblReqMutationArrayArg", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Subscription", "description": null, "fields": [ { "name": "myTypeUpdatedSubscription", "description": "The `myTypeUpdatedSubscription`, baby!", "args": [ { "name": "input", "description": null, "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MyType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "secretTypeSubscription", "description": "A subscription that will probably be removed when `SecretType` is removed", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SecretType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "ID", "description": "The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FilterInput", "description": "An Input Type for filtering things. `Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "fields": null, "inputFields": [ { "name": "someField", "description": "Comment for someField. `Markdown` and reference interpolation like [`[String!]!`]({{Types.String}}) are supported", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false", "documentation": { "example": true } }, { "name": "anotherField", "description": "Comment for anotherField", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null, "documentation": { "example": "Metadata example of `anotherField`" } }, { "name": "episodeEnums", "description": "Comment for episodeEnums", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "EpisodeEnum", "ofType": null } } }, "defaultValue": null, "documentation": { "example": [ "EMPIRE" ] } } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Boolean", "description": "The `Boolean` scalar type represents `true` or `false`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ContactInfoInput", "description": "ContactInfoInput description", "fields": null, "inputFields": [ { "name": "email", "description": null, "type": { "kind": "SCALAR", "name": "String", "ofType": null