Details
-
Type:
Story
-
Status: Invalid
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: squash
-
Labels:None
-
Story Points:1.4
-
Epic Link:
-
Team:SQuaRE
Description
There are two problems here:
flasgger extracts the OpenAPI specs from the doc strings but since the /auth resource is created automatically by the flask-jwt package there's no place to add the doc strings.
We could append that later in the OpenAPI spec generated by flasgger but Bearer Authentication is introduced only in OpenAPI 3.0 which is not supported by flasgger yet.
https://swagger.io/docs/specification/authentication/bearer-authentication/
This suggests we should perhaps write the OpenAPI 3.0 specification for the SQuaSH RESTful API and try the Swagger UI v3 in order to add the JWT token in the authorization headers.
Attachments
Issue Links
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link |
|
| Status | To Do [ 10001 ] | In Progress [ 3 ] |
| Summary | Add authorization header in the OpenAPI specification / Swagger UI | Add jwt /auth endpoint in the OpenAPI specification |
| Summary | Add jwt /auth endpoint in the OpenAPI specification | Enable JWT authentication in Swagger UI |
| Description | The {{/auth}} resource is created automatically by the {{flask-jwt}} package so there's no place to add the doc strings with the OpenAPI specifications that are extracted by {{flasgger}} and therefore the {{/auth}} does not show up in the Swagger UI. |
There are two problems here: {{flasgger}} extracts the OpenAPI specs from the doc strings but since the {{/auth}} resource is created automatically by the {{flask-jwt}} package there's no place to add the doc strings. We could append that later in the OpenAPI spec generated by {{flasgger}} but Bearer Authentication is introduced only in OpenAPI 3.0 which is not supported by {{flasgger}} yet. https://swagger.io/docs/specification/authentication/bearer-authentication/ This suggests we should perhaps write the OpenAPI 3.0 specification for the SQuaSH RESTful API and try the Swagger UI v3 in order to add the JWT token in the authorization headers. |
| Status | In Progress [ 3 ] | To Do [ 10001 ] |
| Component/s | squash [ 14169 ] |
| Risk Score | 0 |
| Description |
There are two problems here: {{flasgger}} extracts the OpenAPI specs from the doc strings but since the {{/auth}} resource is created automatically by the {{flask-jwt}} package there's no place to add the doc strings. We could append that later in the OpenAPI spec generated by {{flasgger}} but Bearer Authentication is introduced only in OpenAPI 3.0 which is not supported by {{flasgger}} yet. https://swagger.io/docs/specification/authentication/bearer-authentication/ This suggests we should perhaps write the OpenAPI 3.0 specification for the SQuaSH RESTful API and try the Swagger UI v3 in order to add the JWT token in the authorization headers. |
There are two problems here:
{{flasgger}} extracts the OpenAPI specs from the doc strings but since the {{/auth}} resource is created automatically by the {{flask-jwt}} package there's no place to add the doc strings. We could append that later in the OpenAPI spec generated by {{flasgger}} but Bearer Authentication is introduced only in OpenAPI 3.0 which is not supported by {{flasgger}} yet. https://swagger.io/docs/specification/authentication/bearer-authentication/ This suggests we should perhaps write the OpenAPI 3.0 specification for the SQuaSH RESTful API and try the Swagger UI v3 in order to add the JWT token in the authorization headers. |
| Remote Link | This issue links to "Page (Confluence)" [ 32808 ] |
Superseded by DM-34629. FastAPI adds OpenAPI 3.0 specification.
| Resolution | Done [ 10000 ] | |
| Status | To Do [ 10001 ] | Invalid [ 11005 ] |
Moved to To Do won't work on this issue for now.