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

On GraphQL/REST API docs, introduce a dropdown to pick known servers #5156

Closed
charlesBochet opened this issue Apr 24, 2024 · 2 comments · Fixed by #5204
Closed

On GraphQL/REST API docs, introduce a dropdown to pick known servers #5156

charlesBochet opened this issue Apr 24, 2024 · 2 comments · Fixed by #5204

Comments

@charlesBochet
Copy link
Member

charlesBochet commented Apr 24, 2024

Scope & Context

Improve the UX of GraphQL and REST APIs documentation.

Current behavior

Right now if you browse: https://docs.twenty.com/rest-api/core#/ or https://docs.twenty.com/graphql/core, you have the option to set your server URL.
The server URL is prefilled with the api.twenty.com production URL.

image

Expected behavior

We would like to have:

  • a dropdown with "Production API" / "Demo API" / "Localhost" / "Other". (default Production API)
  • a text input: filled with 'api.twenty.com' / 'api-demo.twenty.com' / 'localhost:3000' / ''. The text input should be disabled if something else than Other is selected in the dropdown.
@charlesBochet
Copy link
Member Author

@Bonapara FYI, if you want to have a different approach

@Bonapara
Copy link
Member

LGTM!

Weiko pushed a commit that referenced this issue Apr 29, 2024
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Product development ✅ Apr 29, 2024
arnavsaxena17 pushed a commit to arnavsaxena17/twenty that referenced this issue Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants
@charlesBochet @Bonapara and others