openapi: 3.0.2
info:
  title: SOL003 - Virtualised Resources Quota Available Notification interface
  description: |
    SOL003 - Virtualised Resources Quota Available Notification interface 

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

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
  version: '1.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1'
externalDocs:
  description: ETSI GS NFV-SOL 003 V5.1.1
  url: >-
    https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/05.01.01_60/gs_NFV-SOL003v050101p.pdf
servers:
  - url: 'http://127.0.0.1/vrqan/v1'
  - url: 'https://127.0.0.1/vrqan/v1'
paths:
  /api_versions:
    get:
      description: >
        The GET method reads API version information. This method shall follow
        the provisions specified in SOL013 table 9.3.3.3.2-1 for request and
        response data structures, and response codes. URI query parameters are
        not supported.
      responses:
        '200':
          description: >
            API version information was read successfully. The response body
            shall contain API version information, as defined in clause 7.1.6.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              schema:
                type: string
                maximum: 1
                minimum: 1
            Version:
              description: The used API version.
              schema:
                type: string
                maximum: 1
                minimum: 1
          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
        '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 message
            content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 CONTENT

            If the message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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
    post:
      description: >
        This method is not supported. When this method is requested on this
        resource, the API producer shall return a "405 Method Not Allowed"
        response as defined in SOL013 clause 6.4.
      responses:
        '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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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
    put:
      description: >
        This method is not supported. When this method is requested on this
        resource, the API producer shall return a "405 Method Not Allowed"
        response as defined in SOL013 clause 6.4.
      responses:
        '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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is not supported. When this method is requested on this
        resource, the API producer shall return a "405 Method Not Allowed"
        response as defined in SOL013 clause 6.4.
      responses:
        '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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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: >
        This method is not supported. When this method is requested on this
        resource, the API producer shall return a "405 Method Not Allowed"
        response as defined in SOL013 clause 6.4.
      responses:
        '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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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:
    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
    post:
      description: |
        The POST method creates a new subscription. See clause 11.4.2.3.1.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231.
          in: header
          required: true
          schema:
            type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/VrQuotaAvailSubscriptionRequest'
      responses:
        '201':
          $ref: '#/components/responses/Subscriptions.Post.201'
        '303':
          $ref: '#/components/responses/Subscriptions.Post.303'
        '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 message
            content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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':
          $ref: '#/components/responses/Subscriptions.Post.422'
        '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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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: >
        The GET method queries the list of active subscriptions of the
        functional block that invokes the method.

        It can be used e.g. for resynchronization after error situations. See
        clause 11.4.2.3.2.
      parameters:
        - $ref: '#/components/parameters/filter_subscriptions'
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be
            supported by the VNFM if the VNFM supports alternative 2 (paging)
            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [8] for this
            resource.
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          $ref: '#/components/responses/Subscriptions.Get.200'
        '204':
          $ref: '#/components/responses/Subscriptions.Get.204'
        '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 message
            content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 CONTENT

            If the message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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:
      - $ref: '#/components/parameters/SubscriptionId'
      - 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
    get:
      description: |
        The GET method reads an individual subscription. See clause 11.4.3.3.2.
      responses:
        '200':
          $ref: '#/components/responses/IndividualSubscription.Get.200'
        '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 message
            content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 CONTENT

            If the message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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: >
        The DELETE method terminates an individual subscription. See clause
        11.4.3.3.5.
      responses:
        '204':
          $ref: '#/components/responses/IndividualSubscription.Delete.204'
        '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 message
            content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 CONTENT

            If the message content 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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 is reproduced inthis structure. Compared to
                  the general framework defined in IETF RFC 7807, 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
                  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.
                type: object
                required:
                  - status
                  - detail
                properties:
                  type:
                    description: >
                      A URI reference according to IETF RFC 3986 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:
    filter_subscriptions:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI GS
        NFV-SOL 013 [8]. The NFVO shall support receiving this parameter as part
        of the URI query string. The VNFM may supply this parameter. All
        attribute names that appear in the VrQuotaAvailSubscription and in data
        types referenced from it shall be supported by the NFVO in the filter
        expression.
      in: query
      required: false
      schema:
        type: string
    SubscriptionId:
      name: subscriptionId
      in: path
      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 message content of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string
  requestBodies:
    VrQuotaAvailSubscriptionRequest:
      description: |
        Details of the subscription to be created.
      content:
        application/json:
          schema:
            description: >
              This type represents a subscription request related to
              notifications related to the availability of the virtualised
              resources quotas.
            type: object
            required:
              - callbackUri
            properties:
              filter:
                description: >
                  This type represents a subscription filter related to
                  notifications about the availability of the virtualised
                  resources quotas. 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:
                  vimIds:
                    description: >
                      Match VIMs that were created the quota for a consumer of
                      the virtualised resources. This attribute shall only be
                      supported when VNF-related Resource Management in direct
                      mode is applicable.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  resourceProviderIds:
                    description: >
                      Match the entities responsible for the management of the
                      virtualised resources that were allocated by the NFVO.
                      This attribute shall only be supported when VNF-related
                      Resource Management in indirect mode is applicable. The
                      identification scheme is outside the scope of the present
                      document.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  resourceTypes:
                    description: |
                      Match particular resource types.
                    type: array
                    items:
                      type: string
                      enum:
                        - COMPUTE
                        - STORAGE
                        - NETWORK
                  resourceGroupIds:
                    description: >
                      Match the "infrastructure resource groups" that are
                      logical groupings of the virtualised resources assigned to
                      a tenant within an infrastructure Domain.
                    type: array
                    items:
                      description: >
                        An identifier maintained by the VIM  or the CISM or
                        other resource provider. It is expected to be unique
                        within the VIM instance.
                      type: string
              callbackUri:
                description: |
                  String formatted according to IETF RFC 3986.
                type: string
              authentication:
                description: >
                  * NOTE 1 : 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.
                  * NOTE 2: As a less secure alternative to OAUTH2_CLIENT_CERT
                  which uses mutual authentication based on X.509
                            certificates, this mode which uses client password to authenticate may be used in the access token request
                            toward the authorization server (as defined by IETF RFC 6749 [7]), only to support legacy implementations
                            (version 3.4.1 or earlier version of the present document). See clause 8.1 for more details.
                  * NOTE 3: The following values that were included up to
                  version 3.4.1 of the present document have been removed:
                            "BASIC" (to signal the use of the basic HTTP authentication) has been removed because it is insecure.
                            "TLS_CERT" to signal an alternative non-token based authorization method using TLS certificates has been
                            removed because the method is no longer supported.
                  * NOTE 4: The client certificate is established by means
                  outside the scope of the present document.
                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 (see note 3): *
                      OAUTH2_CLIENT_CREDENTIALS: In every
                        HTTP request to the notification endpoint, use
                        an OAuth 2.0 token, obtained using the client
                        credentials grant type after authenticating
                        using client identifier and client password
                        towards the token endpoint.
                      * OAUTH2_CLIENT_CERT: In every HTTP
                        request to the notification endpoint, use an
                        OAuth 2.0 token, obtained using the client
                        credentials grant type after mutually
                        authenticating using client identifier and X.509
                        certificates towards the token endpoint.
                    type: array
                    items:
                      type: string
                      enum:
                        - OAUTH2_CLIENT_CREDENTIALS
                        - OAUTH2_CLIENT_CERT
                  paramsOauth2ClientCert:
                    description: >
                      Parameters for authentication/authorization using
                      OAUTH2_CLIENT_CERT.

                      Shall be present if authType is "OAUTH2_CLIENT_CERT" and
                      the contained information has not been provisioned out of
                      band. 

                      Shall be absent otherwise.
                    type: object
                    required:
                      - clientId
                      - certificateRef
                      - tokenEndpoint
                    properties:
                      clientId:
                        description: >
                          Client identifier to be used in the access token
                          request of the OAuth 2.0 client credentials grant
                          type. The client identifier is unique in the scope of
                          the tokenEndpoint.
                        type: string
                      certificateRef:
                        description: >
                          Fingerprint of the client certificate. The hash
                          function shall use SHA256 or higher. See note 4.
                        type: string
                        required:
                          - type
                          - value
                        properties:
                          type:
                            description: |
                              A string defined in IETF RFC 8259.
                            type: string
                          value:
                            description: |
                              A string defined in IETF RFC 8259.
                            type: string
                      tokenEndpoint:
                        description: |
                          String formatted according to IETF RFC 3986.
                        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.

                      See note 2.
                    type: object
                    properties:
                      clientId:
                        description: >
                          Client identifier to be used in the access token
                          request of the OAuth 2.0 client credentials grant
                          type. The client identifier is unique in the scope of
                          the tokenEndpoint. Shall be present if it has not been
                          provisioned out of band.  See note 1.
                        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.
                          See note 1.
                        type: string
                      tokenEndpoint:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
      required: true
  responses:
    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 resource.
      headers:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            The resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
            description: >
              This type represents a subscription related to notifications
              related to the availability of the virtualised resources quotas.
            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 the availability of the virtualised
                  resources quotas. 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:
                  vimIds:
                    description: >
                      Match VIMs that were created the quota for a consumer of
                      the virtualised resources. This attribute shall only be
                      supported when VNF-related Resource Management in direct
                      mode is applicable.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  resourceProviderIds:
                    description: >
                      Match the entities responsible for the management of the
                      virtualised resources that were allocated by the NFVO.
                      This attribute shall only be supported when VNF-related
                      Resource Management in indirect mode is applicable. The
                      identification scheme is outside the scope of the present
                      document.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  resourceTypes:
                    description: |
                      Match particular resource types.
                    type: array
                    items:
                      type: string
                      enum:
                        - COMPUTE
                        - STORAGE
                        - NETWORK
                  resourceGroupIds:
                    description: >
                      Match the "infrastructure resource groups" that are
                      logical groupings of the virtualised resources assigned to
                      a tenant within an infrastructure Domain.
                    type: array
                    items:
                      description: >
                        An identifier maintained by the VIM  or the CISM or
                        other resource provider. It is expected to be unique
                        within the VIM instance.
                      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.Post.303:
      description: |
        303 See Other

        Shall be returned when a subscription with
        the same callback URI and the same filter
        already exists and the policy of the NFVO
        is to not create redundant subscriptions.
        The HTTP response shall include a
        "Location" HTTP header that contains the
        resource URI of the existing "Individual
        subscription" resource.
        The response body shall be empty.
      headers:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            The resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
    Subscriptions.Post.422:
      description: |
        422 Unprocessable Content

        Shall be returned upon the following error:
        The content type of the message content is
        supported and the message content of a
        request contains syntactically correct data
        but the data cannot be processed.
        The general cause for this error and its
        handling is specified in clause 6.4 of ETSI
        GS NFV-SOL 013 [8], including rules for
        the presence of the response body.
        Specifically in case of this resource, the
        response code 422 shall also be returned
        if the NFVO has tested the Notification
        endpoint as described in clause 11.4.4.3.2
        and the test has failed.
        In this case, the "detail" attribute in the
        "ProblemDetails" structure shall convey
        more information about the error
      headers:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            description: >
              The definition of the general "ProblemDetails" data structure from
              IETF RFC 7807 is reproduced inthis structure. Compared to the
              general framework defined in IETF RFC 7807, 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 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.
            type: object
            required:
              - status
              - detail
            properties:
              type:
                description: >
                  A URI reference according to IETF RFC 3986 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.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 virtualised resource quota available subscriptions as
        defined in clause 11.5.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 VNFM 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:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: >
            Reference to other resources. Used for paging in the present
            document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              description: >
                This type represents a subscription related to notifications
                related to the availability of the virtualised resources quotas.
              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 the availability of the virtualised
                    resources quotas. 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:
                    vimIds:
                      description: >
                        Match VIMs that were created the quota for a consumer of
                        the virtualised resources. This attribute shall only be
                        supported when VNF-related Resource Management in direct
                        mode is applicable.
                      type: array
                      items:
                        description: >
                          An identifier with the intention of being globally
                          unique.
                        type: string
                    resourceProviderIds:
                      description: >
                        Match the entities responsible for the management of the
                        virtualised resources that were allocated by the NFVO.
                        This attribute shall only be supported when VNF-related
                        Resource Management in indirect mode is applicable. The
                        identification scheme is outside the scope of the
                        present document.
                      type: array
                      items:
                        description: >
                          An identifier with the intention of being globally
                          unique.
                        type: string
                    resourceTypes:
                      description: |
                        Match particular resource types.
                      type: array
                      items:
                        type: string
                        enum:
                          - COMPUTE
                          - STORAGE
                          - NETWORK
                    resourceGroupIds:
                      description: >
                        Match the "infrastructure resource groups" that are
                        logical groupings of the virtualised resources assigned
                        to a tenant within an infrastructure Domain.
                      type: array
                      items:
                        description: >
                          An identifier maintained by the VIM  or the CISM or
                          other resource provider. It is expected to be unique
                          within the VIM instance.
                        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.204:
      description: |
        No Content

        The notification endpoint was tested successfully.
        The response body shall be empty.
      headers:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
    IndividualSubscription.Get.200:
      description: >
        200 OK


        Shall be returned when information about an individual subscription has
        been read successfully.

        The response body shall contain a representation of the "Individual
        subscription" resource.
      headers:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            description: >
              This type represents a subscription related to notifications
              related to the availability of the virtualised resources quotas.
            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 the availability of the virtualised
                  resources quotas. 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:
                  vimIds:
                    description: >
                      Match VIMs that were created the quota for a consumer of
                      the virtualised resources. This attribute shall only be
                      supported when VNF-related Resource Management in direct
                      mode is applicable.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  resourceProviderIds:
                    description: >
                      Match the entities responsible for the management of the
                      virtualised resources that were allocated by the NFVO.
                      This attribute shall only be supported when VNF-related
                      Resource Management in indirect mode is applicable. The
                      identification scheme is outside the scope of the present
                      document.
                    type: array
                    items:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                  resourceTypes:
                    description: |
                      Match particular resource types.
                    type: array
                    items:
                      type: string
                      enum:
                        - COMPUTE
                        - STORAGE
                        - NETWORK
                  resourceGroupIds:
                    description: >
                      Match the "infrastructure resource groups" that are
                      logical groupings of the virtualised resources assigned to
                      a tenant within an infrastructure Domain.
                    type: array
                    items:
                      description: >
                        An identifier maintained by the VIM  or the CISM or
                        other resource provider. It is expected to be unique
                        within the VIM instance.
                      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
    IndividualSubscription.Delete.204:
      description: >
        No Content


        Shall be returned when the "Individual subscription" resource has been
        deleted successfully.
      headers:
        Version:
          description: |
            The used API version.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the

            corresponding HTTP request has provided an invalid authorization
            token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string

