Commit 95ad2a8c authored by Samir Medjiah's avatar Samir Medjiah
Browse files

SOL005: Consolidation of common data types, endpoint parameters, and responses...

SOL005: Consolidation of common data types, endpoint parameters, and responses in VNF PM and NS LCM.
parent 0c4b6456
Loading
Loading
Loading
Loading
Loading
+54 −92
Original line number Diff line number Diff line
@@ -38,6 +38,20 @@ paths:
  ###############################################################################
  '/alarms':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Query alarms related to NS instances.
      description: >
@@ -78,19 +92,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -164,6 +165,19 @@ paths:
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Read individual alarm.
      description: >
@@ -183,19 +197,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -263,13 +264,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
@@ -280,12 +274,6 @@ paths:
          type: string
          enum:
            - application/merge-patch+json
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -342,6 +330,20 @@ paths:
  ##############################################################################
  '/subscriptions':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    post:
      summary: Subscribe to alarms related to NSs.
      description: >
@@ -362,13 +364,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
@@ -376,12 +371,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: body
          in: body
          required: true
@@ -475,13 +464,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
@@ -489,12 +471,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -571,6 +547,19 @@ paths:
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Read an individual subscription.
      description: >
@@ -587,13 +576,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
@@ -601,12 +583,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -659,20 +635,6 @@ paths:
        Terminate Subscription

        This method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
+66 −118
Original line number Diff line number Diff line
@@ -37,6 +37,20 @@ paths:
  ###############################################################################
  '/ns_instances':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string  
    post:
      summary: Create a NS instance resource.
      description: >
@@ -49,13 +63,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
@@ -63,12 +70,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: body
          in: body
          required: true
@@ -201,19 +202,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -290,6 +278,19 @@ paths:
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Read an individual NS instance resource.
      description: >
@@ -303,13 +304,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
@@ -317,12 +311,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -381,20 +369,6 @@ paths:
        Delete NS Identifier

        This method deletes an individual NS instance resource.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
@@ -492,7 +466,7 @@ paths:
            Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -567,7 +541,7 @@ paths:
            Parameters for the scale NS operation, as defined in clause 6.5.2.13.
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -641,7 +615,7 @@ paths:
            Parameters for the update NS operation, as defined in clause 6.5.2.11.
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -712,12 +686,12 @@ paths:
          in: body
          required: true
          schema:
            $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
          description: >
            Parameters for the heal NS operation, as defined in clause 6.5.2.12.
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -792,12 +766,12 @@ paths:
          in: body
          required: true
          schema:
            $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
          description: >
            The terminate NS request parameters, as defined in  clause 6.5.2.14.
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -1102,7 +1076,7 @@ paths:
          type: string
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -1163,7 +1137,7 @@ paths:
          type: string
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -1218,7 +1192,7 @@ paths:
          type: string
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -1394,14 +1368,14 @@ paths:
          in: body
          required: true
          schema:
            $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/CancelMode"
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CancelMode"
          description: >
            The POST request to this resource shall include a CancelMode
            structure in the payload body to choose between "graceful" and
            "forceful" cancellation.
      responses:
        202:
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty"
          $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
@@ -1426,6 +1400,20 @@ paths:
  ###############################################################################
  '/subscriptions':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.16
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    post:
      summary: Subscribe to NS lifecycle change notifications.
      description: >
@@ -1446,13 +1434,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
@@ -1460,12 +1441,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: body
          in: body
          required: true
@@ -1557,19 +1532,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -1641,6 +1603,19 @@ paths:
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Read an individual subscription resource.
      description: >
@@ -1655,19 +1630,6 @@ paths:
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
@@ -1720,20 +1682,6 @@ paths:
        The DELETE method terminates an individual subscription.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
+0 −191

File deleted.

Preview size limit exceeded, changes collapsed.

+700 −286

File changed.

Preview size limit exceeded, changes collapsed.

+0 −616

File deleted.

Preview size limit exceeded, changes collapsed.

Loading