v7.3.0

New Features

• Include list of possible types for each Interface (#109)

Full Changelog: v7.2.0...v7.3.0

v7.2.0

New Features

• Individual fields within a type are now linkable via an id within each field’s table row. For example, if the type MessageInput has a field author, you can link to the corresponding table row with the fragment #messageinput.author.

  Additionally, fields can now appear in the Table of Contents, nested under their parent type, with the new --toc-fields CLI option or tocFieldTypes option to renderSchema.

  You can show fields in the TOC for specific types (comma-separated):

  --toc-fields "Query,Mutation,Subscription"
  

  …or for all types with the special string *. This will include query, mutation, subscription, object, input, and interface types.

  --toc-fields "*"
  

  Note that fields always get an anchor ID and are thus always linkable, regardless of whether they appear in the TOC.

  (#104, thanks @cyberwombat and @fmontorsi-equinix for the initial work and discussion!)

Full Changelog: v7.1.0...v7.2.0

v7.1.0

New Features

• Render top-level Subscription type alongside Query and Mutation. (#70, thanks @amalfatti!)

Fixed

• Fix rendering of Markdown in Union descriptions. (#73, thanks @nextdude!)

Full Changelog: v7.0.1...v7.1.0

v7.0.1

Fixed

• Fix missing <tr> elements in Enum and Union <thead>. (#100, thanks @InesAguas!)

Full Changelog: v7.0.0...v7.0.1

v7.0.0

Breaking Change

• The minimum supported Node.js version has been bumped to 14.0.0.
• All dependencies have been bumped where possible; these may come with their own new system requirements (e.g. minimum Node.js version).

Internal

• Adopt standard Prettier config rather than less popular "Standard" config.

v6.1.0

• Add support for GraphQL v16. (#87, thanks @nextdude!)

v6.0.0

Breaking Change

• The introspection query is now obtained via .getIntrospectionQuery() rather than .introspectionQuery, which means versions of graphql prior to its introduction in v0.12 are no longer supported.
• The graphql package was moved from dependencies to peerDependencies, so it will no longer be automatically installed with this package. This should mean that there won't potentially be multiple versions of graphql installed in node_modules and this package should just inherit whichever you already use (even though it should have already anyway due to it being resolved with resolve-from).

New Feature

• Support for graphql v15, which removed the deprecated .introspectionQuery API in favor of .getIntrospectionQuery(). (#65, @aisapatino)
• Support for rendering UNION types. (#53, @nextdude)

v5.2.0

New Feature

• Added --no-toc CLI option and skipTableOfContents Node API for skipping the Table of Contents rendering. #48, thanks @p-janik!

v5.1.0

New Feature

• The new --header CLI param allows you to add arbitrary HTTP headers to the request when fetching a remote GraphQL schema (#40). Thanks to @johannespfeiffer and @ruben-podadera for the original idea.

v5.0.1

Fixed

• Remove accidental trailing space after Query and Mutation section heading names.
• Improved GraphQLSchema instance detection.