VNFLifecycleManagement.yaml 99.3 KB
Newer Older
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    VnfLcmOpOccFail.Post:
      description: |
        200 OK
        The state of the VNF lifecycle management operation occurrence has  been changed successfully. The response
        shall include a representation of the "Individual VNF lifecycle operation occurrence" resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
            $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc

    VnfLcmOpOccCancel.Post:
      description: |
        202 ACCEPTED
        The request has been accepted for processing, but processing has not  been completed. The response shall
        have an empty payload body.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    Subscriptions.Get:
      description: |
        200 OK
        The list of subscriptions has been queried successfully. The response body shall contain in an array the
        representations of all active subscriptions of the functional block that invokes the method, i.e. zero or
        more representations of lifecycle change notification subscriptions as defined in clause 5.5.2.16.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription

    Subscriptions.Post:
      description: |
        201 CREATED
        The subscription has been created successfully. The response body shall contain a representation of the
        created "Individual subscription" resource. The HTTP response shall include a "Location" HTTP header that points
        to the created "Individual subscription" resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: The resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription

    IndividualSubscription.Get:
      description: |
        200 OK
        The operation has completed successfully. The response body shall contain a representation of the
        "Individual subscription" resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription

    IndividualSubscription.Delete:
      description: |
        204 NO CONTENT
        The "Individual subscription" resource has been deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    VnfInstanceCreateSnapshot.Post:
      description: |
        202 ACCEPTED
        Shall be returned when the request was accepted for processing, but the processing has not been completed.
        The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI
        of the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            Used in redirection, or when a new resource has been created. This header field shall be present if the
            response status code is 201 or 3xx. In the present document this header field is also used if the response
            status code is 202 and a new resource was created.
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content: {}

    VnfInstanceRevertToSnapshot.Post:
      description: |
        202 ACCEPTED
        Shall be returned when the request was accepted for processing, but the processing has not been completed.
        The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI
        of the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            Used in redirection, or when a new resource has been created. This header field shall be present if the
            response status code is 201 or 3xx. In the present document this header field is also used if the response
            status code is 202 and a new resource was created.
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content: {}

    VnfSnapshots.Post:
      description: |
        202 CREATED
        Shall be returned when an individual VNF snapshot resource has been created successfully.
        The response body shall contain a representation of the new individual VNF snapshot resource, as defined in
        clause 5.5.2.21. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
        individual VNF snapshot resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            Used in redirection, or when a new resource has been created. This header field shall be present if the
            response status code is 201 or 3xx. In the present document this header field is also used if the response
            status code is 202 and a new resource was created.
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo

    VnfSnapshots.Get:
      description: |
        200 OK
        Shall be returned when information about zero or more VNF snapshots was queried successfully.
        The response body shall contain in an array the representations of zero or more individual VNF
        snapshot resources, as defined in clause 5.5.2.21.

        If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
        for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
        in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo

    IndividualVnfSnapshot.Get:
      description: |
        Shall be returned when information about an individual VNF snapshot was read successfully.
        The response body shall contain a representation of the individual VNF snapshot resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo

    IndividualVnfSnapshot.Delete:
      description: |
        204 NO CONTENT
        The "Individual subscription" resource has been deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
      content: {}