Core Schemas

flexible metadata for GraphQL schemas

StatusRelease
Version0.2

GraphQL provides directives as a means of attaching user‐defined metadata to a GraphQL document. Directives are highly flexible, and can be used to suggest behavior and define features of a graph which are not otherwise evident in the schema.

Alas, GraphQL does not provide a mechanism to globally identify or version directives. Given a particular directive—e.g. @join—processors are expected to know how to interpret the directive based only on its name, definition within the document, and additional configuration from outside the document. This means that programs interpreting these directives have two options:

  1. rely on a hardcoded interpretation for directives with certain signatures, or
  2. accept additional configuration about how to interpret directives in the schema.

The first solution is fragile, particularly as GraphQL has no built‐in namespacing mechanisms, so the possibility of name collisions always looms.

The second is unfortunate: GraphQL schemas are generally intended to be self‐describing, and requiring additional configuration subtly undermines this guarantee: given just a schema, programs do not necessarily know how to interpret it, and certainly not how to serve it. It also creates the possibility for the schema and configuration to fall out of sync, leading to issues which can manifest late in a deployment pipeline.

Introducing core schemas.

core schema

A basic core schema:

Example โ„– 1 A basic core schema
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://specs.example.com/example/v1.0")
{
  query: Query
}

type Query {
  field: Int @example
}

directive @example on FIELD_DEFINITION

directive @core(feature: String!, as: String) repeatable on SCHEMA

Core schemas provide a concise mechanism for schema documents to specify the metadata they provide. Metadata is grouped into features, which typically define directives and associated types (e.g. scalars and inputs which serve as directive inputs). Additionally, core schemas provide:

Core schemas are not a new language. All core schema documents are valid GraphQL schema documents. However, this specification introduces new requirements, so not all valid GraphQL schemas are valid core schemas.

The broad intention behind core schemas is to provide a single document which provides all the necessary configuration for programs that process and serve the schema to GraphQL clients, primarily by following directives in order to determine how to resolve queries made against that schema.

1Parts of a Core Schema

When talking about a core schema, we can broadly break it into two pieces:

This reflects how core schemas are used: a core schema contains a GraphQL interface (the API) along with metadata about how to implement that interface (the machinery). Exposing the machinery to clients is unnecessary, and may in some cases constitute a security issue (for example, the machinery for a public‐facing graph router will likely reference internal services, possibly exposing network internals which should not be visible to the general public).

A key feature of core schemas is that it is always possible to derive a core schema’s API without any knowledge of the features used by the document (with the exception of the core feature itself). Specifically, named elements are not included in the API schema if they are named something__likeThis or are a directive named @something, and something is the prefix of a feature declared with @core.

A formal description is provided by the IsInAPI algorithm.

2Actors

Actors who may be interested in the core schemas
graph TB classDef bg fill:none,color:#22262E; author("๐Ÿ‘ฉ๐Ÿฝโ€๐Ÿ’ป ๐Ÿค–  Author"):::bg-->schema(["โ˜‰ Core Schema"]):::bg schema-->proc1("๐Ÿค–  Processor"):::bg proc1-->output1(["โ˜‰ Core Schema[0]"]):::bg output1-->proc2("๐Ÿค–  Processor"):::bg proc2-->output2(["โ˜‰ Core Schema[1]"]):::bg output2-->etc("..."):::bg etc-->final(["โ˜‰ Core Schema [final]"]):::bg final-->core("๐Ÿค– Data Core"):::bg schema-->reader("๐Ÿ‘ฉ๐Ÿฝโ€๐Ÿ’ป Reader"):::bg output1-->reader output2-->reader final-->reader

3Basic Requirements

Core schemas:

  1. MUST be valid GraphQL schema documents,
  2. MUST contain exactly one SchemaDefinition, and
  3. MUST use the @core directive on their schema definition to declare any features they reference by using @core to reference a well‐formed feature URL.

The first @core directive on the schema MUST reference the core spec itself, i.e. this document.

Example โ„– 2 Basic core schema using @core and @example
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://specs.example.com/example/v1.0")
{
  query: Query
}

type Query {
  field: Int @example
}

directive @example on FIELD_DEFINITION

directive @core(feature: String!, as: String) repeatable on SCHEMA

3.1Unspecified directives are passed through by default

Existing schemas likely contain definitions for directives which are not versioned, have no specification document, and are intended mainly to be passed through. This is the default behavior for core schema processors:

Example โ„– 3 Unspecified directives are passed through
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
{
  query: Query
}

type SomeType {
  field: Int @another
}

# `@another` is unspecified. Core processors will not extract metadata from
# it, but its definition and all usages within the schema will be exposed
# in the API.
directive @another on FIELD_DEFINITION

directive @core(feature: String!, as: String) repeatable on SCHEMA

3.2Renaming core itself

It is possible to rename the core feature itself with the same as: mechanism used for all features:

Example โ„– 4 Renaming @core to @coreSchema
schema
  @coreSchema(feature: "https://specs.apollo.dev/core/v0.1", as: "coreSchema")
  @coreSchema(feature: "https://example.com/example/v1.0")
{
  query: Query
}

type SomeType {
  field: Int @example
}

directive @coreSchema(feature: String!, as: String)
  repeatable on SCHEMA
directive @example on FIELD_DEFINITION

4Directive Definitions

All core schemas use the @core directive to declare their use of the core feature itself as well as any other core features they use.

In order to use these directives in your schema, GraphQL requires you to include their definitions in your schema.

Processors MUST validate that you have defined the directives with the same arguments, locations, and repeatable flag as given below. Specifically, the bootstrapping algorithm validates that the @core directive has a definition matching the definition given below. (The bootstrapping algorithm does not require processors to validate other aspects of the directive declaration such as description strings or argument ordering. The main purpose of this validation is to ensure that directive arguments have the type and default values expected by the specification.)

The following declares the directive defined by this specification. You SHOULD define the directives in your core schema by including the following text in your schema document.

directive @core(feature: String!, as: String) repeatable on SCHEMA

When writing a specification for your own core feature, you SHOULD include a section like this one with sample definitions to copy into schemas, and you SHOULD require processors to validate that directive definitions in documents match your sample definitions.

5Directives

5.1@core

Declare a core feature present in this schema.

directive @core(
  feature: String!,
  as: String,
  for: core__Purpose)
  repeatable on SCHEMA

Documents MUST include a definition for the @core directive which includes all of the arguments defined above with the same types and default values.

5.1.1feature: String!

A feature URL specifying the directive and associated schema elements. When viewed, the URL SHOULD provide the content of the appropriate version of the specification in some human‐readable form. In short, a human reader should be able to click the link and go to the docs for the version in use. There are specific requirements on the format of the URL, but it is not required that the content be machine‐readable in any particular way.

Feature URLs contain information about the spec’s prefix and version.

Feature URLs serve two main purposes:

  • Directing human readers to documentation about the feature
  • Providing tools with information about the specs in use, along with enough information to select and invoke an implementation

Feature URLs SHOULD be RFC 3986 URLs. When viewed, the URL SHOULD provide the specification of the selected version of the feature in some human‐readable form; a human reader should be able to click the link and go to the correct version of the docs.

Although they are not prohibited from doing so, it’s assumed that processors will not load the content of feature URLs. Published specifications are not required to be machine‐readable, and this spec places no requirements on the structure or syntax of the content to be found there.

There are, however, requirements on the structure of the URL itself:

Basic anatomy of a feature URL
https://spec.example.com/a/b/c/exampleFeature/v1.0

The final two segments of the URL’s path MUST contain the feature’s name and a version tag. The content of the URL up to and including the name—but excluding the / after the name and the version tag—is the feature’s identity. Trailing slashes at the end of the URL (ie, after the version tag) should be ignored. For the above example,

identity: "https://spec.example.com/a/b/c/exampleFeature"
A global identifier for the feature. Processors can treat this as an opaque string identifying the feature (but not the version of the feature) for purposes of selecting an appropriate implementation. The identity never has a trailing /.
name: "exampleFeature"
The feature’s name, for purposes of prefixing schema elements it defines.
version: "v1.0"
The tag for the version of the feature used to author the document. Processors MUST select an implementation of the feature which can satisfy the specified version.

The version tag MUST be a valid VersionTag. The name MUST be a valid GraphQL name which does not include the namespace separator ("__").

5.1.1.1Ignore meaningless URL components

When extracting the URL’s name and version, processors MUST ignore any url components which are not assigned a meaning. This spec assigns meaning to the final two segments of the path. Other URL components—particularly query strings and fragments, if present—MUST be ignored for the purposes of extracting the name and version.

Ignoring meaningless parts of a URL
https://example.com/exampleSpec/v1.0/?key=val&k2=v2#frag

5.1.1.2Why is versioning in the URL, not a directive argument?

The version is in the URL because when a human reader visits the URL, we would like them to be taken to the documentation for the version of the feature used by this document. Many text editors will turn URLs into hyperlinks, and it’s highly desirable that clicking the link takes the user to the correct version of the docs. Putting the version information in a separate argument to the @core directive would prevent this.

5.1.2as: String

Change the names of directives and schema elements from this specification. The specified string MUST be a valid GraphQL name and MUST NOT contain the namespace separator (two underscores, "__") or end with an underscore.

When as: is provided, processors looking for prefixed schema elements MUST look for elements whose names are the specified name with the prefix replaced with the name provided to the as: argument.

Example โ„– 5 Using @core(feature:, as:) to use a feature with a custom name
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://spec.example.com/example/v1.0", as: "eg")
{
  query: Query
}

type User {
  # Specifying `as: "eg"` transforms @example into @eg
  name: String @eg(data: ITEM)
}

# Additional specified schema elements must have their prefixes set
# to the new name.
#
# The spec at https://spec.example.com/example/v1.0 calls this enum
# `example__Data`, but because of the `as:` argument above, processors
# will use this `eg__Data` enum instead.
enum eg__Data {
  ITEM
}

# Name transformation must also be applied to definitions pulled in from
# specifications.
directive @eg(data: eg__Data) on FIELD_DEFINITION

directive @core(feature: String!, as: String) repeatable on SCHEMA

5.1.3for: core__Purpose

An optional purpose for this feature. This hints to consumers as to whether they can safely ignore metadata from a given feature.

By default, core features SHOULD fail open. This means that an unknown feature SHOULD NOT prevent a schema from being served or processed. Instead, consumers SHOULD ignore unknown feature metadata and serve or process the rest of the schema normally.

This behavior is different for features with a specified purpose:

  • SECURITY features convey metadata necessary to securely resolve fields within the schema
  • EXECUTION features convey metadata necessary to correctly resolve fields within the schema

6Enums

6.1core__Purpose

enum core__Purpose {
  SECURITY
  EXECUTION
}

The role of a feature referenced with @core.

This is not intended to be an exhaustive list of all the purposes a feature might serve. Rather, it is intended to capture cases where the default fail‐open behavior of core schema consumers is undesirable.

Note we’ll refer to directives from features which are for: SECURITY or for: EXECUTION as “SECURITY directives” and “EXECUTION directives”, respectively.

6.1.1SECURITY

SECURITY features provide metadata necessary to securely resolve fields. For instance, a hypothetical auth feature may provide an @auth directive to flag fields which require authorization. If a data core does not support the auth feature and serves those fields anyway, these fields will be accessible without authorization, compromising security.

Security‐conscious consumers MUST NOT serve a field if:

  • the schema definition has any unsupported SECURITY directives,
  • the field’s parent type definition has any unsupported SECURITY directives,
  • the field’s return type definition has any unsupported SECURITY directives, or
  • the field definition has any unsupported SECURITY directives

Such fields are not securely resolvable. Security‐conscious consumers MAY serve schemas with fields which are not securely resolvable. However, they MUST remove such fields from the schema before serving it.

Less security‐conscious consumers MAY choose to relax these requirements. For instance, servers may provide a development mode in which unknown SECURITY directives are ignored, perhaps with a warning. Such software may also provide a way to explicitly disable some or all SECURITY features during development.

More security‐conscious consumers MAY choose to enhance these requirements. For instance, production servers MAY adopt a policy of entirely rejecting any schema which contains ANY unsupported SECURITY features, even if those features are never used to annotate the schema.

6.1.2EXECUTION

EXECUTION features provide metadata necessary to correctly resolve fields. For instance, a hypothetical ts feature may provide a @ts__resolvers annotation which references a TypeScript module of field resolvers. A consumer which does not support the ts feature will be unable to correctly resolve such fields.

Consumers MUST NOT serve a field if:

  • the schema’s definition has any unsupported EXECUTION directives,
  • the field’s parent type definition has any unsupported EXECUTION directives,
  • the field’s return type definition has any unsupported EXECUTION directives, or
  • the field definition has any unsupported EXECUTION directives

Such fields are unresolvable. Consumers MAY attempt to serve schemas with unresolvable fields. Depending on the needs of the consumer, unresolvable fields MAY be removed from the schema prior to serving, or they MAY produce runtime errors if a query attempts to resolve them. Consumers MAY implement stricter policies, wholly refusing to serve schemas with unresolvable fields, or even refusing to serve schemas with any unsupported EXECUTION features, even if those features are never used in the schema.

7Prefixing

With the exception of a single root directive, core feature specifications MUST prefix all schema elements they introduce. The prefix:

  1. MUST match the name of the feature as derived from the feature’s specification URL,
  2. MUST be a valid GraphQL name, and
  3. MUST NOT contain the core namespace separator, which is two underscores ("__"), and
  4. MUST NOT end with an underscore (which would create ambiguity between whether "x___y" is prefix x_ for element y or prefix x for element _y).

Prefixed names consist of the name of the feature, followed by two underscores, followed by the name of the element, which can be any valid GraphQL name. For instance, the core specification (which you are currently reading) introduces an element named @core, and the join specification introduces an element named @join__field (among others).

Note that both parts must be valid GraphQL names, and GraphQL names cannot start with digits, so core feature specifications cannot introduce names like @feature__24hours.

A feature’s root directive is an exception to the prefixing requirements. Feature specifications MAY introduce a single directive which carries only the name of the feature, with no prefix required. For example, the core specification introduces a @core directive. This directive has the same name as the feature (”core”), and so requires no prefix.

Example โ„– 6 Using the @core directive without changing the prefix
schema
 @core(feature: "https://specs.apollo.dev/core/v0.1")
 @core(feature: "https://spec.example.com/example/v1.0") {
  query: Query
}

type User {
  name: String @example(data: ITEM)
}

# An enum used to provide structured data to the example spec.
# It is prefixed with the name of the spec.
enum example__Data {
  ITEM
}

directive @example(data: example__Data) on FIELD_DEFINITION

directive @core(feature: String!, as: String) repeatable on SCHEMA

The prefix MUST NOT be elided within documentation; definitions of schema elements provided within the spec MUST include the feature’s name as a prefix.

7.1Elements which must be prefixed

Feature specs MUST prefix the following schema elements:

  • the names of any object types, interfaces, unions, enums, or input object types defined by the feature
  • the names of any directives introduced in the spec, with the exception of the root directive, which must have the same name as the feature
Example โ„– 7 Prefixing
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://spec.example.com/featureA/v1.0")
  @core(feature: "https://spec.example.com/featureB/v2.0", as: "B") {
  query: Query
}

"""
featureA__SomeType is a type defined by feature A.
"""
type featureA__SomeType {
  """
  nativeField is a field defined by featureA on a type also defined
  by featureA (namely featureA__SomeType)
  """
  nativeField: Int @featureA__fieldDirective
}

"""
featureA__SomeInput is an input specified by feature A
"""
input featureA__SomeInput {
  """
  nativeInputField is defined by featureA
  """
  nativeInputField: Int
}

"""
featureA__Items is specified by feature A
"""
enum featureA__Items { ONE, TWO, THREE @B }

"""
@B is the root directive defined by featureB

Root directives are named after their feature
"""
directive @B on ENUM_VALUE

"""
@featureA__fieldDirective is a non-root (prefixed) directive defined by featureA
"""
directive @featureA__fieldDirective on FIELD_DEFINITION

directive @core(feature: String!, as: String) repeatable on SCHEMA

8Versioning

PositiveDigit
1|2|3|4|5|6|7|8|9

Specs are versioned with a subset of a Semantic Version Number containing only the major and minor parts. Thus, specifications SHOULD provide a version of the form vMajor.Minor, where both integers ≥ 0.

Example โ„– 8 Valid version tags
v2.2
v1.0
v1.1
v0.1

As specified by semver, spec authors SHOULD increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards compatible manner

Patch and pre‐release qualifiers are judged to be not particularly meaningful in the context of core features, which are (by definition) interfaces rather than implementations. The patch component of a semver denotes a bug fix which is backwards compatible—that is, a change to the implementation which does not affect the interface. Patch‐level changes in the version of a spec denote wording clarifications which do not require implementation changes. As such, it is not important to track them for the purposes of version resolution.

As with semver, the 0.x version series is special: there is no expectation of compatibility between versions 0.x and 0.y. For example, a processor must not activate implementation 0.4 to satisfy a requested version of 0.2.

8.1Satisfaction

Given a version requested by a document and an available version of an implementation, the following algorithm will determine if the available version can satisfy the requested version:

Satisfies(requested, available)
  1. If requested.Major โ‰  available.Major, return false
  2. If requested.Major = 0, return requested.Minor = available.Minor
  3. Return requested.Minoravailable.Minor

8.2Referencing versions and activating implementations

Schema documents MUST reference a feature version which supports all the schema elements and behaviors required by the document. As a practical matter, authors will generally prefer to reference a version they have reason to believe is supported by the most processors; depending on context, this might be an old stable version with a low major version, or a new less‐deprecated version with a large major version.

If a processor chooses to activate support for a feature, the processor MUST activate an implementation which can satisfy the version required by the document.

9Processing Schemas

graph LR schema(["๐Ÿ“„ Input Schema"]):::file-->proc("๐Ÿค–  Processor") proc-->output(["๐Ÿ“„ Output Schema"]):::file classDef file fill:none,color:#22262E; style proc fill:none,stroke:fuchsia,color:fuchsia;

A common use case is that of a processor which consumes a valid input schema and generates an output schema.

The general guidance for processor behavior is: don’t react to what you don’t understand.

Specifically, processors:

Processors MAY accept configuration which overrides these default behaviors.

Additionally, processors which prepare the schema for final public consumption MAY choose to eliminate all unknown directives and prefixed types in order to hide schema implementation details within the published schema. This will impair the operation of tooling which relies on these directives—such tools will not be able to run on the output schema, so the benefits and costs of this kind of information hiding should be weighed carefully on a case‐by‐case basis.

10Validations & Algorithms

This section lays out algorithms for processing core schemas.

Algorithms described in this section may produce validation failures if a document does not conform to the requirements core schema document. Validation failures SHOULD halt processing. Some consumers, such as authoring tools, MAY attempt to continue processing in the presence of validation failures, but their behavior in such cases is unspecified.

10.1Bootstrapping

Determine the name of the core specification within the document.

It is possible to rename the core feature within a document. This process determines the actual name for the core feature if one is present.

  • Fails the Has Schema validation if there are no SchemaDefinitions in the document
  • Fails the Has Core Feature validation if the core feature itself is not referenced with a @core directive within the document
  • Fails the Bootstrap Core Feature Listed First validation if the reference to the core feature is not the first @core directive on the document’s SchemaDefinition
  • Fails the Core Directive Incorrect Definition validation if the @core directive definition does not match the directive as defined by this specification.

For the purposes of this algorithm, a directive’s definition in a schema matches a definition provided in this specification if:

  • Its arguments have the specified names, types, and default values (or lack thereof)
  • It is defined as repeatable if and only if the specification’s definition defines it as repeatable
  • The set of locations it belongs to is the same set of locations in the specification’s definition.

The following aspects may differ between the definition in the schema and the definition in the specification without preventing the definitions from matching:

  • The name of the directive (due to prefixing)
  • The order of arguments
  • The order of locations
  • The directive’s description string
  • Argument description strings
  • Directives applied to argument definitions
Bootstrap(document)
  1. Let schema be the only SchemaDefinition in document. (Note that legal GraphQL documents must include at most one SchemaDefinition.)
    1. ...if no SchemaDefinitions are present in document, the Has Schema validation fails.
  2. For each directive d on schema,
    1. If d has a feature: argument which parses as a feature URL, and whose identity is "https://specs.apollo.dev/core/" and whose version is "v0.1", and either d has an as: argument whose value is equal to d‘s name or d does not have an as: argument and d‘s name is core:
      1. If any directive on schema listed before d has the same name as d, the Bootstrap Core Feature Listed First validation fails.
      2. If the definition of the directive d does not match the definition of @core in this specification, the Core Directive Incorrect Definition validation fails.
      3. Otherwise, Return d‘s name.
  3. If no matching directive was found, the Has Core Feature validation fails.

10.2Feature Collection

Collect a map of (featureName: String) → Directive, where Directive is a @core Directive which introduces the feature named featureName into the document.

  • Fails the Name Uniqueness validation if feature names are not unique within the document.
  • Fails Invalid Feature URL validation for any invalid feature URLs.
CollectFeatures(document)
  1. Let coreName be the name of the core feature found via Bootstrap(document)
  2. Let features be a map of featureName: StringDirective, initially empty.
  3. For each directive d named coreName on the SchemaDefinition within document,
    1. Let specifiedFeatureName and version be the result of parsing d‘s feature: argument according to the specified rules for feature URLs
    2. If the feature: is not present or fails to parse:
      1. The Invalid Feature URL validation fails for d,
    3. Let featureName be the d‘s as: argument or, if the argument is not present, specifiedFeatureName
    4. If featureName exists within features, the Name Uniqueness validation fails.
    5. Insert featureNamed into features
  4. Return features

Prefixes, whether implicit or explicit, must be unique within a document. Valid:

Example โ„– 9 Unique prefixes
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://spec.example.com/featureA/v1.0")
  @core(feature: "https://spec.example.com/featureB/v2.0", as: "B") {
  query: Query
}

It is also valid to reference multiple versions of the same spec under different prefixes:

Example โ„– 10 Explicit prefixes allow multiple versions of the same spec to coexist within a Document
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://specs.example.com/A/1.0")               # name is A
  @core(feature: "https://specs.example.com/A/2.0", as: "A2")     # name is A2
{
  query: Query
}

Without the explicit as:, the above would be invalid:

Counter Example โ„– 11 Non‐unique prefixes with multiple versions of the same spec
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://specs.example.com/A/1.0") # name is A
  @core(feature: "https://specs.example.com/A/2.0") # name is A
{
  query: Query
}

Different specs with the same prefix are also invalid:

Counter Example โ„– 12 Different specs with non‐unique prefixes
schema
  @core(feature: "https://specs.apollo.dev/core/v0.1")
  @core(feature: "https://specs.example.com/A/1.0")              # name is A
  @core(feature: "https://www.specs.com/specA/1.1", as: "A")     # name is A
{
  query: Query
}

10.3Assign Features

Create a map of element: Any Named Elementfeature: Directive | null, associating every named schema element within the document with a feature directive, or null if it is not associated with a feature.

AssignFeatures(document)
  1. Let features be the result of collecting features via CollectFeatures(document)
  2. Let assignments be a map of (element: Any Named Element) → feature: Directive | null, initally empty
  3. For each named schema element e within the document
    1. Let name be the name of the e
    2. If e is a Directive and name is a key within features,
      1. Insert efeatures[name] into assignments
      2. Continue to next e
    3. If name begins with "__",
      1. Insert enull into assignments
      2. Continue to next e
    4. If name contains the substring "__",
      1. Partition name into [prefix, base] at the first "__" (that is, find the shortest prefix and longest base such that name = prefix + "__" + base)
      2. If prefix exists within features, insert efeatures[prefix] into assignments
        1. Else, insert enull into assignments
      3. Continue to next e
    5. Insert enull into assignments
  4. Return assignments

10.4Is In API?

Determine if any schema element is included in the API described by the core schema. A schema element is any part of a GraphQL document using type system definitions that has a name.

IsInAPI(element)
  1. Let assignments be the result of assigning features to elements via AssignFeatures(document)
  2. If assignments[element] is null, Return true
  3. Else, Return false
Note Later versions of this specification may add other ways to affect the behavior of this algorithm, but those mechanisms will only be enabled if you reference those hypothetical versions of this specification.

10.5Is Affected By Feature?

Determine if a schema element is affected by a given feature.

IsAffected(element, feature)
  1. Let assignments be the result of assigning features to elements via AssignFeatures(document)
  2. For each directive d on element, If assignments[d] is feature, Return true
  3. If element is a FieldDefinition,
    1. Let parent be the parent ObjectDefinition or InterfaceDefinition for element
    2. If IsAffected(parent, feature), Return true
    3. For each argument type a declared on element,
      1. Let t be the InputDefinition, EnumDefinition, or ScalarDefinition for argument a
      2. If IsAffected(t, feature), Return true
    4. Let return be the ObjectDefinition, InterfaceDefinition, or UnionDefinition for element‘s return type
    5. If IsAffected(return, feature), Return true
  4. If element is an InputDefinition,
    1. For each InputFieldDefinition field within element,
      1. Let t be the InputDefinition, EnumDefinition, or ScalarDefinition for the type of field
      2. If IsAffected(t, feature), Return true
  5. If element is an EnumDefinition,
    1. For each EnumValueDefinition value in element,
      1. If IsAffected(value, feature), Return true

ยงIndex

  1. AssignFeatures
  2. Bootstrap
  3. CollectFeatures
  4. Digit
  5. IsAffected
  6. IsInAPI
  7. Major
  8. Minor
  9. NumericIdentifier
  10. PositiveDigit
  11. Satisfies
  12. Version
  13. VersionTag
  1. 1Parts of a Core Schema
  2. 2Actors
  3. 3Basic Requirements
    1. 3.1Unspecified directives are passed through by default
    2. 3.2Renaming core itself
  4. 4Directive Definitions
  5. 5Directives
    1. 5.1@core
      1. 5.1.1feature: String!
        1. 5.1.1.1Ignore meaningless URL components
        2. 5.1.1.2Why is versioning in the URL, not a directive argument?
      2. 5.1.2as: String
      3. 5.1.3for: core__Purpose
  6. 6Enums
    1. 6.1core__Purpose
      1. 6.1.1SECURITY
      2. 6.1.2EXECUTION
  7. 7Prefixing
    1. 7.1Elements which must be prefixed
  8. 8Versioning
    1. 8.1Satisfaction
    2. 8.2Referencing versions and activating implementations
  9. 9Processing Schemas
  10. 10Validations & Algorithms
    1. 10.1Bootstrapping
    2. 10.2Feature Collection
    3. 10.3Assign Features
    4. 10.4Is In API?
    5. 10.5Is Affected By Feature?
  11. ยงIndex