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

Make SQuaSH REST API conforms to OpenAPI 3.0 specification

    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

            Activity

            Hide
            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
            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.

              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:

                  Summary Panel