SOL002-VNFFaultManagement-API.yaml

                          products from certain providers. The attributes
                          "vnfdIds" and "vnfProductsFromProviders" are
                          alternatives to reference to VNF instances that are
                          based on certain VNFDs in a filter. They should not be
                          used both in the same filter instance, but one
                          alternative should be chosen.
                        type: array
                        items:
                          type: object
                          required:
                            - vnfProvider
                          properties:
                            vnfProvider:
                              description: |
                                Name of the VNF provider to match.
                              type: string
                            vnfProducts:
                              description: >
                                If present, match VNF instances that belong to
                                VNF products with certain product names, from
                                one particular provider.
                              type: array
                              items:
                                type: object
                                required:
                                  - vnfProductName
                                properties:
                                  vnfProductName:
                                    description: |
                                      Name of the VNF product to match.
                                    type: string
                                  versions:
                                    description: >
                                      If present, match VNF instances that
                                      belong to VNF products with certain
                                      versions and a certain product name, from
                                      one particular provider.
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - vnfSoftwareVersion
                                      properties:
                                        vnfSoftwareVersion:
                                          description: |
                                            A version.
                                          type: string
                                        vnfdVersions:
                                          description: >
                                            If present, match VNF instances that
                                            belong to VNF products with certain VNFD
                                            versions, a certain software version and
                                            a certain product name, from one
                                            particular provider.
                                          type: array
                                          items:
                                            description: |
                                              A version.
                                            type: string
                      vnfInstanceIds:
                        description: >
                          If present, match VNF instances with an instance
                          identifier listed in this attribute. The attributes
                          "vnfInstanceIds" and "vnfInstanceNames" are
                          alternatives to reference to particular VNF Instances
                          in a filter. They should not be used both in the same
                          filter instance, but one alternative should be chosen.
                        type: array
                        items:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                      vnfInstanceNames:
                        description: >
                          If present, match VNF instances with a VNF Instance
                          Name listed in this attribute. The attributes
                          "vnfInstanceIds" and "vnfInstanceNames" are
                          alternatives to reference to particular VNF Instances
                          in a filter. They should not be used both in the same
                          filter instance, but one alternative should be chosen.
                        type: array
                        items:
                          type: string
                  notificationTypes:
                    description: >
                      Match particular notification types. Permitted values: *
                      AlarmNotification * AlarmClearedNotification *
                      AlarmListRebuiltNotification The permitted values of the
                      "notificationTypes" attribute are spelled exactly as the
                      names of the notification types to facilitate automated
                      code generation systems.
                    type: array
                    items:
                      type: string
                      enum:
                        - AlarmNotification
                        - AlarmClearedNotification
                        - AlarmListRebuiltNotification
                  faultyResourceTypes:
                    description: >
                      Match VNF alarms with a faulty resource type listed in
                      this attribute.
                    type: array
                    items:
                      description: >
                        The enumeration FaultyResourceType represents those
                        types of faulty resource.
                      type: string
                      enum:
                        - COMPUTE
                        - STORAGE
                        - NETWORK
                  perceivedSeverities:
                    description: >
                      Match VNF alarms with a perceived severity listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        Indicates the relative level of urgency for operator
                        attention. * CRITICAL: The Critical severity level
                        indicates that a service
                          affecting condition has occurred and an immediate corrective action
                          is required. Such a severity can be reported, for example, when a
                          managed object becomes totally out of service and its capability needs
                          to be restored (ITU-T Recommendation X.733).
                        * MAJOR: The Major severity level indicates that a
                        service affecting
                          condition has developed and an urgent corrective action is required.
                          Such a severity can be reported, for example, when there is a severe
                          degradation in the capability of the managed object and its full
                          capability needs to be restored (ITU-T Recommendation X.733).
                        * MINOR: The Minor severity level indicates the
                        existence of a
                          non-service affecting fault condition and that corrective action
                          should be taken in order to prevent a more serious (for example,
                          service affecting) fault. Such a severity can be reported, for
                          example, when the detected alarm condition is not currently degrading
                          the capacity of the managed object (ITU-T Recommendation X.733).
                        * WARNING: The Warning severity level indicates the
                        detection of a
                          potential or impending service affecting fault, before any significant
                          effects have been felt. Action should be taken to further diagnose (if
                          necessary) and correct the problem in order to prevent it from
                          becoming a more serious service affecting fault (ITU-T Recommendation
                          X.733).
                        * INDETERMINATE: The Indeterminate severity level
                        indicates that the
                          severity level cannot be determined (ITU-T Recommendation X.733).
                        * CLEARED: The Cleared severity level indicates the
                        clearing of one or
                          more previously reported alarms. This alarm clears all alarms for this
                          managed object that have the same Alarm type, Probable cause and
                          Specific problems (if given) (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - CRITICAL
                        - MAJOR
                        - MINOR
                        - WARNING
                        - INDETERMINATE
                        - CLEARED
                  eventTypes:
                    description: >
                      Match VNF alarms with an event type listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        The enumeration EventType represents those types of
                        events that trigger an alarm. * COMMUNICATIONS_ALARM: An
                        alarm of this type is associated with the
                          procedure and/or process required conveying information from one point
                          to another (ITU-T Recommendation X.733).
                        * PROCESSING_ERROR_ALARM: An alarm of this type is
                        associated with a
                          software or processing fault (ITU-T Recommendation X.733).
                        * ENVIRONMENTAL_ALARM: An alarm of this type is
                        associated with a
                          condition related to an enclosure in which the equipment resides
                          (ITU-T Recommendation X.733).
                        * QOS_ALARM: An alarm of this type is associated with
                        degradation in the
                          quality of a service (ITU-T Recommendation X.733).
                        * EQUIPMENT_ALARM: An alarm of this type is associated
                        with an equipment
                          fault (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - COMMUNICATIONS_ALARM
                        - PROCESSING_ERROR_ALARM
                        - ENVIRONMENTAL_ALARM
                        - QOS_ALARM
                        - EQUIPMENT_ALARM
                  probableCauses:
                    description: >
                      Match VNF alarms with a probable cause listed in this
                      attribute.
                    type: array
                    items:
                      type: string
              callbackUri:
                description: |
                  The URI of the endpoint to send the notification to.
                type: string
                format: url
              authentication:
                type: object
                required:
                  - authType
                properties:
                  authType:
                    description: >
                      Defines the types of Authentication / Authorization which
                      the API consumer is willing to accept when receiving a
                      notification. Permitted values: * BASIC: In every HTTP
                      request to the notification endpoint, use
                        HTTP Basic authentication with the client credentials. 
                      * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
                        notification endpoint, use an OAuth 2.0 Bearer token, obtained
                        using the client credentials grant type.
                      * TLS_CERT: Every HTTP request to the notification
                      endpoint is sent
                        over a mutually authenticated TLS session, i.e. not only the
                        server is authenticated, but also the client is authenticated
                        during the TLS tunnel setup.
                    type: array
                    items:
                      type: string
                      enum:
                        - BASIC
                        - OAUTH2_CLIENT_CREDENTIALS
                        - TLS_CERT
                  paramsBasic:
                    description: >
                      Parameters for authentication/authorization using BASIC.
                      Shall be present if authType is "BASIC" and the contained
                      information has not been provisioned out of band. Shall be
                      absent otherwise.
                    type: object
                    properties:
                      userName:
                        description: >
                          Username to be used in HTTP Basic authentication.
                          Shall be present if it has not been provisioned out of
                          band.
                        type: string
                      password:
                        description: >
                          Password to be used in HTTP Basic authentication.
                          Shall be present if it has not been provisioned out of
                          band.
                        type: string
                  paramsOauth2ClientCredentials:
                    description: >
                      Parameters for authentication/authorization using
                      OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is
                      "OAUTH2_CLIENT_CREDENTIALS" and the contained information
                      has not been provisioned out of band. Shall be absent
                      otherwise.
                    type: object
                    properties:
                      clientId:
                        description: >
                          Client identifier to be used in the access token
                          request of the OAuth 2.0 client credentials grant
                          type.  Shall be present if it has not been provisioned
                          out of band. The clientId and clientPassword passed in
                          a subscription shall not be the same as the clientId
                          and clientPassword that are used to obtain
                          authorization for API requests. Client credentials may
                          differ between subscriptions. The value of
                          clientPassword should be generated by a random
                          process.
                        type: string
                      clientPassword:
                        description: >
                          Client password to be used in the access token request
                          of the OAuth 2.0 client credentials grant type.  Shall
                          be present if it has not been provisioned out of band.
                          The clientId and clientPassword passed in a
                          subscription shall not be the same as the clientId and
                          clientPassword that are used to obtain authorization
                          for API requests. Client credentials may differ
                          between subscriptions. The value of clientPassword
                          should be generated by a random process.
                        type: string
                      tokenEndpoint:
                        description: |
                          String formatted according to IETF RFC 3986.
                        type: string
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: true
          type: string
      responses:
        '201':
          description: >
            Created

            The subscription was created successfully. The response body shall
            contain a representation of the created subscription resource. The
            HTTP response shall include a "Location:" HTTP header that points to
            the created subscription resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request. Reference: IETF RFC
                7231
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: |
                The resource URI of the created subscription resource.
              type: string
              format: url
            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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            description: >
              This type represents a subscription related to notifications about
              VNF faults.
            type: object
            required:
              - id
              - callbackUri
              - _links
            properties:
              id:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              filter:
                description: >
                  This type represents a subscription filter related to
                  notifications about VNF faults. 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:
                  vnfInstanceSubscriptionFilter:
                    description: >
                      This type represents subscription filter criteria to match
                      VNF instances.
                    type: object
                    properties:
                      vnfdIds:
                        description: >
                          If present, match VNF instances that were created
                          based on a VNFD identified by one of the vnfdId values
                          listed in this attribute. The attributes "vnfdIds" and
                          "vnfProductsFromProviders" are alternatives to
                          reference to VNF instances that are based on certain
                          VNFDs in a filter. They should not be used both in the
                          same filter instance, but one alternative should be
                          chosen.
                        type: array
                        items:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                      vnfProductsFromProviders:
                        description: >
                          If present, match VNF instances that belong to VNF
                          products from certain providers. The attributes
                          "vnfdIds" and "vnfProductsFromProviders" are
                          alternatives to reference to VNF instances that are
                          based on certain VNFDs in a filter. They should not be
                          used both in the same filter instance, but one
                          alternative should be chosen.
                        type: array
                        items:
                          type: object
                          required:
                            - vnfProvider
                          properties:
                            vnfProvider:
                              description: |
                                Name of the VNF provider to match.
                              type: string
                            vnfProducts:
                              description: >
                                If present, match VNF instances that belong to
                                VNF products with certain product names, from
                                one particular provider.
                              type: array
                              items:
                                type: object
                                required:
                                  - vnfProductName
                                properties:
                                  vnfProductName:
                                    description: |
                                      Name of the VNF product to match.
                                    type: string
                                  versions:
                                    description: >
                                      If present, match VNF instances that
                                      belong to VNF products with certain
                                      versions and a certain product name, from
                                      one particular provider.
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - vnfSoftwareVersion
                                      properties:
                                        vnfSoftwareVersion:
                                          description: |
                                            A version.
                                          type: string
                                        vnfdVersions:
                                          description: >
                                            If present, match VNF instances that
                                            belong to VNF products with certain VNFD
                                            versions, a certain software version and
                                            a certain product name, from one
                                            particular provider.
                                          type: array
                                          items:
                                            description: |
                                              A version.
                                            type: string
                      vnfInstanceIds:
                        description: >
                          If present, match VNF instances with an instance
                          identifier listed in this attribute. The attributes
                          "vnfInstanceIds" and "vnfInstanceNames" are
                          alternatives to reference to particular VNF Instances
                          in a filter. They should not be used both in the same
                          filter instance, but one alternative should be chosen.
                        type: array
                        items:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                      vnfInstanceNames:
                        description: >
                          If present, match VNF instances with a VNF Instance
                          Name listed in this attribute. The attributes
                          "vnfInstanceIds" and "vnfInstanceNames" are
                          alternatives to reference to particular VNF Instances
                          in a filter. They should not be used both in the same
                          filter instance, but one alternative should be chosen.
                        type: array
                        items:
                          type: string
                  notificationTypes:
                    description: >
                      Match particular notification types. Permitted values: *
                      AlarmNotification * AlarmClearedNotification *
                      AlarmListRebuiltNotification The permitted values of the
                      "notificationTypes" attribute are spelled exactly as the
                      names of the notification types to facilitate automated
                      code generation systems.
                    type: array
                    items:
                      type: string
                      enum:
                        - AlarmNotification
                        - AlarmClearedNotification
                        - AlarmListRebuiltNotification
                  faultyResourceTypes:
                    description: >
                      Match VNF alarms with a faulty resource type listed in
                      this attribute.
                    type: array
                    items:
                      description: >
                        The enumeration FaultyResourceType represents those
                        types of faulty resource.
                      type: string
                      enum:
                        - COMPUTE
                        - STORAGE
                        - NETWORK
                  perceivedSeverities:
                    description: >
                      Match VNF alarms with a perceived severity listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        Indicates the relative level of urgency for operator
                        attention. * CRITICAL: The Critical severity level
                        indicates that a service
                          affecting condition has occurred and an immediate corrective action
                          is required. Such a severity can be reported, for example, when a
                          managed object becomes totally out of service and its capability needs
                          to be restored (ITU-T Recommendation X.733).
                        * MAJOR: The Major severity level indicates that a
                        service affecting
                          condition has developed and an urgent corrective action is required.
                          Such a severity can be reported, for example, when there is a severe
                          degradation in the capability of the managed object and its full
                          capability needs to be restored (ITU-T Recommendation X.733).
                        * MINOR: The Minor severity level indicates the
                        existence of a
                          non-service affecting fault condition and that corrective action
                          should be taken in order to prevent a more serious (for example,
                          service affecting) fault. Such a severity can be reported, for
                          example, when the detected alarm condition is not currently degrading
                          the capacity of the managed object (ITU-T Recommendation X.733).
                        * WARNING: The Warning severity level indicates the
                        detection of a
                          potential or impending service affecting fault, before any significant
                          effects have been felt. Action should be taken to further diagnose (if
                          necessary) and correct the problem in order to prevent it from
                          becoming a more serious service affecting fault (ITU-T Recommendation
                          X.733).
                        * INDETERMINATE: The Indeterminate severity level
                        indicates that the
                          severity level cannot be determined (ITU-T Recommendation X.733).
                        * CLEARED: The Cleared severity level indicates the
                        clearing of one or
                          more previously reported alarms. This alarm clears all alarms for this
                          managed object that have the same Alarm type, Probable cause and
                          Specific problems (if given) (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - CRITICAL
                        - MAJOR
                        - MINOR
                        - WARNING
                        - INDETERMINATE
                        - CLEARED
                  eventTypes:
                    description: >
                      Match VNF alarms with an event type listed in this
                      attribute.
                    type: array
                    items:
                      description: >
                        The enumeration EventType represents those types of
                        events that trigger an alarm. * COMMUNICATIONS_ALARM: An
                        alarm of this type is associated with the
                          procedure and/or process required conveying information from one point
                          to another (ITU-T Recommendation X.733).
                        * PROCESSING_ERROR_ALARM: An alarm of this type is
                        associated with a
                          software or processing fault (ITU-T Recommendation X.733).
                        * ENVIRONMENTAL_ALARM: An alarm of this type is
                        associated with a
                          condition related to an enclosure in which the equipment resides
                          (ITU-T Recommendation X.733).
                        * QOS_ALARM: An alarm of this type is associated with
                        degradation in the
                          quality of a service (ITU-T Recommendation X.733).
                        * EQUIPMENT_ALARM: An alarm of this type is associated
                        with an equipment
                          fault (ITU-T Recommendation X.733).
                      type: string
                      enum:
                        - COMMUNICATIONS_ALARM
                        - PROCESSING_ERROR_ALARM
                        - ENVIRONMENTAL_ALARM
                        - QOS_ALARM
                        - EQUIPMENT_ALARM
                  probableCauses:
                    description: >
                      Match VNF alarms with a probable cause listed in this
                      attribute.
                    type: array
                    items:
                      type: string
              callbackUri:
                description: |
                  The URI of the endpoint to send the notification to.
                type: string
                format: url
              _links:
                description: |
                  Links for this resource.
                type: object
                required:
                  - self
                properties:
                  self:
                    description: |
                      This type represents a link to a resource.
                    type: object
                    required:
                      - href
                    properties:
                      href:
                        description: |
                          URI of the referenced resource.
                        type: string
                        format: url
        '303':
          description: >
            See Other

            A subscription with the same callbackURI and the same filter already
            exists and the policy of the VNFM is to not create redundant
            subscriptions. The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the existing subscription
            resource. The response body shall be empty.
        '400':
          description: >
            Bad Request

            If the request is malformed or syntactically incorrect (e.g. if the
            request URI contains incorrect query parameters or a syntactically
            incorrect payload body), 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 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.

             ---

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