Skip to content
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.

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

chore(docs): add graphql docs generation #1594

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ seeds
dev-tools
libs/spoke-codegen/src/generated.ts
libs/spoke-codegen/src/pg-types.ts
public/**/*
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ CHANGELOG.md
tsconfig.json
libs/spoke-codegen/src/generated.ts
libs/spoke-codegen/src/pg-types.ts
public/**/*
15 changes: 15 additions & 0 deletions config.spectaql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
spectaql:
displayAllServers: false
introspection:
removeTrailingPeriodFromDescriptions: false
schemaFile: ./src/schema.graphql
queryNameStrategy: capitalizeFirst
fieldExpansionDepth: 2
spectaqlDirective:
enable: true
extensions:
graphqlScalarExamples: true
info:
title: Spoke GraphQL API Reference
description: v6.20.0-rc.0
x-url: https://stagingenv.spokerewired.com/graphql
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
"dev:codegen:ts": "run-when-changed --watch \"src/schema.graphql\" --watch \"libs/spoke-codegen/src/graphql/**/*.graphql\" --exec \"yarn codegen:ts\"",
"dev:client-nowrap": "nf start --trim 500 --procfile ./dev-tools/Procfile.dev",
"util:insert-invite": "babel-node ./dev-tools/insert-invite.js",
"util:generate-contacts": "babel-node ./dev-tools/generate-contacts.js"
"util:generate-contacts": "babel-node ./dev-tools/generate-contacts.js",
"util:graphql-docs": "spectaql -c ./config.spectaql.yml"
},
"repository": {
"type": "git",
Expand Down
37,259 changes: 37,259 additions & 0 deletions public/index.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions public/javascripts/spectaql.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions public/stylesheets/spectaql.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.