Skip to content
VNFPackageManagement.yaml 54.2 KiB
Newer Older
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig

    IndividualVnfPackageExtArtifacts.Put.202:
      description: |
        202 ACCEPTED
      headers:
        Version:
          description: |
            Version of the API used in 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
        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 NS instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content: {}

    IndividualVnfPackageManifest.Get:
      description: |
        200 OK
        Shall be returned when the content of the manifest has been read successfully. If the "include_signatures" URI
        query parameter was absent in the request, or if the manifest file has all security-related information embedded
        (i.e. there is no separate certificate file), the payload body shall contain a copy of the manifest file of the
        VNF package, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI
        query parameter was present in the related request and the manifest file does not have all the security-related
        information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to
        "application/zip and the payload body shall contain a ZIP archive which includes: - a copy of the manifest file
        of the VNF package - a copy of the related individual certificate file.
      headers:
        Version:
          description: |
            Version of the API used in 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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageContent.Get:
      description: |
        200 OK
        Shall be returned when the whole content of the VNF package file has been read successfully. The response body
        shall include a copy of the VNF package file. The "Content-Type" HTTP header shall be set according to the type
        of the file, i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
      headers:
        Version:
          description: |
            Version of the API used in 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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageContent.Put:
      description: |
        202 ACCEPTED
        Shall be returned when the VNF package has been accepted for uploading, but the processing has not been completed.
        It is expected to take some time for processing. The response body shall be empty. See note.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageArtifacts.Get:
      description: |
        200 OK
        Shall be returned when the whole content of the archive containing the artifact files has been read successfully.
        The payload body 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:
        Version:
          description: |
            Version of the API used in 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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageUploadFromUri.Post:
      description: |
        202 Accepted
        The information about the VNF package has been received successfully, but the on-boarding has not been completed.
        It is expected to take some time for processing. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackageArtifact.Get:
      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 payload body shall
        contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5], 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 [17]). 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 "ContentType"
        HTTP header shall be set to "application/zip" and the payload body 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 [5];
        - the related security information (individual signature file and optional related individual certificate file).
      headers:
        Version:
          description: |
            Version of the API used in 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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    VnfPkgSubscriptions.Get:
      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 9.5.2.7.
        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 NFVO 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: |
            Version of the API used in 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
        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/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription

    VnfPkgSubscriptions.Post:
      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:
        Version:
          description: |
            Version of the API used in 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
        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/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription

    VnfPkgSubscription.Get:
      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:
        Version:
          description: |
            Version of the API used in 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
        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/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription

    VnfPkgSubscription.Delete:
      description: |
        No Content
        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:
        Version:
          description: |
            Version of the API used in 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
      content: {}