VNFPerformanceManagement.yaml 46.4 KB
Newer Older
    IndividualThreshold.Get.200:
      description: |
        200 OK
        Shall be returned when information about an individual threshold  has been queried successfully.
        The response body shall contain a representation of the threshold.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
            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
        ETag:
          description: >
            Used to provide the current entity-tag for the selected resource representation. It can be sent in
            "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
        Last-Modified:
          description: >
            Used to provide a timestamp indicating the date and time at which the server believes the selected resource
            representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
            format: date-time
      content:
        application/json:
          schema:
            $ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/Threshold
    IndividualThreshold.Delete.204:
      description: |
        204 NO CONTENT
        Shall be returned when the threshold was 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: {}
    IndividualThreshold.Patch.200:
      description: |
        200 OK
        Shall be returned when the request has been processed successfully. The response body shall contain a data
        structure of type "ThresholdModifications".
      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
        ETag:
          description: >
            Used to provide the current entity-tag for the selected resource representation. It can be sent in
            "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
        Last-Modified:
          description: >
            Used to provide a timestamp indicating the date and time at which the server believes the selected resource
            representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
            format: date-time
      content:
        application/json:
          schema:
            $ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications
        
    IndividualThreshold.Patch.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 [6], 
        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 VNFM has 
        tested the Notification endpoint as described in clause 6.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:
        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: Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"