NFVManoFaultManagement.yaml

openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  title: SOL009 - NFV-MANO Fault Management interface
  description: >
    SOL009 - NFV-MANO Fault 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/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
  description: ETSI GS NFV-SOL 009 V0.8.0
  url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL009ed331_MANO_mgmt_stage_3/NFV-SOL009ed331v080.zip

servers:
  - url: http://127.0.0.1/nfvmanofm/v1
  - url: https://127.0.0.1/nfvmanofm/v1

paths:
  /api_versions:
    $ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
  /alarms:
    get:
      description: >
        Get Alarm List. The client can use this method to retrieve information
        about the alarm list. This method shall follow the provisions specified
        in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - 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. The following attribute names
            shall be supported by the NFV-MANO functional entity in the
            attribute-based filtering expression: id, managedObjectId,
            eventType, perceivedSeverity, probableCause.
          in: query
          required: false
          schema:
            type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged resource. Shall be
            supported by the NFV-MANO functional entity if the entity supports
            alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS
            NFV-SOL 013 for this resource.
          in: query
          required: false
          schema:
            type: string
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      responses:
        "200":
          description: >
            200 OK

            Shall be returned when information about zero or more alarms has been queried successfully.
            The response body shall contain in an array the representations of zero or more alarms as defined
            in clause 7.6.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 NFV-MANO functional entity 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 request. Reference: IETF RFC
                7231
              schema:
                type: string
                minimum: 1
                maximum: 1
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                minimum: 1
                maximum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present
                document.
              schema:
                type: string
                minimum: 0
                maximum: 1
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/Alarm
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504
  "/alarms/{alarmId}":
    parameters:
      - name: alarmId
        description: >
          Identifier of the alarm. This identifier can be retrieved from the
          "id" attribute of the "alarm" attribute in the AlarmNotification or
          AlarmClearedNotification. It can also be retrieved from the "id"
          attribute of the applicable array element in the payload body of the
          response to a GET request to the "Alarms" resource.
        in: path
        required: true
        schema:
          type: string
    get:
      description: >
        The client can use this method to read an individual alarm. This method
        shall follow the provisions specified in the tables 7.5.4.3.2-1 and
        7.5.4.3.2-2 for URI query parameters, request and response data
        structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      responses:
        "200":
          description: >
            200 OK

            Shall be returned when information about an individual alarm has been read successfully. The response body
            shall contain a representation of the individual alarm
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request. Reference: IETF RFC
                7231
              schema:
                type: string
                minimum: 1
                maximum: 1
          content:
            application/json:
              schema:
                $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/Alarm
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504
    patch:
      description: >
        This method modifies an "Individual alarm" resource. This method shall
        follow the provisions specified in the tables 7.5.4.3.4-1 and
        7.5.4.3.4-2 for URI query parameters, request and response data
        structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to IETF RFC 7396.
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/merge-patch+json
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/AlarmModifications
        description: >
          The parameter for the alarm modification, as defined in clause
          7.6.2.8. The Content-Type header shall be set to
          "application/merge-patch+json" according to IETF RFC 7396.
        required: true
      responses:
        "200":
          description: >
            200 OK

            Shall be returned when the request has been accepted and completed. ì The response body shall contain
            attribute modifications for an "Individual alarm" resource (see clause 7.6.2.4).
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request. Reference: IETF RFC
                7231
              schema:
                type: string
                minimum: 1
                maximum: 1
            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.
              schema:
                type: string
                minimum: 0
                maximum: 1
          content:
            application/json:
              schema:
                $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/AlarmModifications
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "409":
          $ref: ../responses/SOL009_resp.yaml#/responses/409
        "412":
          $ref: ../responses/SOL009_resp.yaml#/responses/412
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504
  /subscriptions:
    post:
      description: >
        Subscribe. The POST method creates a new subscription. This method shall
        follow the provisions specified in the tables 7.5.5.3.1-1 and
        7.5.5.3.1-2 for URI query parameters, request and response data
        structures, and response codes. As the result of successfully executing
        this method, a new "Individual subscription" resource as defined in
        clause 7.5.6 shall have been created. This method shall not trigger any
        notification. Creation of two "Individual subscription" resources with
        the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the API
        consumer, and might make sense only in very rare use cases.
        Consequently, the NFV-MANO functional entity may either allow creating a
        new "Individual subscription" resource if another "Individual
        subscription" resource with the same filter and callbackUri already
        exists (in which case it shall return the "201 Created" response code),
        or may decide to not create a duplicate "Individual subscription"
        resource (in which case it shall return a "303 See Other" response code
        referencing the existing "Individual subscription" resource with the
        same filter and callbackUri).
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/FmSubscriptionRequest
        description: >
          Details of the subscription to be created, as defined in clause
          7.6.2.2.
        required: true
      responses:
        "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 "Individual subscription" resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request. Reference: IETF RFC
                7231
              schema:
                type: string
                minimum: 1
                maximum: 1
            Location:
              description: |
                The resource URI of the created subscription resource.
              schema:
                type: string
                format: url
                minimum: 1
                maximum: 1
            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.
              schema:
                type: string
                minimum: 0
                maximum: 1
          content:
            application/json:
              schema:
                $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/FmSubscription
        "303":
          $ref: ../responses/SOL009_resp.yaml#/responses/303
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504
    get:
      description: >
        Query Subscription Information

        The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. This method
        shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          schema:
            type: string
        - 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 FmSubscription and in data types referenced from it shall be
            supported by the NFV-MANO functional entity in the filter
            expression.
          in: query
          required: false
          schema:
            type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be
            supported by the NFV-MANO functional entity if the entity supports
            alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS
            NFV-SOL 013 for this resource.
          in: query
          required: false
          schema:
            type: string
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      responses:
        "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 FM subscriptions as defined in clause 7.6.2.3. 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 NFV-MANO
            functional entity 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 request. Reference: IETF RFC
                7231
              schema:
                type: string
                minimum: 1
                maximum: 1
            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.
              schema:
                type: string
                minimum: 0
                maximum: 1
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                minimum: 1
                maximum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present
                document, see clause 4.7.2.1.
              schema:
                type: string
                minimum: 0
                maximum: 1
          content:
            application/json:
              schema:
                $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/FmSubscription
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504
  "/subscriptions/{subscriptionId}":
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the response
          to a POST request creating a new "Individual subscription" resource.
          It can also be retrieved from the "id" attribute in the payload body
          of that response.
        in: path
        required: true
        schema:
          type: string
    get:
      description: >
        Query Subscription Information. The client can use this method for
        reading an individual subscription for NFV-MANO functional entity alarms
        subscribed by the client. This method shall follow the provisions
        specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query
        parameters, request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          schema:
            type: string
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      responses:
        "200":
          description: >
            200 OK

            The operation has completed successfully. The response body shall contain a representation of the
            subscription resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request. Reference: IETF RFC
                7231
              schema:
                type: string
                minimum: 1
                maximum: 1
            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.
              schema:
                type: string
                minimum: 0
                maximum: 1
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                minimum: 1
                maximum: 1
          content:
            application/json:
              schema:
                $ref: definitions/SOL009NFVManoFaultManagement_def.yaml#/definitions/FmSubscription
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504
    delete:
      description: >
        Terminate Subscription. This method terminates an individual
        subscription. This method shall follow the provisions specified in the
        tables 7.5.6.3.5-1 and 7.5.6.3.5-2 for URI query parameters, request and
        response data structures, and response codes. As the result of
        successfully executing this method, the "Individual subscription"
        resource shall not exist any longer. This means that no notifications
        for that subscription shall be sent to the formerly-subscribed API
        consumer. NOTE:	Due to race conditions, some notifications might still
        be received by the formerly-subscribed API consumer for a certain time
        period after the deletion.
      parameters:
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          schema:
            type: string
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
      responses:
        "204":
          description: >
            204 NO CONTENT

            Shall be returned when the "Individual subscription" resource has been deleted successfully.
            The response body shall be empty.
          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.
              schema:
                type: string
                minimum: 0
                maximum: 1
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                minimum: 1
                maximum: 1
        "400":
          $ref: ../responses/SOL009_resp.yaml#/responses/400
        "401":
          $ref: ../responses/SOL009_resp.yaml#/responses/401
        "403":
          $ref: ../responses/SOL009_resp.yaml#/responses/403
        "404":
          $ref: ../responses/SOL009_resp.yaml#/responses/404
        "405":
          $ref: ../responses/SOL009_resp.yaml#/responses/405
        "406":
          $ref: ../responses/SOL009_resp.yaml#/responses/406
        "422":
          $ref: ../responses/SOL009_resp.yaml#/responses/422
        "500":
          $ref: ../responses/SOL009_resp.yaml#/responses/500
        "503":
          $ref: ../responses/SOL009_resp.yaml#/responses/503
        "504":
          $ref: ../responses/SOL009_resp.yaml#/responses/504