Add basic index route #179
Conversation
app/openapi.generated.yml
Outdated
| responses: | ||
| '200': | ||
| content: | ||
| application/json: |
There was a problem hiding this comment.
weird, why did apiflask generate this as application/json? is it a bug/unsupported functionality in apiflask or did we need to configure something?
There was a problem hiding this comment.
I saw this and was wondering the same thing. I'll take a look at the documentation and see why it did that.
There was a problem hiding this comment.
Having looked at how the generation works before, you'll need to look in apispec: https://apispec.readthedocs.io/en/latest/ as it is what generates the schema
Alternatively, do you think it would make sense to not include this in the schema? I'm not sure about when you define a route directly, but if you make an APIBlueprint, you should be able to pass in enable_openapi=False and it shouldn't be a part of Openapi.
That's a good point. I will add a screenshot. I can also add a quick test in |
app/openapi.generated.yml
Outdated
| responses: | ||
| '200': | ||
| content: | ||
| application/json: |
There was a problem hiding this comment.
Having looked at how the generation works before, you'll need to look in apispec: https://apispec.readthedocs.io/en/latest/ as it is what generates the schema
Alternatively, do you think it would make sense to not include this in the schema? I'm not sure about when you define a route directly, but if you make an APIBlueprint, you should be able to pass in enable_openapi=False and it shouldn't be a part of Openapi.
| @@ -0,0 +1,3 @@ | |||
| def test_get_index_200(client): | |||
| response = client.get("/") | |||
| assert response.status_code == 200 | |||
There was a problem hiding this comment.
Could you add a quick check that the HTML is right? At least that the response body has some of the text?
i support excluding this endpoint from the schema if it's easy to do. i really don't care what this endpoint returns, just that it's a 200, since the infra e2e tests assume that the index page returns something |
Ticket
Resolves #177
Changes
Added and index route with basic html including a link to the swagger docs endpoint
Context for reviewers
Previously the index route returned a 404 causing issues with e2e tests.
Testing
Added
app/tests/src/route/test_index_route.pyScreenshots