docs: point to additional i in GraphiQL URL [ci skip] #5825
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
t2gran
reviewed
May 2, 2024
| @@ -11,7 +11,7 @@ makes it easy to use this API in a Java application. | |||
| ## URLs | |||
| - GraphQL endpoint: [`http://localhost:8080/otp/gtfs/v1`](http://localhost:8080/otp/gtfs/v1) | |||
| - HTML schema documentation: [https://docs.opentripplanner.org/api/dev-2.x/graphql-gtfs/](https://docs.opentripplanner.org/api/dev-2.x/graphql-gtfs/) | |||
| - Built-in visual GraphQL client: [http://localhost:8080/graphiql](http://localhost:8080/graphiql) | |||
| - Built-in visual GraphQL client: [http://localhost:8080/graphiql](http://localhost:8080/graphiql) (note the additional `i`!) | |||
There was a problem hiding this comment.
Maybe we should change this and not have the product name in the URL (graphiql) is the name of the library used. It is common, and people how have worked with GraphQL might expect it to be like this, but manybe it is better to use /query-ui or something like that.
There was a problem hiding this comment.
Yes, that's probably an ever better idea.
There was a problem hiding this comment.
We discussed this in the dev meeting today and decided just to merge it. Using a product name in the url is at least a bit unfortunate, but also kind of a de facto standard.
leonardehrenfried
changed the title
leonardehrenfried
approved these changes
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
It is possible to misread the
/graphiqlURL as/graphql, see #5824. This change adds an additional hint to the documentation reader.Closes #5824