Start.gg Schema

https://smashgg-schema.netlify.app/reference
Admin
Start.gg Schema is a GraphQL API schema documentation for the Start.gg platform, providing access to...
Tokens:3,840
Snippets:22
Trust Score:7.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### __Schema Object Documentation

Source: https://smashgg-schema.netlify.app/reference/schema

Provides information about the entire GraphQL schema, including all supported types, the root types for operations, and available directives.

```APIDOC
## GraphQL Schema Introspection

### Description
This endpoint allows you to introspect the GraphQL schema. It returns details about all types, the root types for query, mutation, and subscription operations, and all supported directives.

### Method
GET

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string for introspection.

### Request Example
```json
{
  "query": "{\n  __schema {\n    types {\n      name\n    }\n    queryType { name }\n    mutationType { name }\n    subscriptionType { name }\n    directives {\n      name\n    }\n  }\n}"
}
```

### Response
#### Success Response (200)
- **data** (__Schema) - An object containing the schema introspection details.
  - **types** ([__Type!]!) - A list of all types supported by the server.
  - **queryType** (__Type!) - The type that query operations will be rooted at.
  - **mutationType** (__Type) - The type that mutation operations will be rooted at (if supported).
  - **subscriptionType** (__Type) - The type that subscription operations will be rooted at (if supported).
  - **directives** ([__Directive!]!) - A list of all directives supported by the server.

#### Response Example
```json
{
  "data": {
    "__schema": {
      "types": [
        {
          "name": "Query"
        },
        {
          "name": "Mutation"
        },
        {
          "name": "Subscription"
        },
        {
          "name": "__Schema"
        },
        {
          "name": "__Type"
        },
        {
          "name": "__Field"
        },
        {
          "name": "__InputValue"
        },
        {
          "name": "__EnumValue"
        },
        {
          "name": "__Directive"
        },
        {
          "name": "__DirectiveLocation"
        }
      ],
      "queryType": {
        "name": "Query"
      },
      "mutationType": null,
      "subscriptionType": null,
      "directives": [
        {
          "name": "deprecated"
        },
        {
          "name": "skip"
        },
        {
          "name": "include"
        },
        {
          "name": "specifiedBy"
        }
      ]
    }
  }
}
```
```

--------------------------------

### GraphQL Schema Definition

Source: https://smashgg-schema.netlify.app/reference/schema

Defines the `__Schema` object in GraphQL. This object exposes all types, query, mutation, and subscription entry points, along with supported directives on the server. It is a fundamental part of understanding a GraphQL API's capabilities.

```graphql
type __Schema {
  # 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!]!
}
```

--------------------------------

### GraphQL Schema Definition for __InputValue

Source: https://smashgg-schema.netlify.app/reference/inputvalue

Defines the structure of an __InputValue in the GraphQL schema. This includes its name, description, type, and optional default value. It is a core component for defining arguments and input fields.

```graphql
type __InputValue {
  name: String!
  description: String
  type: __Type!
  #   A GraphQL-formatted string representing the default value for this input value.
  defaultValue: String
}
```

--------------------------------

### __InputValue Object Type

Source: https://smashgg-schema.netlify.app/reference/inputvalue

Defines the structure of the __InputValue type, used for arguments and input fields in GraphQL schemas.

```APIDOC
## __InputValue Object Type

### Description
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.

### GraphQL Schema Definition
```graphql
  type __InputValue {
    name: String!
    description: String
    type: __Type!
    #   A GraphQL-formatted string representing the default value for this input value.
    defaultValue: String
  }
```

### Fields
- **name** (String!) - The name of the input value.
- **description** (String) - The description of the input value.
- **type** (__Type!) - The type of the input value.
- **defaultValue** (String) - The default value of the input value, represented as a GraphQL-formatted string.

### Required By
- **__Directive**: Used to define arguments for directives.
- **__Field**: Used to define arguments for fields.
- **__Type**: Represents input values within the type system.

```

--------------------------------

### __Directive Type

Source: https://smashgg-schema.netlify.app/reference/directive

Provides details about the __Directive type in the GraphQL schema. Directives allow for conditional inclusion/exclusion of fields and other execution alterations.

```APIDOC
## __Directive Type

### Description
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.

### GraphQL Schema Definition
```graphql
  type __Directive {
    name: String!
    description: String
    locations: [__DirectiveLocation!]!
    args: [__InputValue!]!
    onOperation: Boolean! @deprecated( reason: "Use `locations`.")
    onFragment: Boolean! @deprecated( reason: "Use `locations`.")
    onField: Boolean! @deprecated( reason: "Use `locations`.")
  }
```

### Fields
- **name** (String!) - The name of the directive.
- **description** (String) - A description of the directive.
- **locations** ([__DirectiveLocation!]!) - The locations where the directive can be applied.
- **args** ([__InputValue!]!) - The arguments the directive accepts.
- **onOperation** (Boolean!) - Deprecated: Use `locations` instead.
- **onFragment** (Boolean!) - Deprecated: Use `locations` instead.
- **onField** (Boolean!) - Deprecated: Use `locations` instead.

### Related Types
- **__Schema**: The root type for schema introspection.
- **__DirectiveLocation**: An enum representing the locations where directives can be used.
- **__InputValue**: Represents an input value for a field or directive.
```

--------------------------------

### GraphQL __Type Object

Source: https://smashgg-schema.netlify.app/reference/type

The __Type object represents the fundamental unit of a GraphQL schema. It includes information about the type's kind, name, description, fields, interfaces, possible types, enum values, input fields, and its underlying type.

```APIDOC
## GraphQL Schema Type: __Type

### Description
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 and description, 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.

### Fields

- **kind** (__TypeKind!): The kind of the type (e.g., SCALAR, OBJECT, INTERFACE, UNION, ENUM, INPUT_OBJECT, LIST, NON_NULL).
- **name** (String): The name of the type.
- **description** (String): A description of the type.
- **fields** (Array<__Field!>): A list of fields for OBJECT and INTERFACE types. Accepts an optional `includeDeprecated` boolean argument.
- **interfaces** (Array<__Type!>): A list of interfaces that this type implements.
- **possibleTypes** (Array<__Type!>): A list of possible types for abstract types (UNION, INTERFACE).
- **enumValues** (Array<__EnumValue!>): A list of enum values for ENUM types. Accepts an optional `includeDeprecated` boolean argument.
- **inputFields** (Array<__InputValue!>): A list of input fields for INPUT_OBJECT types.
- **ofType** (__Type): The underlying type for LIST and NON_NULL types.

### Related Types

- **__Field**: 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.
- **__InputValue**: 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.
- **__Schema**: 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.
- **__TypeKind**: An enum that describes the kind of a GraphQL type.
```

--------------------------------

### GraphQL Schema Definition: __Directive Type

Source: https://smashgg-schema.netlify.app/reference/directive

Defines the structure and fields of the __Directive type in a GraphQL schema. This includes its name, description, locations where it can be applied, and its arguments. It also highlights deprecated fields for specifying directive locations.

```graphql
type __Directive {
  name: String!
  description: String
  locations: [__DirectiveLocation!]!
  args: [__InputValue!]!
  onOperation: Boolean! @deprecated( reason: "Use `locations`."  )
  onFragment: Boolean! @deprecated( reason: "Use `locations`."  )
  onField: Boolean! @deprecated( reason: "Use `locations`."  )
}
```

--------------------------------

### __EnumValue Type

Source: https://smashgg-schema.netlify.app/reference/enumvalue

Represents one possible value for a given Enum in the GraphQL schema.

```APIDOC
## __EnumValue Type

### Description
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.

### GraphQL Schema Definition
```graphql
  type __EnumValue {
    name: String!
    description: String
    isDeprecated: Boolean!
    deprecationReason: String
  }
```

### Required By
- __Type
```

--------------------------------

### GraphQL Schema Type Definitions

Source: https://smashgg-schema.netlify.app/reference/typekind

This section details the __TypeKind enum, which describes the different kinds of types within a GraphQL schema.

```APIDOC
## ENUM __TypeKind

### Description
An enum describing what kind of type a given `__Type` is.

### GraphQL Schema definition
```graphql
enum __TypeKind {
  SCALAR
  OBJECT
  INTERFACE
  UNION
  ENUM
  INPUT_OBJECT
  LIST
  NON_NULL
}
```

### Requires
- `__Type` (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 and description, 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.)
```

--------------------------------

### GraphQL Schema Definition for __TypeKind Enum

Source: https://smashgg-schema.netlify.app/reference/typekind

This snippet defines the `__TypeKind` enum in GraphQL Schema Definition Language (SDL). It enumerates the possible kinds a GraphQL type can be, including SCALAR, OBJECT, INTERFACE, UNION, ENUM, INPUT_OBJECT, LIST, and NON_NULL, with descriptions for each.

```graphql
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` 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
}
```

--------------------------------

### GraphQL Schema Definition: __Field Object Type

Source: https://smashgg-schema.netlify.app/reference/field

Defines the structure of the __Field object in a GraphQL schema. It specifies that a field has a name, an optional description, a list of arguments, a return type, a boolean indicating if it's deprecated, and an optional deprecation reason.

```graphql
type __Field {
  name: String!
  description: String
  args: [__InputValue!]!
  type: __Type!
  isDeprecated: Boolean!
  deprecationReason: String
}
```

--------------------------------

### GraphQL Schema Definition: __Type Object

Source: https://smashgg-schema.netlify.app/reference/type

Defines the structure of the '__Type' object within a GraphQL schema. It outlines the fields available to describe different kinds of types, including their name, description, associated fields, interfaces, possible types, enum values, input fields, and the underlying type for list/non-null wrappers. The 'fields' and 'enumValues' fields accept an 'includeDeprecated' argument.

```graphql
type __Type {
  kind: __TypeKind!
  name: String
  description: String
  # Arguments
  #   **includeDeprecated**: [**Not documented**]
  fields(includeDeprecated: Boolean): [__Field!]
  interfaces: [__Type!]
  possibleTypes: [__Type!]
  # Arguments
  #   **includeDeprecated**: [**Not documented**]
  enumValues(includeDeprecated: Boolean): [__EnumValue!]
  inputFields: [__InputValue!]
  ofType: __Type
}
```

--------------------------------

### GraphQL Schema __DirectiveLocation Enum Definition

Source: https://smashgg-schema.netlify.app/reference/directivelocation

Defines the possible locations where directives can be applied in a GraphQL schema. This enum is crucial for understanding directive usage and placement within GraphQL documents.

```graphql
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 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
}
```

--------------------------------

### GraphQL Schema Definition: __EnumValue Type

Source: https://smashgg-schema.netlify.app/reference/enumvalue

Defines the structure of the __EnumValue type in the GraphQL schema. It includes fields for the enum value's name, an optional description, a boolean indicating if it's deprecated, and an optional reason for deprecation.

```graphql
type __EnumValue {
  name: String!
  description: String
  isDeprecated: Boolean!
  deprecationReason: String
}
```
Tokens:
Raw