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

Make SQuaSH REST API conforms to OpenAPI 3.0 specification

    XMLWordPrintable

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: squash
    • Labels:
      None

      Description

      Currently the SQuaSH REST API conforms to OpenAPI 2.0 specification using flasgger to extract the API specification from docstrings.

      In this ticket we want to use OpenAPI 3.0 and we'll probably write the spec ourselves instead of relying on flasgger.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-13035 Enable JWT authentication in Swagger UI

          • Invalid

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-12601 Implement flasgger for the SQuaSH REST API documentation

          • Done
          mentioned in

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            afausti Angelo Fausti created issue -
            afausti Angelo Fausti made changes -
            Field Original Value New Value
            Epic Link DM-14312 [ 63991 ]
            afausti Angelo Fausti made changes -
            Link This issue relates to DM-12601 [ DM-12601 ]
            afausti Angelo Fausti made changes -
            Risk Score 0
            afausti Angelo Fausti made changes -
            Link This issue relates to DM-13035 [ DM-13035 ]
            afausti Angelo Fausti made changes -
            Epic Link DM-14312 [ 63991 ] DM-5504 [ 23337 ]
            Hide
            Permalink
            afausti Angelo Fausti added a comment -

            This also means we need to configure the swagger interface an take the opportunity to change to a better theme https://github.com/ostranme/swagger-ui-themes

            Show
            afausti Angelo Fausti added a comment - This also means we need to configure the swagger interface an take the opportunity to change to a better theme https://github.com/ostranme/swagger-ui-themes
            Hide
            Permalink
            afausti Angelo Fausti added a comment -

            Also check https://github.com/OpenAPITools/openapi-generator or https://openapi-generator.tech/ for automatic client code generation.

            Show
            afausti Angelo Fausti added a comment - Also check https://github.com/OpenAPITools/openapi-generator or https://openapi-generator.tech/ for automatic client code generation.
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 34867 ]
            Hide
            Permalink
            tjenness Tim Jenness added a comment -

            Is this ticket still needed?

            Show
            tjenness Tim Jenness added a comment - Is this ticket still needed?

              People

              Assignee:
              afausti Angelo Fausti
              Reporter:
              afausti Angelo Fausti
              Watchers:
              Angelo Fausti, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.