Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-13035

Enable JWT authentication in Swagger UI

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Invalid
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: squash
    • Labels:
      None

      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

            Hide
            afausti Angelo Fausti added a comment -

            Moved to To Do won't work on this issue for now.

            Show
            afausti Angelo Fausti added a comment - Moved to To Do won't work on this issue for now.
            Hide
            afausti Angelo Fausti added a comment -

            Superseded by DM-34629. FastAPI adds OpenAPI 3.0 specification.

            Show
            afausti Angelo Fausti added a comment - Superseded by DM-34629 . FastAPI adds OpenAPI 3.0 specification.

              People

              Assignee:
              afausti Angelo Fausti
              Reporter:
              afausti Angelo Fausti
              Watchers:
              Angelo Fausti
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.