NFVManoPerformanceManagement.yaml 43.4 KB
Newer Older

        The NFV-MANO functional entity shall support receiving this parameter 
        as part of the URI query string. The API consumer may supply this 
        parameter. 

        All attribute names that appear in the PmJob  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    filter.Threshold :
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of 
        ETSI GS NFV-SOL 013. 

        The NFV-MANO functional entity shall support receiving this parameter 
        as part of the URI query string. The API consumer may supply this 
        parameter. 

        All attribute names that appear in the Threshold  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    exclude_default.PmJob :
      name: exclude_default
      description: >
        Indicates to exclude the following complex attributes from the 
        response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
        The NFV-MANO functional entity shall support this parameter.

        The following attributes shall be excluded from the PmJob 
        structure in the response body if this parameter is provided, or none of 
        the parameters "all_fields," "fields", "exclude_fields", "exclude_default" 
        are provided:
Giacomo Bernini's avatar
Giacomo Bernini committed
        - reports
      in: query
      required: false
      schema:
        type: string

    pmJobId:
      name: pmJobId
      in: path
      description: >-
Francesca Moscatelli's avatar
Francesca Moscatelli committed
        Identifier of the PM Job. This identifier can be retrieved from the resource 
        referenced by the "Location" HTTP header in the response to a POST request 
        creating a new PM job resource. It can also be retrieved from the "id" attribute 
        in the message content of that response.
      required: true
      schema:
        $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'

    reportId:
      name: reportId
      in: path
      description: >-
        Identifier of the PM report
      required: true
      schema:
        $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'

    thresholdId:
      name: thresholdId
      in: path
      description: >-
Francesca Moscatelli's avatar
Francesca Moscatelli committed
        Identifier of the threshold. This identifier can be retrieved from the resource 
        referenced by the "Location" HTTP header in the response to a POST request creating 
        a new threshold resource. It can also be retrieved from the "id" attribute in the 
        message content of that response.
      required: true
      schema:
        $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'

  requestBodies:
    CreatePMJobRequest:
      description: >
        PM job creation request.
      content:
        application/json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
            $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/CreatePmJobRequest"
Muhammad Hamza's avatar
Muhammad Hamza committed
    CreateThresholdRequest:
      description: >
        Request parameters to create a threshold. 
      content:
        application/json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
            $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/CreateThresholdRequest"
      required: true

    ThresholdModificationRequest:
      description: >
        Parameters for the threshold modification.

        The Content-Type header shall be set to "application/merge-patch+json"
        according to IETF RFC 7396.
      content:
        application/merge-patch+json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
            $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/ThresholdModifications"
      required: true

    PmJobModificationRequest:
      description: >
        Parameters for the PM job modification.

        The Content-Type header shall be set to "application/merge-patch+json"
        according to IETF RFC 7396.
      content:
        application/merge-patch+json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
            $ref: "./components/NFVManoPerformanceManagement_def.yaml#/components/schemas/PmJobModifications"
      required: true