VNFPerformanceManagement.yaml

openapi: 3.0.2

info:
  title: SOL003 - VNF Performance Management interface
  description: |
    SOL003 - VNF Performance Management interface

    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues

  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 003 V3.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.07.01_60/gs_NFV-SOL003v030701p.pdf

servers:
  - url: http://127.0.0.1/vnfpm/v2
  - url: https://127.0.0.1/vnfpm/v2


paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  /api-versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

  ###############################################################################
  # PM jobs                                                                     #
  ###############################################################################
  /pm_jobs:
    #SOL003 location: 6.4.2
    parameters:
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Accept
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
    post:
      description: |
        The POST method creates a PM job. See clause 6.4.2.3.1.
      parameters:
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreatePmJobRequest'
      responses:
        201:
          $ref: '#/components/responses/PmJobs.Post.201'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        422:
          $ref: '#/components/responses/PmJobs.Post.422'
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

    get:
      description: |
        The API consumer can use this method to retrieve information about PM jobs. See clause 6.4.2.3.2.
      parameters:
        - $ref: '#/components/parameters/filter_pm_jobs'
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/all_fields_vnfm
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/fields_vnfm
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/exclude_fields_vnfm
        - $ref: '#/components/parameters/exclude_default_pm_jobs'
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm
      responses:
        200:
          $ref: '#/components/responses/PmJobs.Get.200'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
  /pm_jobs/{pmJobId}:
    #SOL003 location: 6.4.3
    parameters:
      - $ref: '#/components/parameters/PmJobId'
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
    get:
      description: |
        The API consumer can use this method for reading an individual PM job. See clause 6.4.3.3.2.
      parameters:
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualPmJob.Get.200'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

    patch:
      description: |
        This method allows to modify an "Individual PM job" resource. See clause 6.4.3.3.4.
      parameters: 
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/If-Unmodified-Since
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/If-Match
      responses:
        200:
          $ref: '#/components/responses/IndividualPmJob.Patch.200'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        412:
          $ref: '#/components/responses/IndividualPmJob.Patch.412'
        422:
          $ref: '#/components/responses/IndividualPmJob.Patch.422'
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

    delete:
      description: |
        This method terminates an individual PM job. See clause 6.4.3.3.5.
      responses:
        204:
          $ref: '#/components/responses/IndividualPmJob.Delete.200'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"