Merge "CPS-723: Add Examples in the NCMP openapi"
authorNiamh Core <niamh.core@est.tech>
Tue, 7 Dec 2021 10:00:18 +0000 (10:00 +0000)
committerGerrit Code Review <gerrit@onap.org>
Tue, 7 Dec 2021 10:00:18 +0000 (10:00 +0000)
1  2 
cps-ncmp-rest/docs/openapi/ncmp.yml

@@@ -194,7 -194,14 +194,14 @@@ getResourceDataForPassthroughOperationa
        - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
      responses:
        200:
-         $ref: 'components.yaml#/components/responses/Ok'
+         description: OK
+         content:
+           application/json:
+             schema:
+               type: object
+             examples:
+               dataSampleResponse:
+                 $ref: 'components.yaml#/components/examples/dataSampleResponse'
        400:
          $ref: 'components.yaml#/components/responses/BadRequest'
        401:
@@@ -218,7 -225,14 +225,14 @@@ resourceDataForPassthroughRunning
        - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
      responses:
        200:
-         $ref: 'components.yaml#/components/responses/Ok'
+         description: OK
+         content:
+           application/json:
+             schema:
+               type: object
+             examples:
+               dataSampleResponse:
+                 $ref: 'components.yaml#/components/examples/dataSampleResponse'
        400:
          $ref: 'components.yaml#/components/responses/BadRequest'
        401:
          application/json:
            schema:
              type: string
+           examples:
+             dataSampleRequest:
+               $ref: 'components.yaml#/components/examples/dataSampleRequest'
          application/yang-data+json:
            schema:
              type: string
          application/json:
            schema:
              type: string
+           examples:
+             dataSampleRequest:
+               $ref: 'components.yaml#/components/examples/dataSampleRequest'
          application/yang-data+json:
            schema:
              type: string
          $ref: 'components.yaml#/components/responses/Forbidden'
        404:
          $ref: 'components.yaml#/components/responses/NotFound'
 +
 +  patch:
 +    tags:
 +      - network-cm-proxy
 +    summary: Patch resource data from pass-through running
 +    description: Patch resource data from pass-through running for the given cm handle
 +    operationId: patchResourceDataRunningForCmHandle
 +    parameters:
 +      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
 +      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
 +      - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
 +    requestBody:
 +      required: true
 +      content:
 +        application/json:
 +          schema:
 +            type: object
 +    responses:
 +      200:
 +        $ref: 'components.yaml#/components/responses/Ok'
 +      400:
 +        $ref: 'components.yaml#/components/responses/BadRequest'
 +      401:
 +        $ref: 'components.yaml#/components/responses/Unauthorized'
 +      403:
 +        $ref: 'components.yaml#/components/responses/Forbidden'
 +      404:
 +        $ref: 'components.yaml#/components/responses/NotFound'
  
  fetchModuleReferencesByCmHandle:
    get:
          content:
            application/json:
              schema:
-               type: string
-             example: [{"moduleName": "nc-notifications", "revision": "2008-07-14"}]
-         $ref: 'components.yaml#/components/responses/Ok'
+               type: object
+             examples:
+               moduleReferencesResponse:
+                 summary: Sample response
+                 value:
+                   - moduleName: my-module-name
+                     revision: yyyy-mm-dd
+                   - moduleName: my-module-name-2
+                     revision: yyyy-mm-dd
        400:
          $ref: 'components.yaml#/components/responses/BadRequest'
        401: