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

Update Open API YAML with data types and example for output

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Medium Medium
    • None
    • None
    • CPS-Core-REST

      Complete OPEN API documentation with output datatype examples.

      1. Deploy current OPEN API and see what is missing
      2. Investigate best practices (Open api 3) for this
      3. Quick proposal and agree with team 

      Scope

      • CPS (core) REST interface
        • cps-rest/docs/api/swagger
      • NCMP REST Interface
        • cps-ncmp-rest/docs/openapi  

      (Check why paths are different , if possible make them consistent in separate small commit)

       

      A/C 

      1. Output type and clear (but simple) example for each rest endpoint
      2. Demo

       

       

        1.
        		 Investigate differing paths & align (if possible) Sub-task Closed josephkeenan
        2.
        		 Create proposal for responses and data types to be reviewed by team Sub-task Closed puthuparambil.aditya
        3.
        		 Implement proposal for CpsAdmin and add to main branch Sub-task Closed josephkeenan
        4.
        		 Implement proposal for CpsData and add to main branch Sub-task Closed josephkeenan

            josephkeenan josephkeenan
            ToineSiebelink Toine Siebelink
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: