Schema documentation in GraphQL - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

What is the purpose of schema documentation in GraphQL?

Why do developers add documentation comments to GraphQL schema definitions?

A To explain the purpose and usage of types and fields for better understanding

B To increase the size of the schema file for security reasons

C To automatically generate database tables from the schema

D To prevent the schema from being queried by unauthorized users

💡 Hint

Think about how comments help people understand code.

Schema documentation helps developers and users understand what each type and field means and how to use them.

❓ query_result

intermediate

What is the output of this GraphQL introspection query snippet?

Given this schema documentation snippet, what description will the introspection query return for the field 'title'?

GraphQL

type Book {
  "The title of the book"
  title: String!
  author: String!
}

A "title"

B "Book title field"

C null

D "The title of the book"

💡 Hint

Look at the string inside the quotes above the field.

The description in the schema documentation is returned as the field's description in introspection queries.

📝 Syntax

advanced

Which schema documentation syntax is valid in GraphQL SDL?

Select the option that correctly documents a field in GraphQL SDL.

GraphQL

type User {
  # User's unique ID
  id: ID!
  "User's email address"
  email: String!
}

A Using /* ... */ block comments around the field

B Using single-line comments with # before the field

C Using triple quotes """ before the field for multi-line description

D Using XML style <!-- ... --> comments

💡 Hint

GraphQL SDL supports a special string syntax for documentation.

GraphQL SDL uses string literals ("..." or """...""") for documentation that appears in introspection. # comments are ignored by introspection.

❓ optimization

advanced

How does good schema documentation improve API usability?

Choose the best explanation of how detailed schema documentation benefits API consumers.

A It makes the schema file larger and harder to download

B It reduces the need for external manuals by providing clear field descriptions

C It forces clients to cache schema locally

D It automatically validates client queries

💡 Hint

Think about how clear explanations help users understand an API.

Good documentation inside the schema helps developers understand what each field means without searching for external docs.

🔧 Debug

expert

What error occurs with this schema documentation usage?

Identify the error caused by this schema snippet:

GraphQL

type Query {
  """Fetch a user by ID"""
  user(id: ID!): User
  # Fetch all users
  users: [User!]!
}

A The second field 'users' has no description because # comments are ignored

B SyntaxError due to # comment inside type definition

C Runtime error when querying 'users' field

D The schema fails to compile because of missing triple quotes

💡 Hint

Check how GraphQL treats # comments in schema documentation.

GraphQL ignores # comments for documentation purposes; string literals ("..." or """...""") are recognized as descriptions.

Practice

1. What is the purpose of using triple quotes """ in GraphQL schema documentation?

easy

A. To define a new type in the schema

B. To write comments that are ignored by the server

C. To add descriptions to types and fields

D. To create a mutation operation

Solution

1. Step 1: Understand triple quotes usage in GraphQL

   Triple quotes """ are used to add descriptions to schema elements like types and fields.

2. Step 2: Differentiate from other schema elements

   They are not for defining types, comments, or mutations but for documentation purposes.

3. Final Answer:

   To add descriptions to types and fields -> Option C

4. Quick Check:

   Triple quotes = descriptions [OK]

Hint: Triple quotes always mean description text in GraphQL [OK]

Common Mistakes:

• Confusing triple quotes with comments
• Thinking triple quotes define types
• Using triple quotes for operations

2. Which of the following is the correct way to add a description to a GraphQL field named age?

easy

A. """User age""" age: Int

B. age: Int # User age

C. age: Int """User age"""

D. "User age" age: Int

Solution

1. Step 1: Identify correct syntax for field description

   In GraphQL, descriptions go before the field using triple quotes.

2. Step 2: Check each option

   """User age""" age: Int places """User age""" before age: Int, which is correct syntax.

3. Final Answer:

   """User age""" age: Int -> Option A

4. Quick Check:

   Description before field with triple quotes = correct [OK]

Hint: Put triple-quoted description right before the field [OK]

Common Mistakes:

• Placing description after the field
• Using single quotes instead of triple quotes
• Using comments (#) instead of descriptions

3. Given this schema snippet, what will the description of the name field be?

type Person {
  """Full name of the person"""
  name: String
  age: Int
}

medium

A. Full name of the person

B. Name of the person

C. No description

D. Person's age

Solution

1. Step 1: Locate the description for the name field

   The triple-quoted string """Full name of the person""" is right above name: String.

2. Step 2: Understand it applies as the description

   This means the description for the name field is exactly that string.

3. Final Answer:

   Full name of the person -> Option A

4. Quick Check:

   Description above field = "Full name of the person" [OK]

Hint: Description above field is the field's doc [OK]

Common Mistakes:

• Assuming no description if not inline
• Confusing field name with description
• Mixing descriptions of different fields

4. Identify the error in this schema documentation snippet:

type Query {
  """Fetch user by ID"""
  user(id: ID!): User
  """Fetch all users"""
  users: [User]
  "Fetch version info"
  version: String
}

medium

A. Descriptions must be after the field, not before

B. The description for version uses double quotes instead of triple quotes

C. Descriptions cannot be used on Query type fields

D. The id argument is missing a description

Solution

1. Step 1: Check description syntax for each field

   The first two fields use triple quotes correctly. The version field uses double quotes "Fetch version info", which is invalid.

2. Step 2: Confirm correct usage

   Descriptions must use triple quotes """ to be valid in GraphQL schema.

3. Final Answer:

   The description for version uses double quotes instead of triple quotes -> Option B

4. Quick Check:

   Descriptions need triple quotes, not double [OK]

Hint: Descriptions always need triple quotes, not double [OK]

Common Mistakes:

• Using single or double quotes instead of triple quotes
• Placing descriptions after fields
• Assuming arguments need descriptions

5. You want to document a GraphQL schema so that the Book type and its title field have clear descriptions. Which schema snippet correctly documents both?

hard

A. "A book in the library" type Book { title: String "Title of the book" }

B. type Book { title: String """Title of the book""" } """A book in the library"""

C. type Book { "A book in the library" title: String "Title of the book" }

D. """A book in the library""" type Book { """Title of the book""" title: String }

Solution

1. Step 1: Check how to document a type

   The type description must be placed immediately before the type keyword using triple quotes.

2. Step 2: Check how to document a field

   The field description must be placed immediately before the field definition using triple quotes.

3. Step 3: Validate each option

   Only """A book in the library""" type Book { """Title of the book""" title: String } correctly places triple-quoted descriptions before the type and field.

4. Final Answer:

   """A book in the library""" type Book { """Title of the book""" title: String } -> Option D

5. Quick Check:

   Descriptions before type and field with triple quotes = correct [OK]

Hint: Put triple-quoted descriptions right before type and field [OK]

Common Mistakes:

• Placing descriptions after types or fields
• Using single quotes instead of triple quotes
• Not adding description for both type and field