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 V3.3.1
  url: >-
    https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
servers:
  - url: 'http://127.0.0.1/nfvmanofm/v1'
  - url: 'https://127.0.0.1/nfvmanofm/v1'
paths:
  /api_versions:
    parameters:
      - name: Version
        description: |
          Version of the API requested to use when responding to this request.
        in: header
        required: false
        schema:
          type: string
      - name: Authorization
        description: 'The authorization token for the request. Reference: IETF RFC 7235'
        in: header
        required: false
        schema:
          type: string
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow
        the provisions specified in table 4.6.3.3.3.2-1 for request and response
        data structures, and response codes. URI query parameters are not
        supported.
      responses:
        '200':
          description: >
            200 OK

            API version information was read successfully. The response body
            shall contain 4.4 API version information, as defined in clause
            4.4.1.13.
          content:
            application/json:
              schema:
                description: |
                  This type represents API version information.
                type: object
                required:
                  - uriPrefix
                  - apiVersions
                properties:
                  uriPrefix:
                    description: >
                      Specifies the URI prefix for the API, in the following
                      form {apiRoot}/{apiName}/{apiMajorVersion}/.
                    type: string
                  apiVersions:
                    description: >
                      Version(s) supported for the API signaled by the uriPrefix
                      attribute.
                    type: array
                    items:
                      type: object
                      required:
                        - version
                      properties:
                        version:
                          description: >
                            Identifies a supported version. The value of the
                            version attribute shall be a version identifier as
                            specified in clause 9.1 (SOL013).
                          type: string
                        isDeprecated:
                          description: >
                            If such information is available, this attribute
                            indicates whether use of the version signaled by the
                            version attribute is deprecated (true) or not
                            (false).

                            A deprecated version is still supported by the API
                            producer but is recommended not to be used any
                            longer. When a version is no longer supported, it
                            does not appear in the response body.
                          type: boolean
                        retirementDate:
                          description: >
                            Date-time stamp. Representation: String formatted
                            according to IETF RFC 3339.
                          type: string
                          format: date-time
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: The used API version.
              schema:
                type: string
                maximum: 1
                minimum: 1
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '413':
          description: >
            413 PAYLOAD TOO LARGE

            If the payload body of a request is larger than the amount of data
            the API producer is willing or able to process, it shall respond
            with this response code, following the provisions in IETF RFC 7231
            for the use of the "Retry-After" HTTP header and for closing the
            connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '414':
          description: >
            414 URI TOO LONG

            If the request URI of a request is longer than the API producer is
            willing or able to process, it shall respond with this response
            code. This condition can e.g. be caused by passing long queries in
            the request URI of a GET request. The "ProblemDetails" structure may
            be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '416':
          description: |
            416 Range Not Satisfiable
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '429':
          description: >
            429 TOO MANY REQUESTS

            If the API consumer has sent too many requests in a defined period
            of time and the API producer is able to detect that condition ("rate
            limiting"), the API producer shall respond with this response code,
            following the provisions in IETF RFC 6585 [17] for the use of the
            "Retry-After" HTTP header. The "ProblemDetails" structure shall be
            provided and shall include in the "detail" attribute more
            information about the source of the problem.

            The period of time and allowed number of requests are configured
            within the API producer by means outside the scope of the present
            document.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
  /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: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
        - 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. 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
      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:
                  description: |
                    The alarm data type encapsulates information about an alarm.
                  type: object
                  required:
                    - id
                    - managedObjectId
                    - alarmRaisedTime
                    - ackState
                    - perceivedSeverity
                    - eventTime
                    - eventType
                    - probableCause
                    - isRootCause
                    - _links
                  properties:
                    id:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    managedObjectId:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    associatedFaultyInstanceId:
                      description: >
                        This type represents the identifier to reference a
                        managed object of a  particular type. 
                      type: object
                      properties:
                        type:
                          description: >
                            Indicates the type of managed object. Permitted
                            values:
                              - MANO_ENTITY
                              - MANO_SERVICE
                              - MANO_SERVICE_IF
                              - CONSUMED_MANO_IF
                              - MANO_ENTITY_COMPONENT

                            The "MANO_ENTITY COMPONENT" is only applicable if
                            attribute "manoEntityComponents" in "ManoEntity" is
                            supported by the API producer.
                          type: string
                          enum:
                            - MANO_ENTITY
                            - MANO_SERVICE
                            - MANO_SERVICE_IF
                            - CONSUMED_MANO_IF
                            - MANO_ENTITY_COMPONENT
                        objectId:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        subObjectId:
                          description: >
                            An identifier that is unique for the respective type
                            within a NFV-MANO functional entity, but that need
                            not be globally unique. Representation: string of
                            variable length..
                          type: string
                      required:
                        - type
                        - objectId
                    alarmRaisedTime:
                      description: >
                        Date-time stamp. Representation: String formatted
                        according to IETF RFC 3339.
                      type: string
                      format: date-time
                    alarmChangedTime:
                      description: >
                        Date-time stamp. Representation: String formatted
                        according to IETF RFC 3339.
                      type: string
                      format: date-time
                    alarmClearedTime:
                      description: >
                        Date-time stamp. Representation: String formatted
                        according to IETF RFC 3339.
                      type: string
                      format: date-time
                    ackState:
                      description: >
                        Acknowledgement state of the alarm. Permitted values: *
                        UNACKNOWLEDGED * ACKNOWLEDGED.
                      type: string
                      enum:
                        - UNACKNOWLEDGED
                        - ACKNOWLEDGED
                    perceivedSeverity:
                      description: >
                        Indicates the relative level of urgency for operator
                        attention. * CRITICAL: The Critical severity level
                        indicates that a service
                          affecting condition has occurred and an immediate corrective action
                          is required. Such a severity can be reported, for example, when a
                          managed object becomes totally out of service and its capability needs
                          to be restored (ITU-T Recommendation X.733).
                        * MAJOR: The Major severity level indicates that a
                        service affecting
                          condition has developed and an urgent corrective action is required.
                          Such a severity can be reported, for example, when there is a severe
                          degradation in the capability of the managed object and its full
                          capability needs to be restored (ITU-T Recommendation X.733).
                        * MINOR: The Minor severity level indicates the
                        existence of a
                          non-service affecting fault condition and that corrective action
                          should be taken in order to prevent a more serious (for example,
                          service affecting) fault. Such a severity can be reported, for
                          example, when the detected alarm condition is not currently degrading
                          the capacity of the managed object (ITU-T Recommendation X.733).
                        * WARNING: The Warning severity level indicates the
                        detection of a
                          potential or impending service affecting fault, before any significant
                          effects have been felt. Action should be taken to further diagnose (if
                          necessary) and correct the problem in order to prevent it from
                          becoming a more serious service affecting fault (ITU-T Recommendation
                          X.733).
                        * INDETERMINATE: The Indeterminate severity level
                        indicates that the
                          severity level cannot be determined (ITU-T Recommendation X.733).
                        * CLEARED: The Cleared severity level indicates the
                        clearing of one or
                          more previously reported alarms. This alarm clears all alarms for this
                          managed object that have the same Alarm type, Probable cause and
                          Specific problems (if given) (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - CRITICAL
                        - MAJOR
                        - MINOR
                        - WARNING
                        - INDETERMINATE
                        - CLEARED
                    eventTime:
                      description: >
                        Date-time stamp. Representation: String formatted
                        according to IETF RFC 3339.
                      type: string
                      format: date-time
                    eventType:
                      description: >
                        The enumeration EventType represents those types of
                        events that trigger an alarm. * COMMUNICATIONS_ALARM: An
                        alarm of this type is associated with the
                          procedure and/or process required conveying information from one point
                          to another (ITU-T Recommendation X.733).
                        * PROCESSING_ERROR_ALARM: An alarm of this type is
                        associated with a
                          software or processing fault (ITU-T Recommendation X.733).
                        * ENVIRONMENTAL_ALARM: An alarm of this type is
                        associated with a
                          condition related to an enclosure in which the equipment resides
                          (ITU-T Recommendation X.733).
                        * QOS_ALARM: An alarm of this type is associated with
                        degradation in the
                          quality of a service (ITU-T Recommendation X.733).
                        * EQUIPMENT_ALARM: An alarm of this type is associated
                        with an equipment
                          fault (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - COMMUNICATIONS_ALARM
                        - PROCESSING_ERROR_ALARM
                        - ENVIRONMENTAL_ALARM
                        - QOS_ALARM
                        - EQUIPMENT_ALARM
                    faultType:
                      description: |
                        Additional information to clarify the type of the fault.
                      type: string
                    probableCause:
                      description: |
                        Information about the probable cause of the fault.
                      type: string
                    isRootCause:
                      description: >
                        Attribute indicating if this fault is the root for other
                        correlated alarms. If true, then the alarms listed in
                        the attribute CorrelatedAlarmId are caused by this
                        fault.
                      type: boolean
                    correlatedAlarmIds:
                      description: >
                        List of identifiers of other alarms correlated to this
                        fault.
                      type: array
                      items:
                        description: >
                          An identifier with the intention of being globally
                          unique.
                        type: string
                    faultDetails:
                      description: |
                        Provides additional information about the fault.
                      type: array
                      items:
                        type: string
                    _links:
                      description: |
                        Links for this resource.
                      type: object
                      required:
                        - self
                      properties:
                        self:
                          description: >
                            This type represents a link to a resource using an
                            absolute URI.
                          type: object
                          required:
                            - href
                          properties:
                            href:
                              description: |
                                String formatted according to IETF RFC 3986.
                              type: string
                        objectInstance:
                          description: >
                            This type represents a link to a resource using an
                            absolute URI.
                          type: object
                          required:
                            - href
                          properties:
                            href:
                              description: |
                                String formatted according to IETF RFC 3986.
                              type: string
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
  '/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: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
        - 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
      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:
                description: |
                  The alarm data type encapsulates information about an alarm.
                type: object
                required:
                  - id
                  - managedObjectId
                  - alarmRaisedTime
                  - ackState
                  - perceivedSeverity
                  - eventTime
                  - eventType
                  - probableCause
                  - isRootCause
                  - _links
                properties:
                  id:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  managedObjectId:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  associatedFaultyInstanceId:
                    description: >
                      This type represents the identifier to reference a managed
                      object of a  particular type. 
                    type: object
                    properties:
                      type:
                        description: >
                          Indicates the type of managed object. Permitted
                          values:
                            - MANO_ENTITY
                            - MANO_SERVICE
                            - MANO_SERVICE_IF
                            - CONSUMED_MANO_IF
                            - MANO_ENTITY_COMPONENT

                          The "MANO_ENTITY COMPONENT" is only applicable if
                          attribute "manoEntityComponents" in "ManoEntity" is
                          supported by the API producer.
                        type: string
                        enum:
                          - MANO_ENTITY
                          - MANO_SERVICE
                          - MANO_SERVICE_IF
                          - CONSUMED_MANO_IF
                          - MANO_ENTITY_COMPONENT
                      objectId:
                        description: >
                          An identifier with the intention of being globally
                          unique.
                        type: string
                      subObjectId:
                        description: >
                          An identifier that is unique for the respective type
                          within a NFV-MANO functional entity, but that need not
                          be globally unique. Representation: string of variable
                          length..
                        type: string
                    required:
                      - type
                      - objectId
                  alarmRaisedTime:
                    description: >
                      Date-time stamp. Representation: String formatted
                      according to IETF RFC 3339.
                    type: string
                    format: date-time
                  alarmChangedTime:
                    description: >
                      Date-time stamp. Representation: String formatted
                      according to IETF RFC 3339.
                    type: string
                    format: date-time
                  alarmClearedTime:
                    description: >
                      Date-time stamp. Representation: String formatted
                      according to IETF RFC 3339.
                    type: string
                    format: date-time
                  ackState:
                    description: >
                      Acknowledgement state of the alarm. Permitted values: *
                      UNACKNOWLEDGED * ACKNOWLEDGED.
                    type: string
                    enum:
                      - UNACKNOWLEDGED
                      - ACKNOWLEDGED
                  perceivedSeverity:
                    description: >
                      Indicates the relative level of urgency for operator
                      attention. * CRITICAL: The Critical severity level
                      indicates that a service
                        affecting condition has occurred and an immediate corrective action
                        is required. Such a severity can be reported, for example, when a
                        managed object becomes totally out of service and its capability needs
                        to be restored (ITU-T Recommendation X.733).
                      * MAJOR: The Major severity level indicates that a service
                      affecting
                        condition has developed and an urgent corrective action is required.
                        Such a severity can be reported, for example, when there is a severe
                        degradation in the capability of the managed object and its full
                        capability needs to be restored (ITU-T Recommendation X.733).
                      * MINOR: The Minor severity level indicates the existence
                      of a
                        non-service affecting fault condition and that corrective action
                        should be taken in order to prevent a more serious (for example,
                        service affecting) fault. Such a severity can be reported, for
                        example, when the detected alarm condition is not currently degrading
                        the capacity of the managed object (ITU-T Recommendation X.733).
                      * WARNING: The Warning severity level indicates the
                      detection of a
                        potential or impending service affecting fault, before any significant
                        effects have been felt. Action should be taken to further diagnose (if
                        necessary) and correct the problem in order to prevent it from
                        becoming a more serious service affecting fault (ITU-T Recommendation
                        X.733).
                      * INDETERMINATE: The Indeterminate severity level
                      indicates that the
                        severity level cannot be determined (ITU-T Recommendation X.733).
                      * CLEARED: The Cleared severity level indicates the
                      clearing of one or
                        more previously reported alarms. This alarm clears all alarms for this
                        managed object that have the same Alarm type, Probable cause and
                        Specific problems (if given) (ITU-T Recommendation X.733).
                    type: string
                    enum:
                      - CRITICAL
                      - MAJOR
                      - MINOR
                      - WARNING
                      - INDETERMINATE
                      - CLEARED
                  eventTime:
                    description: >
                      Date-time stamp. Representation: String formatted
                      according to IETF RFC 3339.
                    type: string
                    format: date-time
                  eventType:
                    description: >
                      The enumeration EventType represents those types of events
                      that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of
                      this type is associated with the
                        procedure and/or process required conveying information from one point
                        to another (ITU-T Recommendation X.733).
                      * PROCESSING_ERROR_ALARM: An alarm of this type is
                      associated with a
                        software or processing fault (ITU-T Recommendation X.733).
                      * ENVIRONMENTAL_ALARM: An alarm of this type is associated
                      with a
                        condition related to an enclosure in which the equipment resides
                        (ITU-T Recommendation X.733).
                      * QOS_ALARM: An alarm of this type is associated with
                      degradation in the
                        quality of a service (ITU-T Recommendation X.733).
                      * EQUIPMENT_ALARM: An alarm of this type is associated
                      with an equipment
                        fault (ITU-T Recommendation X.733).
                    type: string
                    enum:
                      - COMMUNICATIONS_ALARM
                      - PROCESSING_ERROR_ALARM
                      - ENVIRONMENTAL_ALARM
                      - QOS_ALARM
                      - EQUIPMENT_ALARM
                  faultType:
                    description: |
                      Additional information to clarify the type of the fault.
                    type: string
                  probableCause:
                    description: |
                      Information about the probable cause of the fault.
                    type: string
                  isRootCause:
                    description: >
                      Attribute indicating if this fault is the root for other
                      correlated alarms. If true, then the alarms listed in the
                      attribute CorrelatedAlarmId are caused by this fault.
                    type: boolean
                  correlatedAlarmIds:
                    description: >
                      List of identifiers of other alarms correlated to this
                      fault.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  faultDetails:
                    description: |
                      Provides additional information about the fault.
                    type: array
                    items:
                      type: string
                  _links:
                    description: |
                      Links for this resource.
                    type: object
                    required:
                      - self
                    properties:
                      self:
                        description: >
                          This type represents a link to a resource using an
                          absolute URI.
                        type: object
                        required:
                          - href
                        properties:
                          href:
                            description: |
                              String formatted according to IETF RFC 3986.
                            type: string
                      objectInstance:
                        description: >
                          This type represents a link to a resource using an
                          absolute URI.
                        type: object
                        required:
                          - href
                        properties:
                          href:
                            description: |
                              String formatted according to IETF RFC 3986.
                            type: string
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
    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: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
        - 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
      requestBody:
        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.
        content:
          application/json:
            schema:
              description: >
                This type represents attribute modifications for an "Individual
                alarm" resource, i.e. modifications to a resource representation
                based on the "Alarm" data type. The attributes of "Alarm" that
                can be modified are included in the "AlarmModifications" data
                type.
              type: object
              required:
                - ackState
              properties:
                ackState:
                  description: >
                    New value of the "ackState" attribute in "Alarm". Permitted
                    values: * ACKNOWLEDGED
                  type: string
                  enum:
                    - ACKNOWLEDGED
        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:
                description: >
                  This type represents attribute modifications for an
                  "Individual alarm" resource, i.e. modifications to a resource
                  representation based on the "Alarm" data type. The attributes
                  of "Alarm" that can be modified are included in the
                  "AlarmModifications" data type.
                type: object
                required:
                  - ackState
                properties:
                  ackState:
                    description: >
                      New value of the "ackState" attribute in "Alarm".
                      Permitted values: * ACKNOWLEDGED
                    type: string
                    enum:
                      - ACKNOWLEDGED
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '409':
          description: |
            409 CONFLICT
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '412':
          description: >
            412 PRECONDITION FAILED

            Error: A precondition given in an HTTP request header is not
            fulfilled. Typically, this is due to an ETag mismatch, indicating
            that the resource was modified by another entity. The response body
            should contain a ProblemDetails structure, in which the "detail"
            attribute should convey more information about the error.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
  /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: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
        - 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
      requestBody:
        description: >
          Details of the subscription to be created, as defined in clause
          7.6.2.2.
        content:
          application/json:
            schema:
              description: >
                This type represents a subscription request related to
                notifications about NFV-MANO faults.
              type: object
              required:
                - callbackUri
              properties:
                filter:
                  description: >
                    This type represents a subscription filter related to
                    notifications about NFV-MANO functional entity faults. It
                    shall comply with the provisions defined in table 7.6.3.2-1.
                    At a particular nesting level in the filter structure, the
                    following applies: All attributes shall match in order for
                    the filter to match (logical "and" between different filter
                    attributes). If an attribute is an array, the attribute
                    shall match if at least one of the values in the array
                    matches (logical "or" between the values of one filter
                    attribute).
                  type: object
                  properties:
                    notificationTypes:
                      description: >
                        Match particular notification types. Permitted values: *
                        AlarmNotification * AlarmClearedNotification *
                        AlarmListRebuiltNotification The permitted values of the
                        "notificationTypes" attribute are spelled exactly as the
                        names of the notification types to facilitate automated
                        code generation systems.
                      type: array
                      items:
                        type: string
                        enum:
                          - AlarmNotification
                          - AlarmClearedNotification
                          - AlarmListRebuiltNotification
                    perceivedSeverities:
                      description: >
                        Match VNF alarms with a perceived severity listed in
                        this attribute.
                      type: array
                      items:
                        description: >
                          Indicates the relative level of urgency for operator
                          attention. * CRITICAL: The Critical severity level
                          indicates that a service
                            affecting condition has occurred and an immediate corrective action
                            is required. Such a severity can be reported, for example, when a
                            managed object becomes totally out of service and its capability needs
                            to be restored (ITU-T Recommendation X.733).
                          * MAJOR: The Major severity level indicates that a
                          service affecting
                            condition has developed and an urgent corrective action is required.
                            Such a severity can be reported, for example, when there is a severe
                            degradation in the capability of the managed object and its full
                            capability needs to be restored (ITU-T Recommendation X.733).
                          * MINOR: The Minor severity level indicates the
                          existence of a
                            non-service affecting fault condition and that corrective action
                            should be taken in order to prevent a more serious (for example,
                            service affecting) fault. Such a severity can be reported, for
                            example, when the detected alarm condition is not currently degrading
                            the capacity of the managed object (ITU-T Recommendation X.733).
                          * WARNING: The Warning severity level indicates the
                          detection of a
                            potential or impending service affecting fault, before any significant
                            effects have been felt. Action should be taken to further diagnose (if
                            necessary) and correct the problem in order to prevent it from
                            becoming a more serious service affecting fault (ITU-T Recommendation
                            X.733).
                          * INDETERMINATE: The Indeterminate severity level
                          indicates that the
                            severity level cannot be determined (ITU-T Recommendation X.733).
                          * CLEARED: The Cleared severity level indicates the
                          clearing of one or
                            more previously reported alarms. This alarm clears all alarms for this
                            managed object that have the same Alarm type, Probable cause and
                            Specific problems (if given) (ITU-T Recommendation X.733).
                        type: string
                        enum:
                          - CRITICAL
                          - MAJOR
                          - MINOR
                          - WARNING
                          - INDETERMINATE
                          - CLEARED
                    eventTypes:
                      description: >
                        Match VNF alarms with an event type listed in this
                        attribute.
                      type: array
                      items:
                        description: >
                          The enumeration EventType represents those types of
                          events that trigger an alarm. * COMMUNICATIONS_ALARM:
                          An alarm of this type is associated with the
                            procedure and/or process required conveying information from one point
                            to another (ITU-T Recommendation X.733).
                          * PROCESSING_ERROR_ALARM: An alarm of this type is
                          associated with a
                            software or processing fault (ITU-T Recommendation X.733).
                          * ENVIRONMENTAL_ALARM: An alarm of this type is
                          associated with a
                            condition related to an enclosure in which the equipment resides
                            (ITU-T Recommendation X.733).
                          * QOS_ALARM: An alarm of this type is associated with
                          degradation in the
                            quality of a service (ITU-T Recommendation X.733).
                          * EQUIPMENT_ALARM: An alarm of this type is associated
                          with an equipment
                            fault (ITU-T Recommendation X.733).
                        type: string
                        enum:
                          - COMMUNICATIONS_ALARM
                          - PROCESSING_ERROR_ALARM
                          - ENVIRONMENTAL_ALARM
                          - QOS_ALARM
                          - EQUIPMENT_ALARM
                    probableCauses:
                      description: >
                        Match VNF alarms with a probable cause listed in this
                        attribute.
                      type: array
                      items:
                        type: string
                callbackUri:
                  description: |
                    String formatted according to IETF RFC 3986.
                  type: string
                authentication:
                  type: object
                  required:
                    - authType
                  properties:
                    authType:
                      description: >
                        Defines the types of Authentication / Authorization
                        which the API consumer is willing to accept when
                        receiving a notification. Permitted values: * BASIC: In
                        every HTTP request to the notification endpoint, use
                          HTTP Basic authentication with the client credentials.
                        * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to
                        the
                          notification endpoint, use an OAuth 2.0 Bearer token, obtained
                          using the client credentials grant type.
                        * TLS_CERT: Every HTTP request to the notification
                        endpoint is sent
                          over a mutually authenticated TLS session, i.e. not only the
                          server is authenticated, but also the client is authenticated
                          during the TLS tunnel setup.
                      type: array
                      items:
                        type: string
                        enum:
                          - BASIC
                          - OAUTH2_CLIENT_CREDENTIALS
                          - TLS_CERT
                    paramsBasic:
                      description: >
                        Parameters for authentication/authorization using BASIC.
                        Shall be present if authType is "BASIC" and the
                        contained information has not been provisioned out of
                        band. Shall be absent otherwise.
                      type: object
                      properties:
                        userName:
                          description: >
                            Username to be used in HTTP Basic authentication.
                            Shall be present if it has not been provisioned out
                            of band.
                          type: string
                        password:
                          description: >
                            Password to be used in HTTP Basic authentication.
                            Shall be present if it has not been provisioned out
                            of band.
                          type: string
                    paramsOauth2ClientCredentials:
                      description: >
                        Parameters for authentication/authorization using
                        OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType
                        is "OAUTH2_CLIENT_CREDENTIALS" and the contained
                        information has not been provisioned out of band. Shall
                        be absent otherwise.
                      type: object
                      properties:
                        clientId:
                          description: >
                            Client identifier to be used in the access token
                            request of the OAuth 2.0 client credentials grant
                            type. Shall be present if it has not been
                            provisioned out of band. The clientId and
                            clientPassword passed in a subscription shall not be
                            the same as the clientId and clientPassword that are
                            used to obtain authorization for API requests.
                            Client credentials may differ between subscriptions.
                            The value of clientPassword should be generated by a
                            random process.
                          type: string
                        clientPassword:
                          description: >
                            Client password to be used in the access token
                            request of the OAuth 2.0 client credentials grant
                            type. Shall be present if it has not been
                            provisioned out of band. The clientId and
                            clientPassword passed in a subscription shall not be
                            the same as the clientId and clientPassword that are
                            used to obtain authorization for API requests.
                            Client credentials may differ between subscriptions.
                            The value of clientPassword should be generated by a
                            random process.
                          type: string
                        tokenEndpoint:
                          description: |
                            String formatted according to IETF RFC 3986.
                          type: string
        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:
                description: >
                  This type represents a subscription related to notifications
                  about VNF faults.
                type: object
                required:
                  - id
                  - callbackUri
                  - _links
                properties:
                  id:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  filter:
                    description: >
                      This type represents a subscription filter related to
                      notifications about NFV-MANO functional entity faults. It
                      shall comply with the provisions defined in table
                      7.6.3.2-1. At a particular nesting level in the filter
                      structure, the following applies: All attributes shall
                      match in order for the filter to match (logical "and"
                      between different filter attributes). If an attribute is
                      an array, the attribute shall match if at least one of the
                      values in the array matches (logical "or" between the
                      values of one filter attribute).
                    type: object
                    properties:
                      notificationTypes:
                        description: >
                          Match particular notification types. Permitted values:
                          * AlarmNotification * AlarmClearedNotification *
                          AlarmListRebuiltNotification The permitted values of
                          the "notificationTypes" attribute are spelled exactly
                          as the names of the notification types to facilitate
                          automated code generation systems.
                        type: array
                        items:
                          type: string
                          enum:
                            - AlarmNotification
                            - AlarmClearedNotification
                            - AlarmListRebuiltNotification
                      perceivedSeverities:
                        description: >
                          Match VNF alarms with a perceived severity listed in
                          this attribute.
                        type: array
                        items:
                          description: >
                            Indicates the relative level of urgency for operator
                            attention. * CRITICAL: The Critical severity level
                            indicates that a service
                              affecting condition has occurred and an immediate corrective action
                              is required. Such a severity can be reported, for example, when a
                              managed object becomes totally out of service and its capability needs
                              to be restored (ITU-T Recommendation X.733).
                            * MAJOR: The Major severity level indicates that a
                            service affecting
                              condition has developed and an urgent corrective action is required.
                              Such a severity can be reported, for example, when there is a severe
                              degradation in the capability of the managed object and its full
                              capability needs to be restored (ITU-T Recommendation X.733).
                            * MINOR: The Minor severity level indicates the
                            existence of a
                              non-service affecting fault condition and that corrective action
                              should be taken in order to prevent a more serious (for example,
                              service affecting) fault. Such a severity can be reported, for
                              example, when the detected alarm condition is not currently degrading
                              the capacity of the managed object (ITU-T Recommendation X.733).
                            * WARNING: The Warning severity level indicates the
                            detection of a
                              potential or impending service affecting fault, before any significant
                              effects have been felt. Action should be taken to further diagnose (if
                              necessary) and correct the problem in order to prevent it from
                              becoming a more serious service affecting fault (ITU-T Recommendation
                              X.733).
                            * INDETERMINATE: The Indeterminate severity level
                            indicates that the
                              severity level cannot be determined (ITU-T Recommendation X.733).
                            * CLEARED: The Cleared severity level indicates the
                            clearing of one or
                              more previously reported alarms. This alarm clears all alarms for this
                              managed object that have the same Alarm type, Probable cause and
                              Specific problems (if given) (ITU-T Recommendation X.733).
                          type: string
                          enum:
                            - CRITICAL
                            - MAJOR
                            - MINOR
                            - WARNING
                            - INDETERMINATE
                            - CLEARED
                      eventTypes:
                        description: >
                          Match VNF alarms with an event type listed in this
                          attribute.
                        type: array
                        items:
                          description: >
                            The enumeration EventType represents those types of
                            events that trigger an alarm. *
                            COMMUNICATIONS_ALARM: An alarm of this type is
                            associated with the
                              procedure and/or process required conveying information from one point
                              to another (ITU-T Recommendation X.733).
                            * PROCESSING_ERROR_ALARM: An alarm of this type is
                            associated with a
                              software or processing fault (ITU-T Recommendation X.733).
                            * ENVIRONMENTAL_ALARM: An alarm of this type is
                            associated with a
                              condition related to an enclosure in which the equipment resides
                              (ITU-T Recommendation X.733).
                            * QOS_ALARM: An alarm of this type is associated
                            with degradation in the
                              quality of a service (ITU-T Recommendation X.733).
                            * EQUIPMENT_ALARM: An alarm of this type is
                            associated with an equipment
                              fault (ITU-T Recommendation X.733).
                          type: string
                          enum:
                            - COMMUNICATIONS_ALARM
                            - PROCESSING_ERROR_ALARM
                            - ENVIRONMENTAL_ALARM
                            - QOS_ALARM
                            - EQUIPMENT_ALARM
                      probableCauses:
                        description: >
                          Match VNF alarms with a probable cause listed in this
                          attribute.
                        type: array
                        items:
                          type: string
                  callbackUri:
                    description: |
                      String formatted according to IETF RFC 3986.
                    type: string
                  _links:
                    description: |
                      Links for this resource.
                    type: object
                    required:
                      - self
                    properties:
                      self:
                        description: >
                          This type represents a link to a resource using an
                          absolute URI.
                        type: object
                        required:
                          - href
                        properties:
                          href:
                            description: |
                              String formatted according to IETF RFC 3986.
                            type: string
        '303':
          description: |
            303 See Other
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
    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: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
        - 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. 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
      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:
                type: array
                items:
                  description: >
                    This type represents a subscription related to notifications
                    about VNF faults.
                  type: object
                  required:
                    - id
                    - callbackUri
                    - _links
                  properties:
                    id:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    filter:
                      description: >
                        This type represents a subscription filter related to
                        notifications about NFV-MANO functional entity faults.
                        It shall comply with the provisions defined in table
                        7.6.3.2-1. At a particular nesting level in the filter
                        structure, the following applies: All attributes shall
                        match in order for the filter to match (logical "and"
                        between different filter attributes). If an attribute is
                        an array, the attribute shall match if at least one of
                        the values in the array matches (logical "or" between
                        the values of one filter attribute).
                      type: object
                      properties:
                        notificationTypes:
                          description: >
                            Match particular notification types. Permitted
                            values: * AlarmNotification *
                            AlarmClearedNotification *
                            AlarmListRebuiltNotification The permitted values of
                            the "notificationTypes" attribute are spelled
                            exactly as the names of the notification types to
                            facilitate automated code generation systems.
                          type: array
                          items:
                            type: string
                            enum:
                              - AlarmNotification
                              - AlarmClearedNotification
                              - AlarmListRebuiltNotification
                        perceivedSeverities:
                          description: >
                            Match VNF alarms with a perceived severity listed in
                            this attribute.
                          type: array
                          items:
                            description: >
                              Indicates the relative level of urgency for
                              operator attention. * CRITICAL: The Critical
                              severity level indicates that a service
                                affecting condition has occurred and an immediate corrective action
                                is required. Such a severity can be reported, for example, when a
                                managed object becomes totally out of service and its capability needs
                                to be restored (ITU-T Recommendation X.733).
                              * MAJOR: The Major severity level indicates that a
                              service affecting
                                condition has developed and an urgent corrective action is required.
                                Such a severity can be reported, for example, when there is a severe
                                degradation in the capability of the managed object and its full
                                capability needs to be restored (ITU-T Recommendation X.733).
                              * MINOR: The Minor severity level indicates the
                              existence of a
                                non-service affecting fault condition and that corrective action
                                should be taken in order to prevent a more serious (for example,
                                service affecting) fault. Such a severity can be reported, for
                                example, when the detected alarm condition is not currently degrading
                                the capacity of the managed object (ITU-T Recommendation X.733).
                              * WARNING: The Warning severity level indicates
                              the detection of a
                                potential or impending service affecting fault, before any significant
                                effects have been felt. Action should be taken to further diagnose (if
                                necessary) and correct the problem in order to prevent it from
                                becoming a more serious service affecting fault (ITU-T Recommendation
                                X.733).
                              * INDETERMINATE: The Indeterminate severity level
                              indicates that the
                                severity level cannot be determined (ITU-T Recommendation X.733).
                              * CLEARED: The Cleared severity level indicates
                              the clearing of one or
                                more previously reported alarms. This alarm clears all alarms for this
                                managed object that have the same Alarm type, Probable cause and
                                Specific problems (if given) (ITU-T Recommendation X.733).
                            type: string
                            enum:
                              - CRITICAL
                              - MAJOR
                              - MINOR
                              - WARNING
                              - INDETERMINATE
                              - CLEARED
                        eventTypes:
                          description: >
                            Match VNF alarms with an event type listed in this
                            attribute.
                          type: array
                          items:
                            description: >
                              The enumeration EventType represents those types
                              of events that trigger an alarm. *
                              COMMUNICATIONS_ALARM: An alarm of this type is
                              associated with the
                                procedure and/or process required conveying information from one point
                                to another (ITU-T Recommendation X.733).
                              * PROCESSING_ERROR_ALARM: An alarm of this type is
                              associated with a
                                software or processing fault (ITU-T Recommendation X.733).
                              * ENVIRONMENTAL_ALARM: An alarm of this type is
                              associated with a
                                condition related to an enclosure in which the equipment resides
                                (ITU-T Recommendation X.733).
                              * QOS_ALARM: An alarm of this type is associated
                              with degradation in the
                                quality of a service (ITU-T Recommendation X.733).
                              * EQUIPMENT_ALARM: An alarm of this type is
                              associated with an equipment
                                fault (ITU-T Recommendation X.733).
                            type: string
                            enum:
                              - COMMUNICATIONS_ALARM
                              - PROCESSING_ERROR_ALARM
                              - ENVIRONMENTAL_ALARM
                              - QOS_ALARM
                              - EQUIPMENT_ALARM
                        probableCauses:
                          description: >
                            Match VNF alarms with a probable cause listed in
                            this attribute.
                          type: array
                          items:
                            type: string
                    callbackUri:
                      description: |
                        String formatted according to IETF RFC 3986.
                      type: string
                    _links:
                      description: |
                        Links for this resource.
                      type: object
                      required:
                        - self
                      properties:
                        self:
                          description: >
                            This type represents a link to a resource using an
                            absolute URI.
                          type: object
                          required:
                            - href
                          properties:
                            href:
                              description: |
                                String formatted according to IETF RFC 3986.
                              type: string
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
  '/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: Version
          description: |
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          schema:
            type: string
        - 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
      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:
                description: >
                  This type represents a subscription related to notifications
                  about VNF faults.
                type: object
                required:
                  - id
                  - callbackUri
                  - _links
                properties:
                  id:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  filter:
                    description: >
                      This type represents a subscription filter related to
                      notifications about NFV-MANO functional entity faults. It
                      shall comply with the provisions defined in table
                      7.6.3.2-1. At a particular nesting level in the filter
                      structure, the following applies: All attributes shall
                      match in order for the filter to match (logical "and"
                      between different filter attributes). If an attribute is
                      an array, the attribute shall match if at least one of the
                      values in the array matches (logical "or" between the
                      values of one filter attribute).
                    type: object
                    properties:
                      notificationTypes:
                        description: >
                          Match particular notification types. Permitted values:
                          * AlarmNotification * AlarmClearedNotification *
                          AlarmListRebuiltNotification The permitted values of
                          the "notificationTypes" attribute are spelled exactly
                          as the names of the notification types to facilitate
                          automated code generation systems.
                        type: array
                        items:
                          type: string
                          enum:
                            - AlarmNotification
                            - AlarmClearedNotification
                            - AlarmListRebuiltNotification
                      perceivedSeverities:
                        description: >
                          Match VNF alarms with a perceived severity listed in
                          this attribute.
                        type: array
                        items:
                          description: >
                            Indicates the relative level of urgency for operator
                            attention. * CRITICAL: The Critical severity level
                            indicates that a service
                              affecting condition has occurred and an immediate corrective action
                              is required. Such a severity can be reported, for example, when a
                              managed object becomes totally out of service and its capability needs
                              to be restored (ITU-T Recommendation X.733).
                            * MAJOR: The Major severity level indicates that a
                            service affecting
                              condition has developed and an urgent corrective action is required.
                              Such a severity can be reported, for example, when there is a severe
                              degradation in the capability of the managed object and its full
                              capability needs to be restored (ITU-T Recommendation X.733).
                            * MINOR: The Minor severity level indicates the
                            existence of a
                              non-service affecting fault condition and that corrective action
                              should be taken in order to prevent a more serious (for example,
                              service affecting) fault. Such a severity can be reported, for
                              example, when the detected alarm condition is not currently degrading
                              the capacity of the managed object (ITU-T Recommendation X.733).
                            * WARNING: The Warning severity level indicates the
                            detection of a
                              potential or impending service affecting fault, before any significant
                              effects have been felt. Action should be taken to further diagnose (if
                              necessary) and correct the problem in order to prevent it from
                              becoming a more serious service affecting fault (ITU-T Recommendation
                              X.733).
                            * INDETERMINATE: The Indeterminate severity level
                            indicates that the
                              severity level cannot be determined (ITU-T Recommendation X.733).
                            * CLEARED: The Cleared severity level indicates the
                            clearing of one or
                              more previously reported alarms. This alarm clears all alarms for this
                              managed object that have the same Alarm type, Probable cause and
                              Specific problems (if given) (ITU-T Recommendation X.733).
                          type: string
                          enum:
                            - CRITICAL
                            - MAJOR
                            - MINOR
                            - WARNING
                            - INDETERMINATE
                            - CLEARED
                      eventTypes:
                        description: >
                          Match VNF alarms with an event type listed in this
                          attribute.
                        type: array
                        items:
                          description: >
                            The enumeration EventType represents those types of
                            events that trigger an alarm. *
                            COMMUNICATIONS_ALARM: An alarm of this type is
                            associated with the
                              procedure and/or process required conveying information from one point
                              to another (ITU-T Recommendation X.733).
                            * PROCESSING_ERROR_ALARM: An alarm of this type is
                            associated with a
                              software or processing fault (ITU-T Recommendation X.733).
                            * ENVIRONMENTAL_ALARM: An alarm of this type is
                            associated with a
                              condition related to an enclosure in which the equipment resides
                              (ITU-T Recommendation X.733).
                            * QOS_ALARM: An alarm of this type is associated
                            with degradation in the
                              quality of a service (ITU-T Recommendation X.733).
                            * EQUIPMENT_ALARM: An alarm of this type is
                            associated with an equipment
                              fault (ITU-T Recommendation X.733).
                          type: string
                          enum:
                            - COMMUNICATIONS_ALARM
                            - PROCESSING_ERROR_ALARM
                            - ENVIRONMENTAL_ALARM
                            - QOS_ALARM
                            - EQUIPMENT_ALARM
                      probableCauses:
                        description: >
                          Match VNF alarms with a probable cause listed in this
                          attribute.
                        type: array
                        items:
                          type: string
                  callbackUri:
                    description: |
                      String formatted according to IETF RFC 3986.
                    type: string
                  _links:
                    description: |
                      Links for this resource.
                    type: object
                    required:
                      - self
                    properties:
                      self:
                        description: >
                          This type represents a link to a resource using an
                          absolute URI.
                        type: object
                        required:
                          - href
                        properties:
                          href:
                            description: |
                              String formatted according to IETF RFC 3986.
                            type: string
        '400':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
    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:\tDue to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion.\n"
      parameters:
        - name: Version
          description: |
            Version of the API requested to use when responding to this request.
          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
      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':
          description: >
            400 BAD REQUEST

            400 code can be returned in the following specified cases, the
            specific cause has to be proper specified in the "ProblemDetails"
            structure to be returned.

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or the payload body
            contains a syntactically incorrect data structure), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            If the response to a GET request which queries a container resource
            would be so big that the performance of the API producer is
            adversely affected, and the API producer does not support paging for
            the affected resource, it shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and should include in
            the "detail" attribute more information about the source of the
            problem.

            If there is an application error related to the client's input that
            cannot be easily mapped to any other HTTP response code ("catch all
            error"), the API producer shall respond with this response code. The
            "ProblemDetails" structure shall be provided, and shall include in
            the "detail" attribute more information about the source of the
            problem.

            If the request contains a malformed access token, the API producer
            should respond with this response. The details of the error shall be
            returned in the WWW Authenticate HTTP header, as defined in IETF RFC
            6750 and IETF RFC 7235. The ProblemDetails structure may be
            provided.

            The use of this HTTP error response code described above is
            applicable to the use of the OAuth 2.0 for the authorization of API
            requests and notifications, as defined in clauses 4.5.3.3 and
            4.5.3.4.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '401':
          description: >
            401 UNAUTHORIZED

            If the request contains no access token even though one is required,
            or if the request contains an authorization token that is invalid
            (e.g. expired or revoked), the API producer should respond with this
            response. The details of the error shall be returned in the
            WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF
            RFC 7235. The ProblemDetails structure may be provided.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '403':
          description: >
            403 FORBIDDEN

            If the API consumer is not allowed to perform a particular request
            to a particular resource, the API producer shall respond with this
            response code. The "ProblemDetails" structure shall be provided. It
            should include in the "detail" attribute information about the
            source of the problem, and may indicate how to solve it.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '404':
          description: >
            404 NOT FOUND

            If the API producer did not find a current representation for the
            resource addressed by the URI passed in the request or is not
            willing to disclose that one exists, it shall respond with this
            response code. The "ProblemDetails" structure may be provided,
            including in the "detail" attribute information about the source of
            the problem, e.g. a wrong resource URI variable.

            This response code is not appropriate in case the resource addressed
            by the URI is a container resource which is designed to contain
            child resources, but does not contain any child resource at the time
            the request is received. For a GET request to an existing empty
            container resource, a typical response contains a 200 OK response
            code and a payload body with an empty array.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '405':
          description: >
            405 METHOD NOT ALLOWED

            If a particular HTTP method is not supported for a particular
            resource, the API producer shall respond with this response code.
            The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '406':
          description: >
            406 NOT ACCEPTABLE

            If the "Accept" HTTP header does not contain at least one name of a
            content type that is acceptable to the API producer, the API
            producer shall respond with this response code. The "ProblemDetails"
            structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '422':
          description: >
            422 UNPROCESSABLE ENTITY

            If the payload body of a request contains syntactically correct data
            (e.g. well-formed JSON) but the data cannot be processed (e.g.
            because it fails validation against a schema), the API producer
            shall respond with this response code. The "ProblemDetails"
            structure shall be provided, and should include in the "detail"
            attribute more information about the source of the problem.

            This error response code is only applicable for methods that have a
            request body.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '500':
          description: >
            500 INTERNAL SERVER ERROR

            If there is an application error not related to the client's input
            that cannot be easily mapped to any other HTTP response code ("catch
            all error"), the API producer shall respond with this response code.
            The "ProblemDetails" structure shall be provided, and shall include
            in the "detail" attribute more information about the source of the
            problem.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '503':
          description: >
            503 SERVICE UNAVAILABLE

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 for the use
            of the "Retry-After" HTTP header and for the alternative to refuse
            the connection. The "ProblemDetails" structure may be omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
        '504':
          description: >
            504 GATEWAY TIMEOUT

            If the API producer encounters a timeout while waiting for a
            response from an upstream server (i.e. a server that the API
            producer communicates with when fulfilling a request), it should
            respond with this response code.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 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
                maximum: 1
                minimum: 0
            Version:
              description: |
                Version of the API used in the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
          content:
            application/json:
              schema:
                description: >
                  The definition of the general "ProblemDetails" data structure
                  from IETF RFC 7807 [19] is reproduced inthis structure.
                  Compared to the general framework defined in IETF RFC 7807
                  [19], the "status" and "detail" attributes are mandated to be
                  included by the present document, to ensure that the response
                  contains additional textual information about an error. IETF
                  RFC 7807 [19] foresees extensibility of the "ProblemDetails"
                  type. It is possible that particular APIs in the present
                  document, or particular implementations, define extensions to
                  define additional attributes that provide more information
                  about the error. The description column only provides some
                  explanation of the meaning to Facilitate understanding of the
                  design. For a full description, see IETF RFC 7807 [19].
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 [5] that
                      identifies the problem type. It is encouraged that the URI
                      provides human-readable documentation for the problem
                      (e.g. using HTML) when dereferenced. When this member is
                      not present, its value is assumed to be "about:blank".
                    type: string
                    format: URI
                  title:
                    description: >
                      A short, human-readable summary of the problem type. It
                      should not change from occurrence to occurrence of the
                      problem, except for purposes of localization. If type is
                      given and other than "about:blank", this attribute shall
                      also be provided. A short, human-readable summary of the
                      problem type.  It SHOULD NOT change from occurrence to
                      occurrence of the problem, except for purposes of
                      localization (e.g., using proactive content negotiation;
                      see [RFC7231], Section 3.4).
                    type: string
                  status:
                    description: >
                      The HTTP status code for this occurrence of the problem.
                      The HTTP status code ([RFC7231], Section 6) generated by
                      the origin server for this occurrence of the problem.
                    type: integer
                  detail:
                    description: >
                      A human-readable explanation specific to this occurrence
                      of the problem.
                    type: string
                  instance:
                    description: >
                      A URI reference that identifies the specific occurrence of
                      the problem. It may yield further information if
                      dereferenced.
                    type: string
                    format: URI
components:
  parameters:
    alarmId:
      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
    subscriptionId:
      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
  schemas:
    FmSubscriptionRequest:
      description: >
        This type represents a subscription request related to notifications
        about NFV-MANO faults.
      type: object
      required:
        - callbackUri
      properties:
        filter:
          description: >
            This type represents a subscription filter related to notifications
            about NFV-MANO functional entity faults. It shall comply with the
            provisions defined in table 7.6.3.2-1. At a particular nesting level
            in the filter structure, the following applies: All attributes shall
            match in order for the filter to match (logical "and" between
            different filter attributes). If an attribute is an array, the
            attribute shall match if at least one of the values in the array
            matches (logical "or" between the values of one filter attribute).
          type: object
          properties:
            notificationTypes:
              description: >
                Match particular notification types. Permitted values: *
                AlarmNotification * AlarmClearedNotification *
                AlarmListRebuiltNotification The permitted values of the
                "notificationTypes" attribute are spelled exactly as the names
                of the notification types to facilitate automated code
                generation systems.
              type: array
              items:
                type: string
                enum:
                  - AlarmNotification
                  - AlarmClearedNotification
                  - AlarmListRebuiltNotification
            perceivedSeverities:
              description: >
                Match VNF alarms with a perceived severity listed in this
                attribute.
              type: array
              items:
                description: >
                  Indicates the relative level of urgency for operator
                  attention. * CRITICAL: The Critical severity level indicates
                  that a service
                    affecting condition has occurred and an immediate corrective action
                    is required. Such a severity can be reported, for example, when a
                    managed object becomes totally out of service and its capability needs
                    to be restored (ITU-T Recommendation X.733).
                  * MAJOR: The Major severity level indicates that a service
                  affecting
                    condition has developed and an urgent corrective action is required.
                    Such a severity can be reported, for example, when there is a severe
                    degradation in the capability of the managed object and its full
                    capability needs to be restored (ITU-T Recommendation X.733).
                  * MINOR: The Minor severity level indicates the existence of a
                    non-service affecting fault condition and that corrective action
                    should be taken in order to prevent a more serious (for example,
                    service affecting) fault. Such a severity can be reported, for
                    example, when the detected alarm condition is not currently degrading
                    the capacity of the managed object (ITU-T Recommendation X.733).
                  * WARNING: The Warning severity level indicates the detection
                  of a
                    potential or impending service affecting fault, before any significant
                    effects have been felt. Action should be taken to further diagnose (if
                    necessary) and correct the problem in order to prevent it from
                    becoming a more serious service affecting fault (ITU-T Recommendation
                    X.733).
                  * INDETERMINATE: The Indeterminate severity level indicates
                  that the
                    severity level cannot be determined (ITU-T Recommendation X.733).
                  * CLEARED: The Cleared severity level indicates the clearing
                  of one or
                    more previously reported alarms. This alarm clears all alarms for this
                    managed object that have the same Alarm type, Probable cause and
                    Specific problems (if given) (ITU-T Recommendation X.733).
                type: string
                enum:
                  - CRITICAL
                  - MAJOR
                  - MINOR
                  - WARNING
                  - INDETERMINATE
                  - CLEARED
            eventTypes:
              description: |
                Match VNF alarms with an event type listed in this attribute.
              type: array
              items:
                description: >
                  The enumeration EventType represents those types of events
                  that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of
                  this type is associated with the
                    procedure and/or process required conveying information from one point
                    to another (ITU-T Recommendation X.733).
                  * PROCESSING_ERROR_ALARM: An alarm of this type is associated
                  with a
                    software or processing fault (ITU-T Recommendation X.733).
                  * ENVIRONMENTAL_ALARM: An alarm of this type is associated
                  with a
                    condition related to an enclosure in which the equipment resides
                    (ITU-T Recommendation X.733).
                  * QOS_ALARM: An alarm of this type is associated with
                  degradation in the
                    quality of a service (ITU-T Recommendation X.733).
                  * EQUIPMENT_ALARM: An alarm of this type is associated with an
                  equipment
                    fault (ITU-T Recommendation X.733).
                type: string
                enum:
                  - COMMUNICATIONS_ALARM
                  - PROCESSING_ERROR_ALARM
                  - ENVIRONMENTAL_ALARM
                  - QOS_ALARM
                  - EQUIPMENT_ALARM
            probableCauses:
              description: |
                Match VNF alarms with a probable cause listed in this attribute.
              type: array
              items:
                type: string
        callbackUri:
          description: |
            String formatted according to IETF RFC 3986.
          type: string
        authentication:
          type: object
          required:
            - authType
          properties:
            authType:
              description: >
                Defines the types of Authentication / Authorization which the
                API consumer is willing to accept when receiving a notification.
                Permitted values: * BASIC: In every HTTP request to the
                notification endpoint, use
                  HTTP Basic authentication with the client credentials.
                * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
                  notification endpoint, use an OAuth 2.0 Bearer token, obtained
                  using the client credentials grant type.
                * TLS_CERT: Every HTTP request to the notification endpoint is
                sent
                  over a mutually authenticated TLS session, i.e. not only the
                  server is authenticated, but also the client is authenticated
                  during the TLS tunnel setup.
              type: array
              items:
                type: string
                enum:
                  - BASIC
                  - OAUTH2_CLIENT_CREDENTIALS
                  - TLS_CERT
            paramsBasic:
              description: >
                Parameters for authentication/authorization using BASIC. Shall
                be present if authType is "BASIC" and the contained information
                has not been provisioned out of band. Shall be absent otherwise.
              type: object
              properties:
                userName:
                  description: >
                    Username to be used in HTTP Basic authentication. Shall be
                    present if it has not been provisioned out of band.
                  type: string
                password:
                  description: >
                    Password to be used in HTTP Basic authentication. Shall be
                    present if it has not been provisioned out of band.
                  type: string
            paramsOauth2ClientCredentials:
              description: >
                Parameters for authentication/authorization using
                OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is
                "OAUTH2_CLIENT_CREDENTIALS" and the contained information has
                not been provisioned out of band. Shall be absent otherwise.
              type: object
              properties:
                clientId:
                  description: >
                    Client identifier to be used in the access token request of
                    the OAuth 2.0 client credentials grant type. Shall be
                    present if it has not been provisioned out of band. The
                    clientId and clientPassword passed in a subscription shall
                    not be the same as the clientId and clientPassword that are
                    used to obtain authorization for API requests. Client
                    credentials may differ between subscriptions. The value of
                    clientPassword should be generated by a random process.
                  type: string
                clientPassword:
                  description: >
                    Client password to be used in the access token request of
                    the OAuth 2.0 client credentials grant type. Shall be
                    present if it has not been provisioned out of band. The
                    clientId and clientPassword passed in a subscription shall
                    not be the same as the clientId and clientPassword that are
                    used to obtain authorization for API requests. Client
                    credentials may differ between subscriptions. The value of
                    clientPassword should be generated by a random process.
                  type: string
                tokenEndpoint:
                  description: |
                    String formatted according to IETF RFC 3986.
                  type: string
    FmSubscription:
      description: >
        This type represents a subscription related to notifications about VNF
        faults.
      type: object
      required:
        - id
        - callbackUri
        - _links
      properties:
        id:
          description: |
            An identifier with the intention of being globally unique.
          type: string
        filter:
          description: >
            This type represents a subscription filter related to notifications
            about NFV-MANO functional entity faults. It shall comply with the
            provisions defined in table 7.6.3.2-1. At a particular nesting level
            in the filter structure, the following applies: All attributes shall
            match in order for the filter to match (logical "and" between
            different filter attributes). If an attribute is an array, the
            attribute shall match if at least one of the values in the array
            matches (logical "or" between the values of one filter attribute).
          type: object
          properties:
            notificationTypes:
              description: >
                Match particular notification types. Permitted values: *
                AlarmNotification * AlarmClearedNotification *
                AlarmListRebuiltNotification The permitted values of the
                "notificationTypes" attribute are spelled exactly as the names
                of the notification types to facilitate automated code
                generation systems.
              type: array
              items:
                type: string
                enum:
                  - AlarmNotification
                  - AlarmClearedNotification
                  - AlarmListRebuiltNotification
            perceivedSeverities:
              description: >
                Match VNF alarms with a perceived severity listed in this
                attribute.
              type: array
              items:
                description: >
                  Indicates the relative level of urgency for operator
                  attention. * CRITICAL: The Critical severity level indicates
                  that a service
                    affecting condition has occurred and an immediate corrective action
                    is required. Such a severity can be reported, for example, when a
                    managed object becomes totally out of service and its capability needs
                    to be restored (ITU-T Recommendation X.733).
                  * MAJOR: The Major severity level indicates that a service
                  affecting
                    condition has developed and an urgent corrective action is required.
                    Such a severity can be reported, for example, when there is a severe
                    degradation in the capability of the managed object and its full
                    capability needs to be restored (ITU-T Recommendation X.733).
                  * MINOR: The Minor severity level indicates the existence of a
                    non-service affecting fault condition and that corrective action
                    should be taken in order to prevent a more serious (for example,
                    service affecting) fault. Such a severity can be reported, for
                    example, when the detected alarm condition is not currently degrading
                    the capacity of the managed object (ITU-T Recommendation X.733).
                  * WARNING: The Warning severity level indicates the detection
                  of a
                    potential or impending service affecting fault, before any significant
                    effects have been felt. Action should be taken to further diagnose (if
                    necessary) and correct the problem in order to prevent it from
                    becoming a more serious service affecting fault (ITU-T Recommendation
                    X.733).
                  * INDETERMINATE: The Indeterminate severity level indicates
                  that the
                    severity level cannot be determined (ITU-T Recommendation X.733).
                  * CLEARED: The Cleared severity level indicates the clearing
                  of one or
                    more previously reported alarms. This alarm clears all alarms for this
                    managed object that have the same Alarm type, Probable cause and
                    Specific problems (if given) (ITU-T Recommendation X.733).
                type: string
                enum:
                  - CRITICAL
                  - MAJOR
                  - MINOR
                  - WARNING
                  - INDETERMINATE
                  - CLEARED
            eventTypes:
              description: |
                Match VNF alarms with an event type listed in this attribute.
              type: array
              items:
                description: >
                  The enumeration EventType represents those types of events
                  that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of
                  this type is associated with the
                    procedure and/or process required conveying information from one point
                    to another (ITU-T Recommendation X.733).
                  * PROCESSING_ERROR_ALARM: An alarm of this type is associated
                  with a
                    software or processing fault (ITU-T Recommendation X.733).
                  * ENVIRONMENTAL_ALARM: An alarm of this type is associated
                  with a
                    condition related to an enclosure in which the equipment resides
                    (ITU-T Recommendation X.733).
                  * QOS_ALARM: An alarm of this type is associated with
                  degradation in the
                    quality of a service (ITU-T Recommendation X.733).
                  * EQUIPMENT_ALARM: An alarm of this type is associated with an
                  equipment
                    fault (ITU-T Recommendation X.733).
                type: string
                enum:
                  - COMMUNICATIONS_ALARM
                  - PROCESSING_ERROR_ALARM
                  - ENVIRONMENTAL_ALARM
                  - QOS_ALARM
                  - EQUIPMENT_ALARM
            probableCauses:
              description: |
                Match VNF alarms with a probable cause listed in this attribute.
              type: array
              items:
                type: string
        callbackUri:
          description: |
            String formatted according to IETF RFC 3986.
          type: string
        _links:
          description: |
            Links for this resource.
          type: object
          required:
            - self
          properties:
            self:
              description: |
                This type represents a link to a resource using an absolute URI.
              type: object
              required:
                - href
              properties:
                href:
                  description: |
                    String formatted according to IETF RFC 3986.
                  type: string
    AlarmModifications:
      description: >
        This type represents attribute modifications for an "Individual alarm"
        resource, i.e. modifications to a resource representation based on the
        "Alarm" data type. The attributes of "Alarm" that can be modified are
        included in the "AlarmModifications" data type.
      type: object
      required:
        - ackState
      properties:
        ackState:
          description: >
            New value of the "ackState" attribute in "Alarm". Permitted values:
            * ACKNOWLEDGED
          type: string
          enum:
            - ACKNOWLEDGED
    FmNotificationsFilter:
      description: >
        This type represents a subscription filter related to notifications
        about NFV-MANO functional entity faults. It shall comply with the
        provisions defined in table 7.6.3.2-1. At a particular nesting level in
        the filter structure, the following applies: All attributes shall match
        in order for the filter to match (logical "and" between different filter
        attributes). If an attribute is an array, the attribute shall match if
        at least one of the values in the array matches (logical "or" between
        the values of one filter attribute).
      type: object
      properties:
        notificationTypes:
          description: >
            Match particular notification types. Permitted values: *
            AlarmNotification * AlarmClearedNotification *
            AlarmListRebuiltNotification The permitted values of the
            "notificationTypes" attribute are spelled exactly as the names of
            the notification types to facilitate automated code generation
            systems.
          type: array
          items:
            type: string
            enum:
              - AlarmNotification
              - AlarmClearedNotification
              - AlarmListRebuiltNotification
        perceivedSeverities:
          description: |
            Match VNF alarms with a perceived severity listed in this attribute.
          type: array
          items:
            description: >
              Indicates the relative level of urgency for operator attention. *
              CRITICAL: The Critical severity level indicates that a service
                affecting condition has occurred and an immediate corrective action
                is required. Such a severity can be reported, for example, when a
                managed object becomes totally out of service and its capability needs
                to be restored (ITU-T Recommendation X.733).
              * MAJOR: The Major severity level indicates that a service
              affecting
                condition has developed and an urgent corrective action is required.
                Such a severity can be reported, for example, when there is a severe
                degradation in the capability of the managed object and its full
                capability needs to be restored (ITU-T Recommendation X.733).
              * MINOR: The Minor severity level indicates the existence of a
                non-service affecting fault condition and that corrective action
                should be taken in order to prevent a more serious (for example,
                service affecting) fault. Such a severity can be reported, for
                example, when the detected alarm condition is not currently degrading
                the capacity of the managed object (ITU-T Recommendation X.733).
              * WARNING: The Warning severity level indicates the detection of a
                potential or impending service affecting fault, before any significant
                effects have been felt. Action should be taken to further diagnose (if
                necessary) and correct the problem in order to prevent it from
                becoming a more serious service affecting fault (ITU-T Recommendation
                X.733).
              * INDETERMINATE: The Indeterminate severity level indicates that
              the
                severity level cannot be determined (ITU-T Recommendation X.733).
              * CLEARED: The Cleared severity level indicates the clearing of
              one or
                more previously reported alarms. This alarm clears all alarms for this
                managed object that have the same Alarm type, Probable cause and
                Specific problems (if given) (ITU-T Recommendation X.733).
            type: string
            enum:
              - CRITICAL
              - MAJOR
              - MINOR
              - WARNING
              - INDETERMINATE
              - CLEARED
        eventTypes:
          description: |
            Match VNF alarms with an event type listed in this attribute.
          type: array
          items:
            description: >
              The enumeration EventType represents those types of events that
              trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is
              associated with the
                procedure and/or process required conveying information from one point
                to another (ITU-T Recommendation X.733).
              * PROCESSING_ERROR_ALARM: An alarm of this type is associated with
              a
                software or processing fault (ITU-T Recommendation X.733).
              * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a
                condition related to an enclosure in which the equipment resides
                (ITU-T Recommendation X.733).
              * QOS_ALARM: An alarm of this type is associated with degradation
              in the
                quality of a service (ITU-T Recommendation X.733).
              * EQUIPMENT_ALARM: An alarm of this type is associated with an
              equipment
                fault (ITU-T Recommendation X.733).
            type: string
            enum:
              - COMMUNICATIONS_ALARM
              - PROCESSING_ERROR_ALARM
              - ENVIRONMENTAL_ALARM
              - QOS_ALARM
              - EQUIPMENT_ALARM
        probableCauses:
          description: |
            Match VNF alarms with a probable cause listed in this attribute.
          type: array
          items:
            type: string
  requestBodies:
    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.
      content:
        application/json:
          schema:
            description: >
              This type represents attribute modifications for an "Individual
              alarm" resource, i.e. modifications to a resource representation
              based on the "Alarm" data type. The attributes of "Alarm" that can
              be modified are included in the "AlarmModifications" data type.
            type: object
            required:
              - ackState
            properties:
              ackState:
                description: >
                  New value of the "ackState" attribute in "Alarm". Permitted
                  values: * ACKNOWLEDGED
                type: string
                enum:
                  - ACKNOWLEDGED
      required: true
    FmSubscriptionRequest:
      description: |
        Details of the subscription to be created, as defined in clause 7.6.2.2.
      content:
        application/json:
          schema:
            description: >
              This type represents a subscription request related to
              notifications about NFV-MANO faults.
            type: object
            required:
              - callbackUri
            properties:
              filter:
                description: >
                  This type represents a subscription filter related to
                  notifications about NFV-MANO functional entity faults. It
                  shall comply with the provisions defined in table 7.6.3.2-1.
                  At a particular nesting level in the filter structure, the
                  following applies: All attributes shall match in order for the
                  filter to match (logical "and" between different filter
                  attributes). If an attribute is an array, the attribute shall
                  match if at least one of the values in the array matches
                  (logical "or" between the values of one filter attribute).
                type: object
                properties:
                  notificationTypes:
                    description: >
                      Match particular notification types. Permitted values: *
                      AlarmNotification * AlarmClearedNotification *
                      AlarmListRebuiltNotification The permitted values of the
                      "notificationTypes" attribute are spelled exactly as the
                      names of the notification types to facilitate automated
                      code generation systems.
                    type: array
                    items:
                      type: string
                      enum:
                        - AlarmNotification
                        - AlarmClearedNotification
                        - AlarmListRebuiltNotification
                  perceivedSeverities:
                    description: >
                      Match VNF alarms with a perceived severity listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        Indicates the relative level of urgency for operator
                        attention. * CRITICAL: The Critical severity level
                        indicates that a service
                          affecting condition has occurred and an immediate corrective action
                          is required. Such a severity can be reported, for example, when a
                          managed object becomes totally out of service and its capability needs
                          to be restored (ITU-T Recommendation X.733).
                        * MAJOR: The Major severity level indicates that a
                        service affecting
                          condition has developed and an urgent corrective action is required.
                          Such a severity can be reported, for example, when there is a severe
                          degradation in the capability of the managed object and its full
                          capability needs to be restored (ITU-T Recommendation X.733).
                        * MINOR: The Minor severity level indicates the
                        existence of a
                          non-service affecting fault condition and that corrective action
                          should be taken in order to prevent a more serious (for example,
                          service affecting) fault. Such a severity can be reported, for
                          example, when the detected alarm condition is not currently degrading
                          the capacity of the managed object (ITU-T Recommendation X.733).
                        * WARNING: The Warning severity level indicates the
                        detection of a
                          potential or impending service affecting fault, before any significant
                          effects have been felt. Action should be taken to further diagnose (if
                          necessary) and correct the problem in order to prevent it from
                          becoming a more serious service affecting fault (ITU-T Recommendation
                          X.733).
                        * INDETERMINATE: The Indeterminate severity level
                        indicates that the
                          severity level cannot be determined (ITU-T Recommendation X.733).
                        * CLEARED: The Cleared severity level indicates the
                        clearing of one or
                          more previously reported alarms. This alarm clears all alarms for this
                          managed object that have the same Alarm type, Probable cause and
                          Specific problems (if given) (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - CRITICAL
                        - MAJOR
                        - MINOR
                        - WARNING
                        - INDETERMINATE
                        - CLEARED
                  eventTypes:
                    description: >
                      Match VNF alarms with an event type listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        The enumeration EventType represents those types of
                        events that trigger an alarm. * COMMUNICATIONS_ALARM: An
                        alarm of this type is associated with the
                          procedure and/or process required conveying information from one point
                          to another (ITU-T Recommendation X.733).
                        * PROCESSING_ERROR_ALARM: An alarm of this type is
                        associated with a
                          software or processing fault (ITU-T Recommendation X.733).
                        * ENVIRONMENTAL_ALARM: An alarm of this type is
                        associated with a
                          condition related to an enclosure in which the equipment resides
                          (ITU-T Recommendation X.733).
                        * QOS_ALARM: An alarm of this type is associated with
                        degradation in the
                          quality of a service (ITU-T Recommendation X.733).
                        * EQUIPMENT_ALARM: An alarm of this type is associated
                        with an equipment
                          fault (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - COMMUNICATIONS_ALARM
                        - PROCESSING_ERROR_ALARM
                        - ENVIRONMENTAL_ALARM
                        - QOS_ALARM
                        - EQUIPMENT_ALARM
                  probableCauses:
                    description: >
                      Match VNF alarms with a probable cause listed in this
                      attribute.
                    type: array
                    items:
                      type: string
              callbackUri:
                description: |
                  String formatted according to IETF RFC 3986.
                type: string
              authentication:
                type: object
                required:
                  - authType
                properties:
                  authType:
                    description: >
                      Defines the types of Authentication / Authorization which
                      the API consumer is willing to accept when receiving a
                      notification. Permitted values: * BASIC: In every HTTP
                      request to the notification endpoint, use
                        HTTP Basic authentication with the client credentials.
                      * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
                        notification endpoint, use an OAuth 2.0 Bearer token, obtained
                        using the client credentials grant type.
                      * TLS_CERT: Every HTTP request to the notification
                      endpoint is sent
                        over a mutually authenticated TLS session, i.e. not only the
                        server is authenticated, but also the client is authenticated
                        during the TLS tunnel setup.
                    type: array
                    items:
                      type: string
                      enum:
                        - BASIC
                        - OAUTH2_CLIENT_CREDENTIALS
                        - TLS_CERT
                  paramsBasic:
                    description: >
                      Parameters for authentication/authorization using BASIC.
                      Shall be present if authType is "BASIC" and the contained
                      information has not been provisioned out of band. Shall be
                      absent otherwise.
                    type: object
                    properties:
                      userName:
                        description: >
                          Username to be used in HTTP Basic authentication.
                          Shall be present if it has not been provisioned out of
                          band.
                        type: string
                      password:
                        description: >
                          Password to be used in HTTP Basic authentication.
                          Shall be present if it has not been provisioned out of
                          band.
                        type: string
                  paramsOauth2ClientCredentials:
                    description: >
                      Parameters for authentication/authorization using
                      OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is
                      "OAUTH2_CLIENT_CREDENTIALS" and the contained information
                      has not been provisioned out of band. Shall be absent
                      otherwise.
                    type: object
                    properties:
                      clientId:
                        description: >
                          Client identifier to be used in the access token
                          request of the OAuth 2.0 client credentials grant
                          type. Shall be present if it has not been provisioned
                          out of band. The clientId and clientPassword passed in
                          a subscription shall not be the same as the clientId
                          and clientPassword that are used to obtain
                          authorization for API requests. Client credentials may
                          differ between subscriptions. The value of
                          clientPassword should be generated by a random
                          process.
                        type: string
                      clientPassword:
                        description: >
                          Client password to be used in the access token request
                          of the OAuth 2.0 client credentials grant type. Shall
                          be present if it has not been provisioned out of band.
                          The clientId and clientPassword passed in a
                          subscription shall not be the same as the clientId and
                          clientPassword that are used to obtain authorization
                          for API requests. Client credentials may differ
                          between subscriptions. The value of clientPassword
                          should be generated by a random process.
                        type: string
                      tokenEndpoint:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
      required: true
  responses:
    Alarms.Get:
      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:
              description: |
                The alarm data type encapsulates information about an alarm.
              type: object
              required:
                - id
                - managedObjectId
                - alarmRaisedTime
                - ackState
                - perceivedSeverity
                - eventTime
                - eventType
                - probableCause
                - isRootCause
                - _links
              properties:
                id:
                  description: |
                    An identifier with the intention of being globally unique.
                  type: string
                managedObjectId:
                  description: |
                    An identifier with the intention of being globally unique.
                  type: string
                associatedFaultyInstanceId:
                  description: >
                    This type represents the identifier to reference a managed
                    object of a  particular type. 
                  type: object
                  properties:
                    type:
                      description: >
                        Indicates the type of managed object. Permitted values:
                          - MANO_ENTITY
                          - MANO_SERVICE
                          - MANO_SERVICE_IF
                          - CONSUMED_MANO_IF
                          - MANO_ENTITY_COMPONENT

                        The "MANO_ENTITY COMPONENT" is only applicable if
                        attribute "manoEntityComponents" in "ManoEntity" is
                        supported by the API producer.
                      type: string
                      enum:
                        - MANO_ENTITY
                        - MANO_SERVICE
                        - MANO_SERVICE_IF
                        - CONSUMED_MANO_IF
                        - MANO_ENTITY_COMPONENT
                    objectId:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    subObjectId:
                      description: >
                        An identifier that is unique for the respective type
                        within a NFV-MANO functional entity, but that need not
                        be globally unique. Representation: string of variable
                        length..
                      type: string
                  required:
                    - type
                    - objectId
                alarmRaisedTime:
                  description: >
                    Date-time stamp. Representation: String formatted according
                    to IETF RFC 3339.
                  type: string
                  format: date-time
                alarmChangedTime:
                  description: >
                    Date-time stamp. Representation: String formatted according
                    to IETF RFC 3339.
                  type: string
                  format: date-time
                alarmClearedTime:
                  description: >
                    Date-time stamp. Representation: String formatted according
                    to IETF RFC 3339.
                  type: string
                  format: date-time
                ackState:
                  description: >
                    Acknowledgement state of the alarm. Permitted values: *
                    UNACKNOWLEDGED * ACKNOWLEDGED.
                  type: string
                  enum:
                    - UNACKNOWLEDGED
                    - ACKNOWLEDGED
                perceivedSeverity:
                  description: >
                    Indicates the relative level of urgency for operator
                    attention. * CRITICAL: The Critical severity level indicates
                    that a service
                      affecting condition has occurred and an immediate corrective action
                      is required. Such a severity can be reported, for example, when a
                      managed object becomes totally out of service and its capability needs
                      to be restored (ITU-T Recommendation X.733).
                    * MAJOR: The Major severity level indicates that a service
                    affecting
                      condition has developed and an urgent corrective action is required.
                      Such a severity can be reported, for example, when there is a severe
                      degradation in the capability of the managed object and its full
                      capability needs to be restored (ITU-T Recommendation X.733).
                    * MINOR: The Minor severity level indicates the existence of
                    a
                      non-service affecting fault condition and that corrective action
                      should be taken in order to prevent a more serious (for example,
                      service affecting) fault. Such a severity can be reported, for
                      example, when the detected alarm condition is not currently degrading
                      the capacity of the managed object (ITU-T Recommendation X.733).
                    * WARNING: The Warning severity level indicates the
                    detection of a
                      potential or impending service affecting fault, before any significant
                      effects have been felt. Action should be taken to further diagnose (if
                      necessary) and correct the problem in order to prevent it from
                      becoming a more serious service affecting fault (ITU-T Recommendation
                      X.733).
                    * INDETERMINATE: The Indeterminate severity level indicates
                    that the
                      severity level cannot be determined (ITU-T Recommendation X.733).
                    * CLEARED: The Cleared severity level indicates the clearing
                    of one or
                      more previously reported alarms. This alarm clears all alarms for this
                      managed object that have the same Alarm type, Probable cause and
                      Specific problems (if given) (ITU-T Recommendation X.733).
                  type: string
                  enum:
                    - CRITICAL
                    - MAJOR
                    - MINOR
                    - WARNING
                    - INDETERMINATE
                    - CLEARED
                eventTime:
                  description: >
                    Date-time stamp. Representation: String formatted according
                    to IETF RFC 3339.
                  type: string
                  format: date-time
                eventType:
                  description: >
                    The enumeration EventType represents those types of events
                    that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of
                    this type is associated with the
                      procedure and/or process required conveying information from one point
                      to another (ITU-T Recommendation X.733).
                    * PROCESSING_ERROR_ALARM: An alarm of this type is
                    associated with a
                      software or processing fault (ITU-T Recommendation X.733).
                    * ENVIRONMENTAL_ALARM: An alarm of this type is associated
                    with a
                      condition related to an enclosure in which the equipment resides
                      (ITU-T Recommendation X.733).
                    * QOS_ALARM: An alarm of this type is associated with
                    degradation in the
                      quality of a service (ITU-T Recommendation X.733).
                    * EQUIPMENT_ALARM: An alarm of this type is associated with
                    an equipment
                      fault (ITU-T Recommendation X.733).
                  type: string
                  enum:
                    - COMMUNICATIONS_ALARM
                    - PROCESSING_ERROR_ALARM
                    - ENVIRONMENTAL_ALARM
                    - QOS_ALARM
                    - EQUIPMENT_ALARM
                faultType:
                  description: |
                    Additional information to clarify the type of the fault.
                  type: string
                probableCause:
                  description: |
                    Information about the probable cause of the fault.
                  type: string
                isRootCause:
                  description: >
                    Attribute indicating if this fault is the root for other
                    correlated alarms. If true, then the alarms listed in the
                    attribute CorrelatedAlarmId are caused by this fault.
                  type: boolean
                correlatedAlarmIds:
                  description: >
                    List of identifiers of other alarms correlated to this
                    fault.
                  type: array
                  items:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                faultDetails:
                  description: |
                    Provides additional information about the fault.
                  type: array
                  items:
                    type: string
                _links:
                  description: |
                    Links for this resource.
                  type: object
                  required:
                    - self
                  properties:
                    self:
                      description: >
                        This type represents a link to a resource using an
                        absolute URI.
                      type: object
                      required:
                        - href
                      properties:
                        href:
                          description: |
                            String formatted according to IETF RFC 3986.
                          type: string
                    objectInstance:
                      description: >
                        This type represents a link to a resource using an
                        absolute URI.
                      type: object
                      required:
                        - href
                      properties:
                        href:
                          description: |
                            String formatted according to IETF RFC 3986.
                          type: string
    Alarm.Get:
      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:
            description: |
              The alarm data type encapsulates information about an alarm.
            type: object
            required:
              - id
              - managedObjectId
              - alarmRaisedTime
              - ackState
              - perceivedSeverity
              - eventTime
              - eventType
              - probableCause
              - isRootCause
              - _links
            properties:
              id:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              managedObjectId:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              associatedFaultyInstanceId:
                description: >
                  This type represents the identifier to reference a managed
                  object of a  particular type. 
                type: object
                properties:
                  type:
                    description: >
                      Indicates the type of managed object. Permitted values:
                        - MANO_ENTITY
                        - MANO_SERVICE
                        - MANO_SERVICE_IF
                        - CONSUMED_MANO_IF
                        - MANO_ENTITY_COMPONENT

                      The "MANO_ENTITY COMPONENT" is only applicable if
                      attribute "manoEntityComponents" in "ManoEntity" is
                      supported by the API producer.
                    type: string
                    enum:
                      - MANO_ENTITY
                      - MANO_SERVICE
                      - MANO_SERVICE_IF
                      - CONSUMED_MANO_IF
                      - MANO_ENTITY_COMPONENT
                  objectId:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  subObjectId:
                    description: >
                      An identifier that is unique for the respective type
                      within a NFV-MANO functional entity, but that need not be
                      globally unique. Representation: string of variable
                      length..
                    type: string
                required:
                  - type
                  - objectId
              alarmRaisedTime:
                description: >
                  Date-time stamp. Representation: String formatted according to
                  IETF RFC 3339.
                type: string
                format: date-time
              alarmChangedTime:
                description: >
                  Date-time stamp. Representation: String formatted according to
                  IETF RFC 3339.
                type: string
                format: date-time
              alarmClearedTime:
                description: >
                  Date-time stamp. Representation: String formatted according to
                  IETF RFC 3339.
                type: string
                format: date-time
              ackState:
                description: >
                  Acknowledgement state of the alarm. Permitted values: *
                  UNACKNOWLEDGED * ACKNOWLEDGED.
                type: string
                enum:
                  - UNACKNOWLEDGED
                  - ACKNOWLEDGED
              perceivedSeverity:
                description: >
                  Indicates the relative level of urgency for operator
                  attention. * CRITICAL: The Critical severity level indicates
                  that a service
                    affecting condition has occurred and an immediate corrective action
                    is required. Such a severity can be reported, for example, when a
                    managed object becomes totally out of service and its capability needs
                    to be restored (ITU-T Recommendation X.733).
                  * MAJOR: The Major severity level indicates that a service
                  affecting
                    condition has developed and an urgent corrective action is required.
                    Such a severity can be reported, for example, when there is a severe
                    degradation in the capability of the managed object and its full
                    capability needs to be restored (ITU-T Recommendation X.733).
                  * MINOR: The Minor severity level indicates the existence of a
                    non-service affecting fault condition and that corrective action
                    should be taken in order to prevent a more serious (for example,
                    service affecting) fault. Such a severity can be reported, for
                    example, when the detected alarm condition is not currently degrading
                    the capacity of the managed object (ITU-T Recommendation X.733).
                  * WARNING: The Warning severity level indicates the detection
                  of a
                    potential or impending service affecting fault, before any significant
                    effects have been felt. Action should be taken to further diagnose (if
                    necessary) and correct the problem in order to prevent it from
                    becoming a more serious service affecting fault (ITU-T Recommendation
                    X.733).
                  * INDETERMINATE: The Indeterminate severity level indicates
                  that the
                    severity level cannot be determined (ITU-T Recommendation X.733).
                  * CLEARED: The Cleared severity level indicates the clearing
                  of one or
                    more previously reported alarms. This alarm clears all alarms for this
                    managed object that have the same Alarm type, Probable cause and
                    Specific problems (if given) (ITU-T Recommendation X.733).
                type: string
                enum:
                  - CRITICAL
                  - MAJOR
                  - MINOR
                  - WARNING
                  - INDETERMINATE
                  - CLEARED
              eventTime:
                description: >
                  Date-time stamp. Representation: String formatted according to
                  IETF RFC 3339.
                type: string
                format: date-time
              eventType:
                description: >
                  The enumeration EventType represents those types of events
                  that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of
                  this type is associated with the
                    procedure and/or process required conveying information from one point
                    to another (ITU-T Recommendation X.733).
                  * PROCESSING_ERROR_ALARM: An alarm of this type is associated
                  with a
                    software or processing fault (ITU-T Recommendation X.733).
                  * ENVIRONMENTAL_ALARM: An alarm of this type is associated
                  with a
                    condition related to an enclosure in which the equipment resides
                    (ITU-T Recommendation X.733).
                  * QOS_ALARM: An alarm of this type is associated with
                  degradation in the
                    quality of a service (ITU-T Recommendation X.733).
                  * EQUIPMENT_ALARM: An alarm of this type is associated with an
                  equipment
                    fault (ITU-T Recommendation X.733).
                type: string
                enum:
                  - COMMUNICATIONS_ALARM
                  - PROCESSING_ERROR_ALARM
                  - ENVIRONMENTAL_ALARM
                  - QOS_ALARM
                  - EQUIPMENT_ALARM
              faultType:
                description: |
                  Additional information to clarify the type of the fault.
                type: string
              probableCause:
                description: |
                  Information about the probable cause of the fault.
                type: string
              isRootCause:
                description: >
                  Attribute indicating if this fault is the root for other
                  correlated alarms. If true, then the alarms listed in the
                  attribute CorrelatedAlarmId are caused by this fault.
                type: boolean
              correlatedAlarmIds:
                description: |
                  List of identifiers of other alarms correlated to this fault.
                type: array
                items:
                  description: |
                    An identifier with the intention of being globally unique.
                  type: string
              faultDetails:
                description: |
                  Provides additional information about the fault.
                type: array
                items:
                  type: string
              _links:
                description: |
                  Links for this resource.
                type: object
                required:
                  - self
                properties:
                  self:
                    description: >
                      This type represents a link to a resource using an
                      absolute URI.
                    type: object
                    required:
                      - href
                    properties:
                      href:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
                  objectInstance:
                    description: >
                      This type represents a link to a resource using an
                      absolute URI.
                    type: object
                    required:
                      - href
                    properties:
                      href:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
    Alarm.Patch:
      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:
            description: >
              This type represents attribute modifications for an "Individual
              alarm" resource, i.e. modifications to a resource representation
              based on the "Alarm" data type. The attributes of "Alarm" that can
              be modified are included in the "AlarmModifications" data type.
            type: object
            required:
              - ackState
            properties:
              ackState:
                description: >
                  New value of the "ackState" attribute in "Alarm". Permitted
                  values: * ACKNOWLEDGED
                type: string
                enum:
                  - ACKNOWLEDGED
    subscriptions.post.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:
            description: >
              This type represents a subscription related to notifications about
              VNF faults.
            type: object
            required:
              - id
              - callbackUri
              - _links
            properties:
              id:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              filter:
                description: >
                  This type represents a subscription filter related to
                  notifications about NFV-MANO functional entity faults. It
                  shall comply with the provisions defined in table 7.6.3.2-1.
                  At a particular nesting level in the filter structure, the
                  following applies: All attributes shall match in order for the
                  filter to match (logical "and" between different filter
                  attributes). If an attribute is an array, the attribute shall
                  match if at least one of the values in the array matches
                  (logical "or" between the values of one filter attribute).
                type: object
                properties:
                  notificationTypes:
                    description: >
                      Match particular notification types. Permitted values: *
                      AlarmNotification * AlarmClearedNotification *
                      AlarmListRebuiltNotification The permitted values of the
                      "notificationTypes" attribute are spelled exactly as the
                      names of the notification types to facilitate automated
                      code generation systems.
                    type: array
                    items:
                      type: string
                      enum:
                        - AlarmNotification
                        - AlarmClearedNotification
                        - AlarmListRebuiltNotification
                  perceivedSeverities:
                    description: >
                      Match VNF alarms with a perceived severity listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        Indicates the relative level of urgency for operator
                        attention. * CRITICAL: The Critical severity level
                        indicates that a service
                          affecting condition has occurred and an immediate corrective action
                          is required. Such a severity can be reported, for example, when a
                          managed object becomes totally out of service and its capability needs
                          to be restored (ITU-T Recommendation X.733).
                        * MAJOR: The Major severity level indicates that a
                        service affecting
                          condition has developed and an urgent corrective action is required.
                          Such a severity can be reported, for example, when there is a severe
                          degradation in the capability of the managed object and its full
                          capability needs to be restored (ITU-T Recommendation X.733).
                        * MINOR: The Minor severity level indicates the
                        existence of a
                          non-service affecting fault condition and that corrective action
                          should be taken in order to prevent a more serious (for example,
                          service affecting) fault. Such a severity can be reported, for
                          example, when the detected alarm condition is not currently degrading
                          the capacity of the managed object (ITU-T Recommendation X.733).
                        * WARNING: The Warning severity level indicates the
                        detection of a
                          potential or impending service affecting fault, before any significant
                          effects have been felt. Action should be taken to further diagnose (if
                          necessary) and correct the problem in order to prevent it from
                          becoming a more serious service affecting fault (ITU-T Recommendation
                          X.733).
                        * INDETERMINATE: The Indeterminate severity level
                        indicates that the
                          severity level cannot be determined (ITU-T Recommendation X.733).
                        * CLEARED: The Cleared severity level indicates the
                        clearing of one or
                          more previously reported alarms. This alarm clears all alarms for this
                          managed object that have the same Alarm type, Probable cause and
                          Specific problems (if given) (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - CRITICAL
                        - MAJOR
                        - MINOR
                        - WARNING
                        - INDETERMINATE
                        - CLEARED
                  eventTypes:
                    description: >
                      Match VNF alarms with an event type listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        The enumeration EventType represents those types of
                        events that trigger an alarm. * COMMUNICATIONS_ALARM: An
                        alarm of this type is associated with the
                          procedure and/or process required conveying information from one point
                          to another (ITU-T Recommendation X.733).
                        * PROCESSING_ERROR_ALARM: An alarm of this type is
                        associated with a
                          software or processing fault (ITU-T Recommendation X.733).
                        * ENVIRONMENTAL_ALARM: An alarm of this type is
                        associated with a
                          condition related to an enclosure in which the equipment resides
                          (ITU-T Recommendation X.733).
                        * QOS_ALARM: An alarm of this type is associated with
                        degradation in the
                          quality of a service (ITU-T Recommendation X.733).
                        * EQUIPMENT_ALARM: An alarm of this type is associated
                        with an equipment
                          fault (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - COMMUNICATIONS_ALARM
                        - PROCESSING_ERROR_ALARM
                        - ENVIRONMENTAL_ALARM
                        - QOS_ALARM
                        - EQUIPMENT_ALARM
                  probableCauses:
                    description: >
                      Match VNF alarms with a probable cause listed in this
                      attribute.
                    type: array
                    items:
                      type: string
              callbackUri:
                description: |
                  String formatted according to IETF RFC 3986.
                type: string
              _links:
                description: |
                  Links for this resource.
                type: object
                required:
                  - self
                properties:
                  self:
                    description: >
                      This type represents a link to a resource using an
                      absolute URI.
                    type: object
                    required:
                      - href
                    properties:
                      href:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
    subscriptions.get.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:
            type: array
            items:
              description: >
                This type represents a subscription related to notifications
                about VNF faults.
              type: object
              required:
                - id
                - callbackUri
                - _links
              properties:
                id:
                  description: |
                    An identifier with the intention of being globally unique.
                  type: string
                filter:
                  description: >
                    This type represents a subscription filter related to
                    notifications about NFV-MANO functional entity faults. It
                    shall comply with the provisions defined in table 7.6.3.2-1.
                    At a particular nesting level in the filter structure, the
                    following applies: All attributes shall match in order for
                    the filter to match (logical "and" between different filter
                    attributes). If an attribute is an array, the attribute
                    shall match if at least one of the values in the array
                    matches (logical "or" between the values of one filter
                    attribute).
                  type: object
                  properties:
                    notificationTypes:
                      description: >
                        Match particular notification types. Permitted values: *
                        AlarmNotification * AlarmClearedNotification *
                        AlarmListRebuiltNotification The permitted values of the
                        "notificationTypes" attribute are spelled exactly as the
                        names of the notification types to facilitate automated
                        code generation systems.
                      type: array
                      items:
                        type: string
                        enum:
                          - AlarmNotification
                          - AlarmClearedNotification
                          - AlarmListRebuiltNotification
                    perceivedSeverities:
                      description: >
                        Match VNF alarms with a perceived severity listed in
                        this attribute.
                      type: array
                      items:
                        description: >
                          Indicates the relative level of urgency for operator
                          attention. * CRITICAL: The Critical severity level
                          indicates that a service
                            affecting condition has occurred and an immediate corrective action
                            is required. Such a severity can be reported, for example, when a
                            managed object becomes totally out of service and its capability needs
                            to be restored (ITU-T Recommendation X.733).
                          * MAJOR: The Major severity level indicates that a
                          service affecting
                            condition has developed and an urgent corrective action is required.
                            Such a severity can be reported, for example, when there is a severe
                            degradation in the capability of the managed object and its full
                            capability needs to be restored (ITU-T Recommendation X.733).
                          * MINOR: The Minor severity level indicates the
                          existence of a
                            non-service affecting fault condition and that corrective action
                            should be taken in order to prevent a more serious (for example,
                            service affecting) fault. Such a severity can be reported, for
                            example, when the detected alarm condition is not currently degrading
                            the capacity of the managed object (ITU-T Recommendation X.733).
                          * WARNING: The Warning severity level indicates the
                          detection of a
                            potential or impending service affecting fault, before any significant
                            effects have been felt. Action should be taken to further diagnose (if
                            necessary) and correct the problem in order to prevent it from
                            becoming a more serious service affecting fault (ITU-T Recommendation
                            X.733).
                          * INDETERMINATE: The Indeterminate severity level
                          indicates that the
                            severity level cannot be determined (ITU-T Recommendation X.733).
                          * CLEARED: The Cleared severity level indicates the
                          clearing of one or
                            more previously reported alarms. This alarm clears all alarms for this
                            managed object that have the same Alarm type, Probable cause and
                            Specific problems (if given) (ITU-T Recommendation X.733).
                        type: string
                        enum:
                          - CRITICAL
                          - MAJOR
                          - MINOR
                          - WARNING
                          - INDETERMINATE
                          - CLEARED
                    eventTypes:
                      description: >
                        Match VNF alarms with an event type listed in this
                        attribute.
                      type: array
                      items:
                        description: >
                          The enumeration EventType represents those types of
                          events that trigger an alarm. * COMMUNICATIONS_ALARM:
                          An alarm of this type is associated with the
                            procedure and/or process required conveying information from one point
                            to another (ITU-T Recommendation X.733).
                          * PROCESSING_ERROR_ALARM: An alarm of this type is
                          associated with a
                            software or processing fault (ITU-T Recommendation X.733).
                          * ENVIRONMENTAL_ALARM: An alarm of this type is
                          associated with a
                            condition related to an enclosure in which the equipment resides
                            (ITU-T Recommendation X.733).
                          * QOS_ALARM: An alarm of this type is associated with
                          degradation in the
                            quality of a service (ITU-T Recommendation X.733).
                          * EQUIPMENT_ALARM: An alarm of this type is associated
                          with an equipment
                            fault (ITU-T Recommendation X.733).
                        type: string
                        enum:
                          - COMMUNICATIONS_ALARM
                          - PROCESSING_ERROR_ALARM
                          - ENVIRONMENTAL_ALARM
                          - QOS_ALARM
                          - EQUIPMENT_ALARM
                    probableCauses:
                      description: >
                        Match VNF alarms with a probable cause listed in this
                        attribute.
                      type: array
                      items:
                        type: string
                callbackUri:
                  description: |
                    String formatted according to IETF RFC 3986.
                  type: string
                _links:
                  description: |
                    Links for this resource.
                  type: object
                  required:
                    - self
                  properties:
                    self:
                      description: >
                        This type represents a link to a resource using an
                        absolute URI.
                      type: object
                      required:
                        - href
                      properties:
                        href:
                          description: |
                            String formatted according to IETF RFC 3986.
                          type: string
    subscription.get.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:
            description: >
              This type represents a subscription related to notifications about
              VNF faults.
            type: object
            required:
              - id
              - callbackUri
              - _links
            properties:
              id:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              filter:
                description: >
                  This type represents a subscription filter related to
                  notifications about NFV-MANO functional entity faults. It
                  shall comply with the provisions defined in table 7.6.3.2-1.
                  At a particular nesting level in the filter structure, the
                  following applies: All attributes shall match in order for the
                  filter to match (logical "and" between different filter
                  attributes). If an attribute is an array, the attribute shall
                  match if at least one of the values in the array matches
                  (logical "or" between the values of one filter attribute).
                type: object
                properties:
                  notificationTypes:
                    description: >
                      Match particular notification types. Permitted values: *
                      AlarmNotification * AlarmClearedNotification *
                      AlarmListRebuiltNotification The permitted values of the
                      "notificationTypes" attribute are spelled exactly as the
                      names of the notification types to facilitate automated
                      code generation systems.
                    type: array
                    items:
                      type: string
                      enum:
                        - AlarmNotification
                        - AlarmClearedNotification
                        - AlarmListRebuiltNotification
                  perceivedSeverities:
                    description: >
                      Match VNF alarms with a perceived severity listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        Indicates the relative level of urgency for operator
                        attention. * CRITICAL: The Critical severity level
                        indicates that a service
                          affecting condition has occurred and an immediate corrective action
                          is required. Such a severity can be reported, for example, when a
                          managed object becomes totally out of service and its capability needs
                          to be restored (ITU-T Recommendation X.733).
                        * MAJOR: The Major severity level indicates that a
                        service affecting
                          condition has developed and an urgent corrective action is required.
                          Such a severity can be reported, for example, when there is a severe
                          degradation in the capability of the managed object and its full
                          capability needs to be restored (ITU-T Recommendation X.733).
                        * MINOR: The Minor severity level indicates the
                        existence of a
                          non-service affecting fault condition and that corrective action
                          should be taken in order to prevent a more serious (for example,
                          service affecting) fault. Such a severity can be reported, for
                          example, when the detected alarm condition is not currently degrading
                          the capacity of the managed object (ITU-T Recommendation X.733).
                        * WARNING: The Warning severity level indicates the
                        detection of a
                          potential or impending service affecting fault, before any significant
                          effects have been felt. Action should be taken to further diagnose (if
                          necessary) and correct the problem in order to prevent it from
                          becoming a more serious service affecting fault (ITU-T Recommendation
                          X.733).
                        * INDETERMINATE: The Indeterminate severity level
                        indicates that the
                          severity level cannot be determined (ITU-T Recommendation X.733).
                        * CLEARED: The Cleared severity level indicates the
                        clearing of one or
                          more previously reported alarms. This alarm clears all alarms for this
                          managed object that have the same Alarm type, Probable cause and
                          Specific problems (if given) (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - CRITICAL
                        - MAJOR
                        - MINOR
                        - WARNING
                        - INDETERMINATE
                        - CLEARED
                  eventTypes:
                    description: >
                      Match VNF alarms with an event type listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        The enumeration EventType represents those types of
                        events that trigger an alarm. * COMMUNICATIONS_ALARM: An
                        alarm of this type is associated with the
                          procedure and/or process required conveying information from one point
                          to another (ITU-T Recommendation X.733).
                        * PROCESSING_ERROR_ALARM: An alarm of this type is
                        associated with a
                          software or processing fault (ITU-T Recommendation X.733).
                        * ENVIRONMENTAL_ALARM: An alarm of this type is
                        associated with a
                          condition related to an enclosure in which the equipment resides
                          (ITU-T Recommendation X.733).
                        * QOS_ALARM: An alarm of this type is associated with
                        degradation in the
                          quality of a service (ITU-T Recommendation X.733).
                        * EQUIPMENT_ALARM: An alarm of this type is associated
                        with an equipment
                          fault (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - COMMUNICATIONS_ALARM
                        - PROCESSING_ERROR_ALARM
                        - ENVIRONMENTAL_ALARM
                        - QOS_ALARM
                        - EQUIPMENT_ALARM
                  probableCauses:
                    description: >
                      Match VNF alarms with a probable cause listed in this
                      attribute.
                    type: array
                    items:
                      type: string
              callbackUri:
                description: |
                  String formatted according to IETF RFC 3986.
                type: string
              _links:
                description: |
                  Links for this resource.
                type: object
                required:
                  - self
                properties:
                  self:
                    description: >
                      This type represents a link to a resource using an
                      absolute URI.
                    type: object
                    required:
                      - href
                    properties:
                      href:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
    subscription.delete.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