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

Implement flasgger for the SQuaSH REST API documentation

    Details

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

      Description

      After some research flasgger seems to be a good option for documenting the SQuaSH REST API based on Flask

      it conforms with the OpenAPI 2.0 specification and potentially will support OpenApi 3.0 soon.

        Attachments

          Issue Links

            Activity

            Hide
            afausti Angelo Fausti added a comment - - edited
            • Added flasgger package
            • Added Swagger configuration to the base config class
            • Added doc strings to the metric resource to test the API spec extracted by flasgger

            Flasgger provides an /apidocs resource that renders the Swagger UI, example

            :

            Show
            afausti Angelo Fausti added a comment - - edited Added flasgger package Added Swagger configuration to the base config class Added doc strings to the metric resource to test the API spec extracted by flasgger Flasgger provides an /apidocs resource that renders the Swagger UI, example :
            Show
            afausti Angelo Fausti added a comment - https://github.com/lsst-sqre/squash-rest-api/pull/2

              People

              • Assignee:
                afausti Angelo Fausti
                Reporter:
                afausti Angelo Fausti
                Watchers:
                Angelo Fausti, Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: