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

Rename Server::endpoint to Server::graphql_path #1606

Closed
abernix opened this issue Aug 25, 2022 · 1 comment · Fixed by #1609
Closed

Rename Server::endpoint to Server::graphql_path #1606

abernix opened this issue Aug 25, 2022 · 1 comment · Fixed by #1609
Assignees

Comments

@abernix
Copy link
Member

abernix commented Aug 25, 2022

Today, we have endpoint in our server configuration of our YAML. Its default value is /. You might set it to something like /my-graphql-endpoint.

The team is not convinced that / or /graphql or /my/graphql/endpoint are actually "endpoint"s without the rest of the scheme, host, port, prefix. In other words, a full URL.

Rename this to graphql_path since that more accurately defines what it is.

@abernix abernix added this to the v1.0.0-alpha.0 milestone Aug 25, 2022
@abernix abernix self-assigned this Aug 25, 2022
@garypen
Copy link
Contributor

garypen commented Aug 25, 2022

also: see: #1500 for broader concerns.

garypen added a commit that referenced this issue Aug 25, 2022
This introduces three new top-level configuration groupings:

 - Listeners (currently only 1 for data, but will add admin support)
 - Paths (health, graphql)
 - GraphqQL (introspection, experimental_defer, experimental_recursion)

and retains the existing Server configuration.
 - Server (cors, sandbox)

The purpose of the grouping is to be functional in nature. Clearly,
plugins don't fit in with this, but that's one for the future...

Various configuration options are extracted from Server into these new
groupings. The purpose of the new groups

Some renaming is done as well, e.g.: landing_page -> sandbox, endpoint
-> graphql

The docs are mainly modified, but I would like to re-structure them a
bit to reflect this grouping.

I'm aware that this goes way beyond the remit of 1606, but I figured I
may as well do some tidying up now, since the current situation is far
from ideal.

fixes: #1606
abernix added a commit that referenced this issue Aug 25, 2022
This more accurately represents the behavior of the option which changes the
path at which your Router will respond to GraphQL requests.

The previous name gave the impression that it might be the full "endpoint"
which it was not (again, just a path!)

Closes #1606
o0Ignition0o pushed a commit that referenced this issue Aug 26, 2022
This more accurately represents the behavior of the option which changes the
path at which your Router will respond to GraphQL requests.

The previous name gave the impression that it might be the full "endpoint"
which it was not (again, just a path!)

Closes #1606

Co-authored-by: Gary Pennington <gary@apollographql.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants