Skip to content

Commit

Permalink
[docs] change HTTPS to HTTP in GraphQL API example (#17373)
Browse files Browse the repository at this point in the history
## Summary & Motivation
If I start up the example project locally with `dagster dev` and then
try to connect to the GraphQL endpoint with`gql` using the link in the
example, I get an `SSL_WRONG_VERSION` error. I also get this error if I
use `dagster_graphql.DagsterGraphQLClient` with `use_https=True`.

```
requests.exceptions.SSLError: HTTPSConnectionPool(host='127.0.0.1', port=3000): Max retries exceeded with url: /graphql (Caused by SSLError(SSLError(1, '[SSL: WRONG_VERSION_NUMBER] wrong version number (_ssl.c:992)')))
```

I figured out that the error means I'm trying to connect to something
that doesn't use HTTPS. Here's an example of someone explaining the
error:
psf/requests#5943 (comment)

## How I Tested These Changes

If I change the link to instead use HTTP, `gql` successfully connects
and queries the endpoint. `dagster_graphql.DagsterGraphQLClient` works
as expected if I set `use_https=False`.
  • Loading branch information
dwisdom-tk authored Dec 20, 2024
1 parent 917b7af commit 5831a6a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/content/concepts/webserver/graphql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The GraphQL API is served from the webserver. To start the server, run the follo
dagster dev
```

The webserver serves the GraphQL endpoint at the `/graphql` endpoint. If you are running the webserver locally on port 3000, you can access the API at <https://localhost:3000/graphql>.
The webserver serves the GraphQL endpoint at the `/graphql` endpoint. If you are running the webserver locally on port 3000, you can access the API at <http://localhost:3000/graphql>.

### Using the GraphQL playground

Expand Down

1 comment on commit 5831a6a

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for dagster-docs ready!

✅ Preview
https://dagster-docs-iebyyw3zf-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit 5831a6a.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.