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

2914 graphql api documentation #3065

Merged
merged 12 commits into from
Dec 20, 2023
Merged

Conversation

martmull
Copy link
Contributor

@martmull martmull commented Dec 18, 2023

close #2914

  • synchronise graphql playground theme with Twenty doc theme
  • fixing api key form dark theme
  • remove useless call to generate api key in open-api schema
  • fix nodes in open-api components
  • split docs code into components
  • adding api key form in /graphql playground
image
  • load schema using api key and fill authorization headers
image

@martmull martmull force-pushed the 2914-graphql-api-documentation branch from 20e1253 to fb6f0c7 Compare December 18, 2023 17:43
@martmull martmull marked this pull request as ready for review December 18, 2023 17:44
@martmull martmull force-pushed the 2914-graphql-api-documentation branch 3 times, most recently from 73e7b69 to 0a8193d Compare December 18, 2023 21:14
@charlesBochet
Copy link
Member

Unrelated to your PR, but do you know why on docs.twenty.com (or localhost:5001/graphql), we are missing an option:
image

vs on api.twenty.com/graphql (or localhost:3000/graphql)
image

This is actually the most useful one option

@charlesBochet
Copy link
Member

charlesBochet commented Dec 19, 2023

I don't have exactly the same product behavior on /api-graphql
image

vs /rest-api
image

The field is slightly smaller on graphql one. Also, we have a focus on graphql but not on rest-api.

Lastly, it would be great to not lose the focus when we type in the field (most users will copy paste anyway but if you want to fix typos it's a bit annoying)

Copy link
Member

@charlesBochet charlesBochet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @martmull, looks great! I have left a few comments / questions

@martmull
Copy link
Contributor Author

Fixed all your comments. I have created a ticket for the graphiql explorer plugin -> #3087

@charlesBochet charlesBochet self-assigned this Dec 20, 2023
Copy link
Member

@charlesBochet charlesBochet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@charlesBochet charlesBochet merged commit ed7bd0b into main Dec 20, 2023
14 checks passed
@charlesBochet charlesBochet deleted the 2914-graphql-api-documentation branch December 20, 2023 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GraphQL API documentation
2 participants