SOL002-VNFLifecycleManagement-API.yaml

                format: URI
  /vnf_lcm_op_occs:
    get:
      description: >
        The client can use this method to query status information about
        multiple VNF lifecycle management operation occurrences.
      responses:
        '200':
          description: >
            OK

            Status information for zero or more VNF lifecycle management
            operation occurrences was queried successfully. The response body
            shall contain status information about zero or more VNF lifecycle
            operation occurrences.
          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: >
              This type represents a VNF lifecycle management operation
              occurrence.
            type: object
            required:
              - id
              - operationState
              - stateEnteredTime
              - startTime
              - vnfInstanceId
              - operation
              - isAutomaticInvocation
              - operationParams
              - isCancelPending
            properties:
              id:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              operationState:
                description: >
                  Value | Description ------|------------ STARTING | The LCM
                  operation is starting. PROCESSING | The LCM operation is
                  currently in execution. COMPLETED | he LCM operation has been
                  completed successfully. FAILED_TEMP | The LCM operation has
                  failed and execution has stopped, but the execution of the
                  operation is not considered to be closed. FAILED | The LCM
                  operation has failed and it cannot be retried or rolled back,
                  as it is determined that such action won't succeed.
                  ROLLING_BACK | The LCM operation is currently being rolled
                  back. ROLLED_BACK | The LCM operation has been successfully
                  rolled back, i.e. The state of the VNF prior to the original
                  operation invocation has been restored as closely as possible.
                type: string
                enum:
                  - STARTING
                  - PROCESSING
                  - COMPLETED
                  - FAILED_TEMP
                  - FAILED
                  - ROLLING_BACK
                  - ROLLED_BACK
              stateEnteredTime:
                description: |
                  Date-time when the current state was entered.
                type: string
                format: date-time
              startTime:
                description: |
                  Date-time of the start of the operation.
                type: string
                format: date-time
              vnfInstanceId:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              grantId:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              operation:
                description: >
                  Value | Description ------|------------ INSTANTIATE |
                  Represents the "Instantiate VNF" LCM operation.    SCALE |
                  Represents the "Scale VNF" LCM operation. SCALE_TO_LEVEL |
                  Represents the "Scale VNF to Level" LCM operation.
                  CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM
                  operation. TERMINATE | Represents the "Terminate VNF" LCM
                  operation. HEAL | Represents the "Heal VNF" LCM operation.
                  OPERATE | Represents the "Operate VNF" LCM operation.
                  CHANGE_EXT_CONN | Represents the "Change external VNF
                  connectivity" LCM operation. MODIFY_INFO | Represents the
                  "Modify VNF Information" LCM operation.     
                type: string
                enum:
                  - INSTANTIATE
                  - SCALE
                  - SCALE_TO_LEVEL
                  - CHANGE_FLAVOUR
                  - TERMINATE
                  - HEAL
                  - OPERATE
                  - CHANGE_EXT_CONN
                  - MODIFY_INFO
              isAutomaticInvocation:
                description: >
                  Set to true if this VNF LCM operation occurrence has been
                  triggered by an automated procedure inside the VNFM (i.e.
                  ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
                  triggered by auto-heal). Set to false otherwise.
                type: boolean
              operationParams:
                description: >
                  This type represents a list of key-value pairs. The order of
                  the pairs in the list is not significant. In JSON, a set of
                  key- value pairs is represented as an object. It shall comply
                  with the provisions  defined in clause 4 of IETF RFC 7159. 
                type: object
              isCancelPending:
                description: >
                  If the VNF LCM operation occurrence is in "STARTING",
                  "PROCESSING" or "ROLLING_BACK" state and the operation is
                  being cancelled, this attribute shall be set to true.
                  Otherwise, it shall be set to false.
                type: boolean
              cancelMode:
                description: >
                  Cancellation mode. GRACEFUL: The VNFM shall not start any new
                  resource management operation and shall wait for the ongoing
                  resource management operations in the underlying system,
                  typically the VIM, to finish execution or to time out. After
                  that, the VNFM shall put the operation occurrence into the
                  FAILED_TEMP state. FORCEFUL: The VNFM shall not start any new
                  resource management operation, shall cancel the ongoing
                  resource management operations in the underlying system,
                  typically the VIM, and shall wait for the cancellation to
                  finish or to time out. After that, the VNFM shall put the
                  operation occurrence into the FAILED_TEMP state.
                type: string
                enum:
                  - GRACEFUL
                  - FORCEFUL
              error:
                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
              resourceChanges:
                description: >
                  This attribute contains information about the cumulative
                  changes to virtualised resources that were performed so far by
                  the LCM operation since its start, if applicable.
                type: object
                properties:
                  affectedVnfcs:
                    description: >
                      Information about VNFC instances that were affected during
                      the lifecycle operation. This allows the NFVO to obtain
                      the information contained in the latest "result"
                      notification if it has not received it due to an error or
                      a wrongly configured subscription filter.
                    type: array
                    items:
                      description: >
                        This type provides information about added, deleted,
                        modified and temporary VNFCs.  
                      type: object
                      required:
                        - id
                        - vduId
                        - changeType
                        - computeResource
                      properties:
                        id:
                          description: >
                            An identifier that is unique for the respective type
                            within a VNF instance, but may not be globally
                            unique.
                          type: string
                        vduId:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        changeType:
                          description: >
                            Signals the type of change. Permitted values: *
                            ADDED * REMOVED * MODIFIED * TEMPORARY For a
                            temporary resource, an AffectedVnfc structure exists
                            as long as the temporary resource exists.
                          type: string
                          enum:
                            - ADDED
                            - REMOVED
                            - MODIFIED
                            - TEMPORARY
                        computeResource:
                          required:
                            - vimConnectionId
                            - resourceId
                          type: object
                          description: >
                            This type represents the information that allows
                            addressing a virtualised resource that is used by a
                            VNF instance. Information about the resource is
                            available from the VIM.
                          properties:
                            vimConnectionId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceProviderId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceId:
                              description: >
                                An identifier maintained by the VIM or other
                                resource provider. It is expected to be unique
                                within the VIM instance.
                              type: string
                            vimLevelResourceType:
                              description: >
                                Type of the resource in the scope of the VIM or
                                the resource provider.
                              type: string
                        metadata:
                          description: >
                            This type represents a list of key-value pairs. The
                            order of the pairs in the list is not significant.
                            In JSON, a set of key- value pairs is represented as
                            an object. It shall comply with the provisions 
                            defined in clause 4 of IETF RFC 7159. 
                          type: object
                        affectedVnfcCpIds:
                          description: >
                            Identifiers of CP(s) of the VNFC instance that were
                            affected by the change.  Shall be present for those
                            affected CPs of the VNFC instance that are
                            associated to an external CP of the VNF instance.
                            May be present for further affected CPs of the VNFC
                            instance.
                          type: array
                          items:
                            description: >
                              An identifier that is unique for the respective
                              type within a VNF instance, but may not be
                              globally unique.
                            type: string
                        addedStorageResourceIds:
                          description: >
                            References to VirtualStorage resources that have
                            been added. Each value refers to a
                            VirtualStorageResourceInfo item in the VnfInstance
                            that was added to the VNFC. It shall be provided if
                            at least one storage resource was added to the VNFC.
                          type: array
                          items:
                            description: >
                              An identifier that is unique for the respective
                              type within a VNF instance, but may not be
                              globally unique.
                            type: string
                        removedStorageResourceIds:
                          description: >
                            References to VirtualStorage resources that have
                            been removed. The value contains the identifier of a
                            VirtualStorageResourceInfo item that has been
                            removed from the VNFC, and might no longer exist in
                            the VnfInstance. It shall be provided if at least
                            one storage resource was removed from the VNFC.
                          type: array
                          items:
                            description: >
                              An identifier that is unique for the respective
                              type within a VNF instance, but may not be
                              globally unique.
                            type: string
                  affectedVirtualLinks:
                    description: >
                      Information about VL instances that were affected during
                      the lifecycle operation. This allows the NFVO to obtain
                      the information contained in the latest "result"
                      notification if it has not received it due to an error or
                      a wrongly configured subscription filter.
                    type: array
                    items:
                      description: >
                        This type provides information about added, deleted,
                        modified and temporary VLs.
                      type: object
                      required:
                        - id
                        - virtualLinkDescId
                        - changeType
                        - networkResource
                      properties:
                        id:
                          description: >
                            An identifier that is unique for the respective type
                            within a VNF instance, but may not be globally
                            unique.
                          type: string
                        virtualLinkDescId:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        changeType:
                          description: >
                            Signals the type of change. Permitted values: *
                            ADDED * REMOVED * MODIFIED * TEMPORARY *
                            LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary
                            resource, an AffectedVirtualLink structure exists as
                            long as the temporary resource exists.
                          type: string
                          enum:
                            - ADDED
                            - REMOVED
                            - MODIFIED
                            - TEMPORARY
                            - LINK_PORT_ADDED
                            - LINK_PORT_REMOVED
                        networkResource:
                          required:
                            - vimConnectionId
                            - resourceId
                          type: object
                          description: >
                            This type represents the information that allows
                            addressing a virtualised resource that is used by a
                            VNF instance. Information about the resource is
                            available from the VIM.
                          properties:
                            vimConnectionId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceProviderId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceId:
                              description: >
                                An identifier maintained by the VIM or other
                                resource provider. It is expected to be unique
                                within the VIM instance.
                              type: string
                            vimLevelResourceType:
                              description: >
                                Type of the resource in the scope of the VIM or
                                the resource provider.
                              type: string
                        metadata:
                          description: >
                            This type represents a list of key-value pairs. The
                            order of the pairs in the list is not significant.
                            In JSON, a set of key- value pairs is represented as
                            an object. It shall comply with the provisions 
                            defined in clause 4 of IETF RFC 7159. 
                          type: object
                  affectedVirtualStorages:
                    description: >
                      Information about virtualised storage instances that were
                      affected during the lifecycle operation. This allows the
                      NFVO to obtain the information contained in the latest
                      "result" notification if it has not received it due to an
                      error or a wrongly configured subscription filter.
                    type: array
                    items:
                      description: >
                        This type provides information about added, deleted,
                        modified and temporary virtual storage resources.
                      type: object
                      required:
                        - id
                        - virtualStorageDescId
                        - changeType
                        - storageResource
                      properties:
                        id:
                          description: >
                            An identifier that is unique for the respective type
                            within a VNF instance, but may not be globally
                            unique.
                          type: string
                        virtualStorageDescId:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        changeType:
                          description: >
                            Signals the type of change. Permitted values: *
                            ADDED * REMOVED * MODIFIED * TEMPORARY For a
                            temporary resource, an AffectedVirtualStorage
                            structure exists as long as the temporary resource
                            exists.
                          type: string
                          enum:
                            - ADDED
                            - REMOVED
                            - MODIFIED
                            - TEMPORARY
                        storageResource:
                          required:
                            - vimConnectionId
                            - resourceId
                          type: object
                          description: >
                            This type represents the information that allows
                            addressing a virtualised resource that is used by a
                            VNF instance. Information about the resource is
                            available from the VIM.
                          properties:
                            vimConnectionId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceProviderId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceId:
                              description: >
                                An identifier maintained by the VIM or other
                                resource provider. It is expected to be unique
                                within the VIM instance.
                              type: string
                            vimLevelResourceType:
                              description: >
                                Type of the resource in the scope of the VIM or
                                the resource provider.
                              type: string
                        metadata:
                          description: >
                            This type represents a list of key-value pairs. The
                            order of the pairs in the list is not significant.
                            In JSON, a set of key- value pairs is represented as
                            an object. It shall comply with the provisions 
                            defined in clause 4 of IETF RFC 7159. 
                          type: object
              changedInfo:
                description: >
                  This type represents attribute modifications that were
                  performed on an "Individual VNF instance" resource. The
                  attributes that can be included consist of those requested to
                  be modified explicitly in the "VnfInfoModificationRequest"
                  data structure, and additional attributes of the "VnfInstance"
                  data structure that were modified implicitly e.g. when
                  modifying the referenced VNF package.
                type: object
                properties:
                  vnfInstanceName:
                    description: >
                      If present, this attribute signals modifications of the
                      "vnfInstanceName" attribute in "VnfInstance".
                    type: string
                  vnfInstanceDescription:
                    description: >
                      If present, this attribute signals modifications of the
                      "vnfInstanceDescription" attribute in "VnfInstance".
                    type: string
                  vnfConfigurableProperties:
                    description: >
                      This type represents a list of key-value pairs. The order
                      of the pairs in the list is not significant. In JSON, a
                      set of key- value pairs is represented as an object. It
                      shall comply with the provisions  defined in clause 4 of
                      IETF RFC 7159. 
                    type: object
                  metadata:
                    description: >
                      This type represents a list of key-value pairs. The order
                      of the pairs in the list is not significant. In JSON, a
                      set of key- value pairs is represented as an object. It
                      shall comply with the provisions  defined in clause 4 of
                      IETF RFC 7159. 
                    type: object
                  extensions:
                    description: >
                      This type represents a list of key-value pairs. The order
                      of the pairs in the list is not significant. In JSON, a
                      set of key- value pairs is represented as an object. It
                      shall comply with the provisions  defined in clause 4 of
                      IETF RFC 7159. 
                    type: object
                  vimConnectionInfo:
                    description: >
                      If present, this attribute signals modifications of
                      certain entries in the "vimConnectionInfo" attribute array
                      in "VnfInstance".
                    type: array
                    items:
                      description: >
                        This type represents parameters to connect to a VIM for
                        managing the resources of a VNF instance. This structure
                        is used to convey VIM-related parameters over the
                        Or-Vnfm interface. Additional parameters for a VIM may
                        be configured into the VNFM by means outside the scope
                        of the present document, and bound to the identifier of
                        that VIM.
                      type: object
                      required:
                        - id
                        - vimType
                      properties:
                        id:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        vimId:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        vimType:
                          description: >
                            Discriminator for the different types of the VIM
                            information. The value of this attribute determines
                            the structure of the "interfaceInfo" and
                            "accessInfo" attributes, based on the type of the
                            VIM. The set of permitted values is expected to
                            change over time as new types or versions of VIMs
                            become available. The ETSI NFV registry of
                            VIM-related information provides access to
                            information about VimConnectionInfo definitions for
                            various VIM types. The structure of the registry is
                            defined in Annex C of SOL003.
                          type: string
                        interfaceInfo:
                          description: >
                            This type represents a list of key-value pairs. The
                            order of the pairs in the list is not significant.
                            In JSON, a set of key- value pairs is represented as
                            an object. It shall comply with the provisions 
                            defined in clause 4 of IETF RFC 7159. 
                          type: object
                        accessInfo:
                          description: >
                            This type represents a list of key-value pairs. The
                            order of the pairs in the list is not significant.
                            In JSON, a set of key- value pairs is represented as
                            an object. It shall comply with the provisions 
                            defined in clause 4 of IETF RFC 7159. 
                          type: object
                        extra:
                          description: >
                            This type represents a list of key-value pairs. The
                            order of the pairs in the list is not significant.
                            In JSON, a set of key- value pairs is represented as
                            an object. It shall comply with the provisions 
                            defined in clause 4 of IETF RFC 7159. 
                          type: object
                  vnfPkgId:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  vnfdId:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  vnfProvider:
                    description: >
                      If present, this attribute signals modifications of the
                      "vnfProvider" attribute in "VnfInstance". If present, this
                      attribute (which depends on the value of the "vnfPkgId"
                      attribute) was modified implicitly following a request to
                      modify the "vnfPkgId" attribute, by copying the value of
                      this attribute from the VNFD in the VNF Package identified
                      by the "vnfPkgId” attribute.
                    type: string
                  vnfProductName:
                    description: >
                      If present, this attribute signals modifications of the
                      "vnfProductName" attribute in "VnfInstance". If present,
                      this attribute (which depends on the value of the
                      "vnfPkgId" attribute) was modified implicitly following a
                      request to modify the "vnfPkgId" attribute, by copying the
                      value of this attribute from the VNFD in the VNF Package
                      identified by the "vnfPkgId” attribute.
                    type: string
                  vnfSoftwareVersion:
                    description: |
                      A Version.
                    type: string
                  vnfdVersion:
                    description: |
                      A Version.
                    type: string
              changedExtConnectivity:
                description: >
                  Information about changed external connectivity, if
                  applicable. This allows the NFVO to obtain the information
                  contained in the latest "result" notification if it has not
                  received it due to an error or a wrongly configured
                  subscription filter.
                type: array
                items:
                  type: object
                  required:
                    - id
                    - resourceHandle
                  properties:
                    id:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    resourceHandle:
                      required:
                        - vimConnectionId
                        - resourceId
                      type: object
                      description: >
                        This type represents the information that allows
                        addressing a virtualised resource that is used by a VNF
                        instance. Information about the resource is available
                        from the VIM.
                      properties:
                        vimConnectionId:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        resourceProviderId:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        resourceId:
                          description: >
                            An identifier maintained by the VIM or other
                            resource provider. It is expected to be unique
                            within the VIM instance.
                          type: string
                        vimLevelResourceType:
                          description: >
                            Type of the resource in the scope of the VIM or the
                            resource provider.
                          type: string
                    extLinkPorts:
                      description: |
                        Link ports of this VL.
                      type: array
                      items:
                        description: >
                          This type represents information about a link port of
                          an external VL, i.e. a port providing connectivity for
                          the VNF to an NS VL. 
                        type: object
                        required:
                          - id
                          - resourceHandle
                        properties:
                          id:
                            description: >
                              An identifier with the intention of being globally
                              unique.
                            type: string
                          resourceHandle:
                            required:
                              - vimConnectionId
                              - resourceId
                            type: object
                            description: >
                              This type represents the information that allows
                              addressing a virtualised resource that is used by
                              a VNF instance. Information about the resource is
                              available from the VIM.
                            properties:
                              vimConnectionId:
                                description: >
                                  An identifier with the intention of being
                                  globally unique.
                                type: string
                              resourceProviderId:
                                description: >
                                  An identifier with the intention of being
                                  globally unique.
                                type: string
                              resourceId:
                                description: >
                                  An identifier maintained by the VIM or other
                                  resource provider. It is expected to be unique
                                  within the VIM instance.
                                type: string
                              vimLevelResourceType:
                                description: >
                                  Type of the resource in the scope of the VIM
                                  or the resource provider.
                                type: string
                          cpInstanceId:
                            description: >
                              An identifier that is unique for the respective
                              type within a VNF instance, but may not be
                              globally unique.
                            type: string
              _links:
                description: |
                  Links to resources related to this resource.
                type: object
                required:
                  - self
                  - vnfInstance
                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
                  vnfInstance:
                    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
                  grant:
                    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
                  cancel:
                    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
                  retry:
                    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
                  rollback:
                    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
                  fail:
                    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
        '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: