Skip to content

condense the spec defs appendix #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 1, 2025
Merged

condense the spec defs appendix #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b25ae94
condense the spec defs appendix
leebyron Sep 1, 2025
a2f1918
fix js-ahead-of-spec
leebyron Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 43 additions & 15 deletions scripts/update-appendix-specified-definitions.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,56 @@
import { writeFile } from 'node:fs/promises';
import { printIntrospectionSchema, buildSchema, specifiedScalarTypes, printType } from 'graphql';
import prettier from "prettier";
import { writeFile } from "node:fs/promises";
import {
printIntrospectionSchema,
buildSchema,
specifiedScalarTypes,
printType,
parse,
print,
visit,
Kind
} from "graphql";

function stripDescriptions(sdl) {
const ast = parse(sdl);
const noDescAst = visit(ast, {
enter: (node) => {
// Not in spec yet
if (node.name?.value === "FRAGMENT_VARIABLE_DEFINITION") {
return null
}
},
leave: (node) => ({ ...node, description: undefined })
});
return print(noDescAst);
}

const FILE = './spec/Appendix D -- Specified Definitions.md';
function printSpecifiedScalars() {
return specifiedScalarTypes
.map((type) => printType(type))
.join('\n\n');
.map((type) => stripDescriptions(printType(type)))
.join("\n\n");
}

const introspectionSchema = printIntrospectionSchema(buildSchema(`type Query { i: Int }`));
const prefix = `
# C. Appendix: Type System Definitions
const introspectionSchema = stripDescriptions(
printIntrospectionSchema(buildSchema(`type Query { i: Int }`))
);

const allSpecifiedTypesSDL = prettier
.format(printSpecifiedScalars() + "\n\n" + introspectionSchema, {
parser: "graphql"
})
.trimEnd();

This appendix lists the specified type system definitions.
await writeFile(
"./spec/Appendix D -- Specified Definitions.md",
`# D. Appendix: Type System Definitions

The descriptions are non-normative. Implementations are recommended to use them
for consistency but different descriptions are allowed.
This appendix lists all type system definitions specified in this document.

The order of types, fields, arguments, values and directives is non-normative.

\`\`\`graphql
`

const suffix = `
${allSpecifiedTypesSDL}
\`\`\`
`
await writeFile(FILE, prefix + printSpecifiedScalars() + '\n\n' + introspectionSchema + suffix);
);
217 changes: 7 additions & 210 deletions spec/Appendix D -- Specified Definitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,115 +1,41 @@
# D. Appendix: Type System Definitions

This appendix lists the specified type system definitions.

The descriptions are non-normative. Implementations are recommended to use them
for consistency but different descriptions are allowed.
This appendix lists all type system definitions specified in this document.

The order of types, fields, arguments, values and directives is non-normative.

```graphql
"""
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.
"""
scalar String

"""
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
"""
scalar Int

"""
The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
"""
scalar Float

"""
The `Boolean` scalar type represents `true` or `false`.
"""
scalar Boolean

"""
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.
"""
scalar ID

"""
Directs the executor to include this field or fragment only when the `if` argument is true.
"""
directive @include(
"""
Included when true.
"""
if: Boolean!
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT

"""
Directs the executor to skip this field or fragment when the `if` argument is true.
"""
directive @skip(
"""
Skipped when true.
"""
if: Boolean!
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT

"""
Marks an element of a GraphQL schema as no longer supported.
"""
directive @deprecated(
"""
Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).
"""
reason: String! = "No longer supported"
) on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE

"""
Exposes a URL that specifies the behavior of this scalar.
"""
directive @specifiedBy(
"""
The URL that specifies the behavior of this scalar.
"""
url: String!
) on SCALAR
directive @specifiedBy(url: String!) on SCALAR

directive @oneOf on INPUT_OBJECT
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This snuck in ahead of that merge!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tee'ing it up


"""
A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
"""
type __Schema {
description: String

"""
A list of all types supported by this server.
"""
types: [__Type!]!

"""
The type that query operations will be rooted at.
"""
queryType: __Type!

"""
If this server supports mutation, the type that mutation operations will be rooted at.
"""
mutationType: __Type

"""
If this server support subscription, the type that subscription operations will be rooted at.
"""
subscriptionType: __Type

"""
A list of all directives supported by this server.
"""
directives: [__Directive!]!
}

"""
The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.

Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name, description and optional `specifiedByURL`, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.
"""
type __Type {
kind: __TypeKind!
name: String
Expand All @@ -121,56 +47,20 @@ type __Type {
enumValues(includeDeprecated: Boolean = false): [__EnumValue!]
inputFields(includeDeprecated: Boolean = false): [__InputValue!]
ofType: __Type
isOneOf: Boolean
}

"""
An enum describing what kind of type a given `__Type` is.
"""
enum __TypeKind {
"""
Indicates this type is a scalar.
"""
SCALAR

"""
Indicates this type is an object. `fields` and `interfaces` are valid fields.
"""
OBJECT

"""
Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields.
"""
INTERFACE

"""
Indicates this type is a union. `possibleTypes` is a valid field.
"""
UNION

"""
Indicates this type is an enum. `enumValues` is a valid field.
"""
ENUM

"""
Indicates this type is an input object. `inputFields` is a valid field.
"""
INPUT_OBJECT

"""
Indicates this type is a list. `ofType` is a valid field.
"""
LIST

"""
Indicates this type is a non-null. `ofType` is a valid field.
"""
NON_NULL
}

"""
Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
"""
type __Field {
name: String!
description: String
Expand All @@ -180,37 +70,22 @@ type __Field {
deprecationReason: String
}

"""
Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
"""
type __InputValue {
name: String!
description: String
type: __Type!

"""
A GraphQL-formatted string representing the default value for this input value.
"""
defaultValue: String
isDeprecated: Boolean!
deprecationReason: String
}

"""
One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
"""
type __EnumValue {
name: String!
description: String
isDeprecated: Boolean!
deprecationReason: String
}

"""
A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
"""
type __Directive {
name: String!
description: String
Expand All @@ -219,103 +94,25 @@ type __Directive {
args(includeDeprecated: Boolean = false): [__InputValue!]!
}

"""
A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.
"""
enum __DirectiveLocation {
"""
Location adjacent to a query operation.
"""
QUERY

"""
Location adjacent to a mutation operation.
"""
MUTATION

"""
Location adjacent to a subscription operation.
"""
SUBSCRIPTION

"""
Location adjacent to a field.
"""
FIELD

"""
Location adjacent to a fragment definition.
"""
FRAGMENT_DEFINITION

"""
Location adjacent to a fragment spread.
"""
FRAGMENT_SPREAD

"""
Location adjacent to an inline fragment.
"""
INLINE_FRAGMENT

"""
Location adjacent to an operation variable definition.
"""
VARIABLE_DEFINITION

"""
Location adjacent to a schema definition.
"""
SCHEMA

"""
Location adjacent to a scalar definition.
"""
SCALAR

"""
Location adjacent to an object type definition.
"""
OBJECT

"""
Location adjacent to a field definition.
"""
FIELD_DEFINITION

"""
Location adjacent to an argument definition.
"""
ARGUMENT_DEFINITION

"""
Location adjacent to an interface definition.
"""
INTERFACE

"""
Location adjacent to a union definition.
"""
UNION

"""
Location adjacent to an enum definition.
"""
ENUM

"""
Location adjacent to an enum value definition.
"""
ENUM_VALUE

"""
Location adjacent to an input object type definition.
"""
INPUT_OBJECT

"""
Location adjacent to an input object field definition.
"""
INPUT_FIELD_DEFINITION
}
```