VNFPackageManagement.yaml 102 KB
Newer Older
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageContent.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, this response shall be returned when
        a single consecutive byte range from the content of the VNF package file
        has been read successfully according to the request.
        The response body shall contain the requested part of the VNF package file.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
        The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualVnfPackageArtifacts.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the archive containing
        the artifact files has been read successfully.
        The message content shall be a ZIP archive containing the requested
        set of artifacts selected according to the provisions specified above
        in this clause, and, if the flag "include_signatures" was provided in
        the related request, the applicable signature files and, if available,
        the separate certificate files from the VNF package.
        The "Content-Type" HTTP header shall be set to "application/zip".
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            The "Content-Type" HTTP header shall be set according to the
            content type of the artifact file. If the content type cannot
            be determined, the header shall be set to the value
            "application/octet-stream".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualVnfPackageArtifact.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests and the "include_signatures" request URI parameter was not
        present in the related request, this response shall be returned when a single consecutive byte range from
        the content of the artifact file has been read successfully according to the request.
        The response body shall contain the requested part of the artifact file from the VNF package, as defined
        by ETSI GS NFV-SOL 004.
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the
        content type cannot be determined, the header shall be set to the value "application/octet-stream".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualVnfPackageArtifacts.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, this response shall be returned
        when a single consecutive byte range from the content of the archive
        that would have been returned in a "200 OK" response has been read
        successfully according to the request.
        The response body shall contain the requested part of the archive.
        The "Content-Type" HTTP header shall be set to "application/zip".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
            The "Content-Type" HTTP header shall be set according to the
            content type of the artifact file. If the content type cannot
            be determined, the header shall be set to the value
            "application/octet-stream".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifacts.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the archive containing
        the artifact files has been read successfully.
        The message content shall be a ZIP archive containing the requested
        set of artifacts selected according to the provisions specified above
        in this clause, and, if the flag "include_signatures" was provided in
        the related request, the applicable signature files and, if available,
        the separate certificate files from the VNF package.
        The "Content-Type" HTTP header shall be set to "application/zip".
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            The "Content-Type" HTTP header shall be set according to the
            content type of the artifact file. If the content type cannot
            be determined, the header shall be set to the value
            "application/octet-stream".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifacts.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, this response shall be returned
        when a single consecutive byte range from the content of the archive
        that would have been returned in a "200 OK" response has been read
        successfully according to the request.
        The response body shall contain the requested part of the archive.
        The "Content-Type" HTTP header shall be set to "application/zip".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
            The "Content-Type" HTTP header shall be set according to the
            content type of the artifact file. If the content type cannot
            be determined, the header shall be set to the value
            "application/octet-stream".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifact.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the artifact file has
        been read successfully.

        If the "include_signatures" request URI parameter was not provided in
        the related request, the message content shall contain a copy of the artifact
        file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type"
        HTTP header shall be set according to the content type of the artifact file.
        If the artifact is encrypted, the header shall be set to the value "application/cms"
        (IETF RFC 7193). If the content type cannot be determined, the header shall be set
        to the value "application/octet-stream".

        If the "include_signatures" request URI parameter was provided in the related request,
        the "Content-Type" HTTP header shall be set to "application/zip and the messgae content
        shall contain a ZIP archive which includes:
        •	a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004;
        •	the related security information (individual signature file and optional related
            individual certificate file).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            The "Content-Type" HTTP header shall be set according to the
            content type of the artifact file. If the content type cannot
            be determined, the header shall be set to the value
            "application/octet-stream".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifact.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests and the "include_signatures" request URI parameter was not present 
        in the related request, this response shall be returned when a single consecutive byte range from the 
        content of the artifact file has been read successfully according to the request.
        The response body shall contain the requested part of the artifact file from the VNF package, as defined 
        by ETSI GS NFV-SOL 004.
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the 
        content type cannot be determined, the header shall be set to the value "application/octet-stream".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Content-Range:
          required : true
          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
        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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    Subscriptions.Post.201:
      description: |
        201 CREATED

        Shall be returned when 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 resource.
      headers:
        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 PM Job
          style: simple
          explode: false
          schema:
            type: string
            format: url
        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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
    Subscriptions.Post.303:
      description: |
        303 See Other

        Shall be returned when a subscription with the
        same callback URI and the same filter already
        exists and the policy of the NFVO is to not create
        redundant subscriptions.
        The HTTP response shall include a "Location"
        HTTP header that contains the resource URI of
        the existing "Individual subscription" resource.
        The response body shall be empty.
      headers:
        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 PM Job
          style: simple
          explode: false
          schema:
            type: string
            format: url
        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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content
        is supported and the  message content of a request contains syntactically correct
        data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI
        GS NFV-SOL 013, including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has
        tested the Notification endpoint as described in clause 10.4.9.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more
        information about the error.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
Ayesha Ayub's avatar
Ayesha Ayub committed
            $ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
    Subscriptions.Get.200:
      description: |
        200 OK

        Shall be returned when 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 VNF package management subscriptions as defined in clause 10.5.2.4.
        If the "filter" URI parameter was supplied in the request, the data in the response
        body shall have been transformed according to the rules specified in clause 5.2.2
        of ETSI GS NFV-SOL 013
        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:
        Content-Type:
          description: The MIME type of the body of the response.
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"

    IndividualSubscription.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual subscription has been read successfully.
        The response body shall contain a representation of the "Individual subscription" resource.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"

    IndividualSubscription.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the "Individual subscription" resource has been deleted successfully.
      headers:
        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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string