Uploaded image for project: 'Configuration Persistence Service'
  1. Configuration Persistence Service
  2. CPS-514

Investigate the approach of generating Swagger documentation using openapi.yml instead of code

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Not Done
    • Icon: Medium Medium
    • Istanbul Release
    • None
    • CPS-Core
    • None

      Initially swagger document was getting generated from the deployed code. But, we decided to generate documentation from openapi.yml instead of code generated from openapi.yml. It gives flexibility and code and documentation are decoupled. 

      We still need to figure out

      1. how to add ncmp documentation in the swagger-ui.
      2. how to expose the openapi.yml for swagger-ui to use - we have moved the openapi.yml to the resources/static folder which spring automatically adds to the webserver. This approach needs to be discussed and alternatives should be evaluated. 

            Unassigned Unassigned
            renukumari renukumari
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: