Newer
Older
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Configuration and Information Management Interface
description: >
SOL009 - NFV-MANO Configuration and Information Management Interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: NFV-SOL WG
externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
servers:
- url: http://0.0.0.0/nfvmanocim/v1
description: >
API HTTP Server
- url: https://0.0.0.0/nfvmanocim/v1
description: >
API HTTPS Server
paths:
/api_versions:
$ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
/mano_entity:
get:
description: >
Retrives information about an NFV-MANO functional entity
by reading the NFV-MANO entity resource.
This method shall follow the provisions specified in the
tables 5.5.3.3.2-1 and 5.5.3.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/mano_entity.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
patch:
description: >
Modifies the NFV-MANO entity resource.
Changes to the various configuration and information
attributes are applied to the NFV-MANO functional entity,
and are reflected in the representation of this resource.
This method shall follow the provisions specified in the
tables 5.5.3.3.4-1 and 5.5.3.3.4-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/ModifyManoEntityRequest"
responses:
"200":
$ref: "#/components/responses/mano_entity.patch.200"
"409":
$ref: "#/components/responses/mano_entity.patch.409"
"412":
$ref: "#/components/responses/mano_entity.patch.412"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/mano_entity/change_state:
post:
description: >
Requests to change the state of the NFV-MANO functional
entity application.
This method shall follow the provisions specified in the tables
5.5.7.3.1-1 and 5.5.7.3.1-2 for URI query parameters, request and
response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/ChangeManoEntityStateRequest"
responses:
"202":
$ref: "#/components/responses/mano_entity-change_state.post.202"
"409":
$ref: "#/components/responses/mano_entity-change_state.post.409"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/mano_entity/mano_interfaces:
get:
description: >
Queries information about multiple NFV-MANO service interfaces of
the NFV-MANO functional entity.
This method shall follow the provisions specified in the tables
5.5.10.3.2-1 and 5.5.10.3.2-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "#/components/parameters/filter.ManoServiceInterface"
- $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.ManoServiceInterface"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/mano_entity-mano_interfaces.get.200"
"400":
$ref: "#/components/responses/mano_entity-mano_interfaces.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/mano_entity/mano_interfaces/{manoServiceInterfaceId}:
parameters:
- $ref: "#/components/parameters/manoServiceInterfaceId"
get:
description: >
retrieves information about an NFV-MANO service interface of the
producer NFV-MANO functional entity by reading an "Individual
NFV-MANO service interface" resource.
This method shall follow the provisions specified in the tables
5.5.11.3.2-1 and 5.5.11.3.2-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/mano_entity-mano_interface.get.200"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
patch:
description: >
Modifies an "Individual NFV-MANO service interface" resource.
Changes to the configurable parameters of the corresponding
NFV-MANO service interface are applied to the information managed
by the producer NFV-MANO functional entity and reflected in the
representation of this resource.
This method shall follow the provisions specified in the tables
5.5.11.3.4-1 and 5.5.11.3.4-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/ModifyManoEnityInterfaceRequest"
responses:
"200":
$ref: "#/components/responses/mano_entity-mano_interface.patch.200"
"409":
$ref: "#/components/responses/mano_entity-mano_interface.patch.409"
"412":
$ref: "#/components/responses/mano_entity-mano_interface.patch.412"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/mano_entity/mano_interfaces/{manoServiceInterfaceId}/change_state:
parameters:
- $ref: "#/components/parameters/manoServiceInterfaceId"
post:
description: >
Requests to change the state of the NFV-MANO service interface
produced by the NFV-MANO functional entity.
This method shall follow the provisions specified in the tables
5.5.12.3.1-1 and 5.5.12.3.1-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/ChangeManoEntityInterfaceStateRequest"
responses:
"202":
$ref: "#/components/responses/mano_entity-mano_interface-change_state.post.202"
"409":
$ref: "#/components/responses/mano_entity-mano_interface-change_state.post.409"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/subscriptions:
post:
description: >
Creates a new subscription.
This method shall follow the provisions specified in the tables
5.5.4.3.1-1 and 5.5.4.3.1-2 for URI query parameters, request and
response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
Giacomo Bernini
committed
$ref: "#/components/requestBodies/CimSubscriptionRequest"
responses:
"201":
$ref: "#/components/responses/subscriptions.post.201"
"303":
$ref: "#/components/responses/subscriptions.post.303"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
queries the list of active subscriptions of the API consumer that
invokes the method. It can be used, e.g., for resynchronization
after error situations.
This method shall follow the provisions specified in the tables
5.5.4.3.2-1 and 5.5.4.3.2-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "#/components/parameters/filter.CimSubscription"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscriptions.get.200"
"400":
$ref: "#/components/responses/subscriptions.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/subscriptions/{subscriptionId}:
parameters:
- $ref: "#/components/parameters/subscriptionId"
get:
description: >
Retrieves information about a subscription by reading an "Individual
subscription" resource.
This method shall follow the provisions specified in the tables
5.5.5.3.2-1 and 5.5.5.3.2-2 for URI query parameters, request and
response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscription.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
delete:
description: >
Terminates an individual subscription.
This method shall follow the provisions specified in the tables
5.5.5.3.5-1 and 5.5.5.3.5-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/subscription.delete.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/change_state_ops:
get:
description: >
The API consumer can use the GET method to query status information
about multiple change state operation occurrences.
This method shall follow the provisions specified in the tables
5.5.8.3.2-1 and 5.5.8.3.2-2 for URI query parameters, request and
response data structures, and response codes.
parameters:
- $ref: "#/components/parameters/filter.ChangeStateOpOcc"
- $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.ChangeStateOpOcc"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/change_state_ops.get.200"
"400":
$ref: "#/components/responses/change_state_ops.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/change_state_ops/{changeStateOpOccId}:
parameters:
- $ref: "#/components/parameters/changeStateOpOccId"
get:
description: >
The API consumer can use the GET method to retrieve status
information about a change state operation occurrence by reading
an "Individual change state operation occurrence" resource.
This method shall follow the provisions specified in the tables
5.5.9.3.2-1 and 5.5.9.3.2-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/change_state_op.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/peer_entities:
post:
description: >
Creates in the producer NFV-MANO functional entity a new peer
entity resource which contains configuration and information
with regards to the peer functional entity.
This method shall follow the provisions specified in the tables
5.5.13.3.1-1 and 5.5.13.3.1-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreatePeerEntityRequest"
responses:
"201":
$ref: "#/components/responses/peer_entities.post.201"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
Queries information and configuration in the producer NFV-MANO
functional entity with regards to multiple peer entities.
This method shall follow the provisions specified in the tables
5.5.13.3.2-1 and 5.5.13.3.2-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "#/components/parameters/filter.PeerEntity"
- $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.PeerEntity"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/peer_entities.get.200"
"400":
$ref: "#/components/responses/peer_entities.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/peer_entities/{peerEntityId}:
parameters:
- $ref: "#/components/parameters/peerEntityId"
get:
description: >
Retrieves information and configuration hold in the producer NFV-MANO
functional entity with regards to a peer entity by reading an individual
peer entity resource.
This method shall follow the provisions specified in the tables
5.5.14.3.2-1 and 5.5.14.3.2-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/peer_entitie.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
patch:
description: >
Modifies configuration and information of the producer NFV-MANO
functional entity with regards to a peer functional entity by
updating the corresponding "Individual peer entity" resource.
Changes to the configurable parameters of the corresponding peer
entity are applied to the information managed by the producer
NFV-MANO functional entity and reflected in the representation
of this resource.
This method shall follow the provisions specified in the tables
5.5.14.3.4-1 and 5.5.14.3.4-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/ModifyPeerEntityRequest"
responses:
"200":
$ref: "#/components/responses/peer_entitie.patch.200"
"409":
$ref: "#/components/responses/peer_entitie.patch.409"
"412":
$ref: "#/components/responses/peer_entitie.patch.412"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
delete:
description: >
Ddeletes an individual peer entity resource. By deleting such
a resource in the producer NFV-MANO functional entity representing
a peer NFV-MANO entity, the configuration and information with
regards to such peer entity is deleted. Consequently, the peering
relationship between the producer NFV-MANO functional entity and
the peer entity is terminated, i.e., the producer NFV-MANO functional
entity does not have the necessary information to communicate/interact
with the peer entity.
This method shall follow the provisions specified in the tables
5.5.14.3.5-1 and 5.5.14.3.5-2 for URI query parameters, request
and response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/peer_entitie.delete.204"
"409":
$ref: "#/components/responses/peer_entitie.delete.409"
"412":
$ref: "#/components/responses/peer_entitie.delete.412"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
components:
schemas:
ManoEntity:
description: >
This type represents an NFV-MANO functional entity.
type: object
required:
- id
- type
- name
- description
- provider
- softwareVersion
- manoConfigurableParams
- manoApplicationState
- _links
properties:
id:
description: >
Identifier of the NFV-MANO functional entity. The identifier shall be set during
the initial deployment of the NFV-MANO functional entity and its value allocated
based on network operator policies. The value of this identifier shall be unique
at least in the scope of the NFV-MANO deployment.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
type:
description: >
Type of NFV-MANO functional entity.
$ref: "#/components/schemas/ManoEntityEnumType"
name:
description: >
Human-readable name of the NFV-MANO functional entity.
This attribute can be modified with the PATCH method.
type: string
description:
description: >
Human-readable description of the NFV-MANO functional entity.
This attribute can be modified with the PATCH method.
type: string
provider:
description: >
Information about the provider of the NFV-MANO functional entity.
It typically includes the name of the provider.
type: string
softwareVersion:
description: >
The version of the software of the NFV-MANO functional entity.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
manoEntityComponents:
description: >
The deployed NFV-MANO functional entity components which realize the
NFV-MANO functional entity.
NOTE: It is optional for the API producer to support the "manoEntityComponents"
attribute.
type: array
items:
$ref: "#/components/schemas/ManoEntityComponent"
manoServices:
description: >
Information about the NFV-MANO services provided by the NFV-MANO
functional entity.
type: array
items:
$ref: "#/components/schemas/ManoService"
manoConfigurableParams:
description: >
Information and current values of the configurable parameters.
This attribute can be modified with the PATCH method.
$ref: "#/components/schemas/ManoConfigurableParams"
manoApplicationState:
description: >
Information and current values of the NFV-MANO functional entity’s application state.
type: object
required:
- operationalState
- administrativeState
- usageState
properties:
operationalState:
description: >
The operational state of the NFV-MANO functional entity application.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
The administrative state of the NFV-MANO functional entity application.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
usageState:
description: >
The usage state of the NFV-MANO functional entity application.
$ref: "#/components/schemas/UsageStateEnumType"
nfvoSpecificInfo:
description: >
The information specific to an NFVO entity.
NOTE: It shall be present when "type" attribute is "NFVO", and it
shall be absent in any other case.
NOTE: The information about the NFV-MANO services offered by a
specific type of NFV-MANO functional entity is specified by the
manoServices attribute.
$ref: "#/components/schemas/NfvoSpecificInfo"
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
vnfmSpecificInfo:
description: >
The information specific to a VNFM entity.
NOTE: It shall be present when "type" attribute is "VNFM", and
it shall be absent in any other case.
NOTE: The information about the NFV-MANO services offered by a
specific type of NFV-MANO functional entity is specified by the
manoServices attribute.
$ref: "#/components/schemas/VnfmSpecificInfo"
vimSpecificInfo:
description: >
The information specific to an VIM entity.
NOTE: It shall be present when "type" attribute is "VIM", and
it shall be absent in any other case.
NOTE: The information about the NFV-MANO services offered by a
specific type of NFV-MANO functional entity is specified by the
manoServices attribute.
$ref: "#/components/schemas/VimSpecificInfo"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- manoServiceInterfaces
- peerEntities
- changeState
- changeStateOpOccs
properties:
self:
description: URI of this resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
manoServiceInterfaces:
description: Link to the "NFV-MANO service interfaces" resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
peerEntities:
description: Link to "Peer entities" resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
changeState:
description: Link to the "Change state" task resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
changeStateOpOccs:
description: Link to the "Change state operation occurrences" resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
ManoConfigModificationRequest:
description: >
This type represents attribute modifications for configuration parameters
of an NFV-MANO functional entity.
type: object
properties:
name:
description: >
New value of the "name" attribute in "ManoEntity".
type: string
description:
description: >
New value of the "description" attribute in "ManoEntity".
type: string
clockSyncs:
description: >
Modifications of the "clockSyncs" attribute in the "ManoEntityConfigurableParams".
If present, these modifications shall be applied according to the rules of JSON Merge PATCH
(see IETF RFC 7396).
type: object
additionalProperties:
$ref: "#/components/schemas/ClockSyncInfo"
defaultLogCompileBySizeValue:
description: >
New value of the "defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description: >
New value of the "defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
manoServiceModifications:
description: >
New content of certain entries in the "manoServices" attribute array
in the "ManoEntity", as defined below this table.
type: array
items:
type: object
properties:
id:
description: >
Identifier of the NFV-MANO service to modify.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
name:
description: >
New value for the "name" attribute in the "ManoService".
NOTE: At least one of these attributes shall be provided if requesting
a modification of the NFV-MANO service identified by "id".
type: string
description:
description: >
New value for the "description" attribute in the "ManoService".
NOTE: At least one of these attributes shall be provided if requesting
a modification of the NFV-MANO service identified by "id".
type: string
required:
- id
ManoConfigModifications:
description: >
This type represents attribute modifications that were performed on the
"NFV-MANO entity" resource of the producer NFV-MANO functional entity.
The attributes that can be included consist of those requested to be
modified explicitly in the "ManoConfigModificationRequest" data structure.
type: object
properties:
name:
description: >
If present, this attribute signals modifications of the "name"
attribute in "ManoEntity", as defined in clause 5.6.2.3
type: string
description:
description: >
If present, this attribute signals modifications of the "description"
attribute in "ManoEntity", as defined in clause 5.6.2.3.
type: string
If present, this attribute signals modifications of the "clockSyncs" attribute in
"ManoEntityConfigurableParams", as defined in clause 5.6.2.3.
type: object
additionalProperties:
$ref: "#/components/schemas/ClockSyncInfo"
defaultLogCompileBySizeValue:
description: >
If present, this attribute signals modifications of the
"defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description: >
If present, this attribute signals modifications of the
"defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
manoServiceModifications:
description: >
If present, this attribute signals modifications of the "manoServices"
attribute array in the "ManoEntity", as defined in clause 5.6.2.3.
type: array
items:
type: object
properties:
id:
description: >
Identifier of the NFV-MANO service that has been modified.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
name:
description: >
If present, this attribute signals modification of the "name"
attribute in the "ManoService".
type: string
description:
description: >
If present, this attribute signals modification of the
"description" attribute in the "ManoService".
type: string
required:
- id
CimSubscriptionRequest:
description: >
This type represents a subscription request related to notifications
about NFV-MANO configuration and information management changes.
type: object
properties:
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular notification
is sent to the subscriber if the filter matches, or if there is no filter.
$ref: "#/components/schemas/CimNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
required:
- callbackUri
CimSubscription:
description: >
This type represents a subscription related to notifications about
NFV-MANO configuration and information management changes
type: object
properties:
id:
description: >
Identifier that identifies the subscription
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular notification
is sent to the subscriber if the filter matches, or if there is no filter.
$ref: "#/components/schemas/CimNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
_links:
description: >
Links to resources related to this resource.
type: object
properties:
self:
description: >
URI of this resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
required:
- self
required:
- id
- callbackUri
- _links
ChangeStateRequest:
description: >
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
This type represents request parameters for changing the state of a managed entity.
type: object
properties:
operationalStateChange:
description: >
A change of operational state. Shall be present if the state change request
refers to the operational state.
NOTE: In the present document version, a request shall only include an
operational state change (attribute "operationalStateChange") or an
administrative state change request (attribute "administrativeStateChange"),
but not both.
type: object
properties:
operationalStateAction:
description: >
The desired operation state to change the managed object to. In case of
changing the state of an NFV-MANO service interface the value
"RESTART" shall not be used.
$ref: "#/components/schemas/ChangeOperationalStateEnumType"
stopType:
description: >
It signals the type of stop.
NOTE: The "stopType" shall only be provided when the "operationalStateAction"
attribute is equal to "STOP" or "RESTART". The "gracefulStopTimeout" shall
be absent when the "stopType" attribute is equal to "FORCEFUL", and may
be provided otherwise.
$ref: "#/components/schemas/StopEnumType"
gracefulStopTimeout:
description: >
The time internal (in seconds) to wait for the entity to be taken out
of service during graceful stop.
NOTE: The "stopType" shall only be provided when the "operationalStateAction"
attribute is equal to "STOP" or "RESTART". The "gracefulStopTimeout" shall
be absent when the "stopType" attribute is equal to "FORCEFUL", and may
be provided otherwise.
type: integer
required:
- operationalStateAction
administrativeStateChange:
description: >
A change of administrative state. Shall be present if the state change request
refers to the administrative state.
NOTE: In the present document version, a request shall only include an
operational state change (attribute "operationalStateChange") or an
administrative state change request (attribute "administrativeStateChange"),
but not both.
type: object
properties:
administrativeStateAction:
description: >
The desired administrative state to change the managed object to.
$ref: "#/components/schemas/ChangeAdministrativeStateEnumType"
required:
- administrativeStateAction
ChangeStateOpOcc:
description: >
This type represents a Change state operation occurrence.
type: object
properties:
id:
description: >
Identifier of this change state operation occurrence.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
operationState:
description: >
The state of the "change state operation occurrence".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ChangeStateOpOccStateEnumType"
stateEnteredTime:
description: >
Date-time when the current state was entered.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
managedObjectRef:
description: >
Reference of the managed object to which the change state operation
occurrence relates. The value of the "type" attribute shall be
"MANO_ENTITY" or "MANO_SERVICE_IF".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
changeOperationalStateRequest:
description: >
The type of the change of operational state that was requested. Shall
be present if the change of state operation triggered a change of
operational state.
$ref: "#/components/schemas/ChangeOperationalStateEnumType"
changeAdministrativeStateRequest:
description: >
The type of the change of administrative state that was requested. Shall
be present if the change of state operation triggered a change of
administrative state.
$ref: "#/components/schemas/ChangeAdministrativeStateEnumType"
operationParams:
description: >
Input parameters of the change state operation. This attribute shall be
formatted according to the request data type of the related change state
operation.
The following mapping between operationType and the data type of this
attribute shall apply:
- CHANGE_STATE: ChangeStateRequest
This attribute shall be present if this data type is returned in a response
to reading an individual resource, and may be present according to the chosen
attribute selector parameter if this data type is returned in a response to
a query of a container resource.
required:
- id
- operationState
- stateEnteredTime
- startTime
- managedObjectRef
ManoServiceInterface:
description: >
This type represents an individual NFV-MANO service interface produced by
an NFV-MANO functional entity.
type: object
properties:
id:
description: >
Identifier of the NFV-MANO functional entity interface.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
name:
description: >
Human-readable name of the NFV-MANO functional entity interface.
This attribute can be modified with the PATCH method.
type: string
type:
description: >
Type of the NFV-MANO service interface produced by the NFV-MANO functional
entity. Valid values are defined in clause 5.6.4.3.
type: string
standardVersion:
description: >
Version of the standard the interface is compliant to.
NOTE 1: The information to be provided in this attribute shall relate to
the specification and version of the specification. For instance,
"ETSI GS NFV-SOL 003 (V2.4.1)".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
providerSpecificApiVersion:
description: >
Provider-specific software API version.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
apiVersion:
description: >
API version, in compliance with the version identifiers and parameters
format specified in clause 9.1 of ETSI GS NFV-SOL 013.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
apiEndpoint:
description: >
Exposed API endpoint of the interface.
type: object
properties:
apiRoot:
description: >
Indicates the scheme ("http" or "https"), the host name and optional port,
and an optional sequence of path segments that together represent a prefix
path. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs
(see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
This attribute can be modified with the PATCH method.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
apiName:
description: >
Indicates the interface name in an abbreviated form. Shall be present
for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each
interface is defined in the standard the interface is compliant to
(see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiMajorVersion:
description: >
Indicates the current major version of the API. Shall be present for
ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined
in the standard the interface is compliant to (see also clause 4.1 of
ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiUri:
description: >
URL of the API endpoint. For ETSI NFV specified RESTful NFV-MANO APIs,
the following prefix structure is used (see also clause 4.1 of ETSI
GS NFV-SOL 013): {apiRoot}/{apiName}/{apiMajorVersion}
For APIs not specified by ETSI NFV as part of the RESTful NFV-MANO APIs,
this attribute can be modified with the PATCH method. For RESTful NFV-MANO
APIs specified by ETSI NFV, this attribute shall not be modified. Instead,
changes are handled indirectly via patching of the "apiRoot" attribute’s
value.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
required:
- apiUri
maxConcurrentIntOpNumber:
description: >
Maximum number of concurrent operation requests supported on this interface.
NOTE: If this attribute is not present, the value of this parameter
is undefined. Overload is handled by the error handling schemes defined
by the applicable API specification.
type: integer
supportedOperations:
description: >
Information about supported operations of this interface.
type: array
items:
type: object
properties:
operationName:
description: >
Name of the operation supported on the interface.
type: string
maxConcurrentOpNumber:
description: >
Maximum number of concurrent requests supported by the interface operation.
NOTE: If this attribute is not present, the value of this parameter
is undefined. Overload is handled by the error handling schemes defined
by the applicable API specification.
type: integer
required:
- operationName
minItems: 1
interfaceState:
description: >
State of the NFV-MANO service interface.
properties:
operationalState:
description: >
The operational state of the NFV-MANO service interface.
$ref: "#/components/schemas/InterfaceOperationalStateEnumType"
administrativeState:
description: >
The administrative state of the NFV-MANO service interface.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
usageState:
description: >
The usage state of the NFV-MANO service interface.
$ref: "#/components/schemas/UsageStateEnumType"
required:
- operationalState
- administrativeState
- usageState
securityInfo:
description: >
Security related information.
This attribute can be modified with the PATCH method.
NOTE: Due to the security sensitive information associated to the attribute,
based on access control policies, the API consumer might have read only,
write only, read/write, or no access at all to the attribute’s value.
In case the API consumer is not allowed to read the value of the security
sensitive attribute, the attribute shall be omitted when the information
is to be provided in a response message, and shall be provided otherwise.
In case the API consumer is not allowed to modify the value of the security
sensitive attribute, and the modification request includes new attribute
values, the whole modification request shall be rejected, and proper error
information returned.
$ref: "#/components/schemas/ServerInterfaceSecurityInfo"
metadata:
description: >
Additional attributes that provide metadata describing the NFV-MANO
service interface.
These attributes can be created, modified or removed with the PATCH
method.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
required:
- id
- name
- type
- standardVersion
- providerSpecificApiVersion
- apiVersion
- apiEndpoint
- supportedOperations
- interfaceState
ManoServiceInterfaceModificationRequest:
description: >
This type represents attribute modifications for configuration parameters of
an NFV-MANO service interface of the producer NFV-MANO functional entity.
type: object
properties:
name:
description: >
New value of the "name" attribute in "ManoServiceInterface".
NOTE: Changing the name does not change the corresponding standardized
API name in the resource URI (refer to "{apiName}" defined in clause 4.1
of ETSI GS NFV-SOL 013).
type: string
apiRoot:
description: >
New value of the "apiRoot" attribute in "ManoServiceInterface".
NOTE: The change of apiRoot or apiUri on an enabled and in use API may
be service disruptive. Also, that change invalidates any related URI that
might have been cached at API consumers.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
apiUri:
description: >
New value of the "apiUri" attribute in "ManoServiceInterface".
NOTE: The change of apiRoot or apiUri on an enabled and in use API may
be service disruptive. Also, that change invalidates any related URI that
might have been cached at API consumers.
Shall not be provided if a change of "apiRoot" is present in the request.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
securityInfo:
description: >
New value of the "securityInfo" attribute in "ManoServiceInterface".
NOTE: Due to the security sensitive information associated to the attribute,
based on access control policies, the API consumer might have read only,
write only, read/write, or no access at all to the attribute’s value.
In case the API consumer is not allowed to modify the value of the security
sensitive attribute, and the modification request includes new attribute
values, the whole modification request shall be rejected, and proper error
information returned.
$ref: "#/components/schemas/ServerInterfaceSecurityInfo"
metadata:
description: >
Modifications of the "metadata" attribute in "ManoServiceInterface".
If present, these modifications shall be applied according to the rules
of JSON Merge PATCH (see IETF RFC 7396).
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
ManoServiceInterfaceModifications:
description: >
This type represents attribute modifications that were performed on an
Individual NFV-MANO service interface" resource. The attributes that can
be included consist of those requested to be modified explicitly in the
"ManoServiceInterfaceModificationRequest" data structure. If applicable,
additional attributes of the "ManoServiceInterface" data structure that
were modified implicitly shall also be provided.
type: object
properties:
name:
description: >
If present, this attribute signals modifications of the "name" attribute in
"ManoServiceInterface", as defined in clause 5.6.2.11.
type: string
apiRoot:
description: >
If present, this attribute signals modifications of the "apiRoot" attribute
in "ManoServiceInterface", as defined in clause 5.6.2.11.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
apiUri:
description: >
If present, this attribute signals modifications of the "apiUri" attribute
in "ManoServiceInterface", as defined in clause 5.6.2.11.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
securityInfo:
description: >
If present, this attribute signals modifications of the "securityInfo"
attribute in "ManoServiceInterface", as defined in clause 5.6.2.11.
NOTE: Due to the security sensitive information associated to the attribute,
based on access control policies, the API consumer might have read only,
write only, read/write, or no access at all to the attribute’s value.
In case the API consumer is not allowed to read the value of the security
sensitive attribute, the attribute shall be omitted when the information
is to be provided in a response message.
$ref: "#/components/schemas/ServerInterfaceSecurityInfo"
metadata:
description: >
If present, this attribute signals modifications of the "metadata" attribute
in "ManoServiceInterface", as defined in clause 5.6.2.11.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
CreatePeerEntityRequest:
description: >
This type represents request parameters for the creation of a new peer entity resource.
type: object
properties:
peerEntityId:
description: >
Identifier of the peer functional entity.
NOTE: The value of the "peerEntityId" attribute is the same as the value of
the "id" attribute in the "ManoEntity" of the corresponding NFV-MANO functional
entity that acts as peer entity, and shall follow the uniqueness requirements
set out in clause 5.6.2.2 for the "id" attribute.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
name:
description: >
Human-readable name of the peer functional entity.
type: string
type:
description: >
Type of the peer functional entity.
$ref: "#/components/schemas/PeerEntityEnumType"
description:
description: >
Human-readable description of the peer functional entity.
type: string
consumedManoInterfaces:
description: >
Initial information of the interface consumed by the NFV-MANO functional entity
from the peer functional entity.
type: object
additionalProperties:
$ref: "#/components/schemas/ConsumedManoInterfaceInfo"
peerEntityState:
description: >
Current values of the state of the peer functional entity.
type: object
properties:
operationalState:
description: >
TThe operation state of the peer functional entity’s application.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
The administrative state of the peer functional entity’s application.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
required:
- operationalState
- administrativeState
required:
- peerEntityId
- name
- type
PeerEntity:
description: >
This type represents an individual peer entity.
type: object
properties:
id:
description: >
Identifier of the resource representing the peer functional entity.
This identifier is allocated by the producer NFV-MANO functional entity.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
peerEntityId:
description: >
Identifier of the peer functional entity.
NOTE : The value of the "peerEntityId" attribute is the same as the value
of the "id" attribute in the "ManoEntity" of the corresponding NFV-MANO
functional entity that acts as peer entity, and shall follow the uniqueness
requirements set out in clause 5.6.2.2 for the "id" attribute.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
name:
description: >
Human-readable name of the peer functional entity.
This attribute can be modified with the PATCH method.
type: string
type:
description: >
Type of the peer functional entity.
$ref: "#/components/schemas/PeerEntityEnumType"
description:
description: >
Human-readable description of the peer functional entity.
This attribute can be modified with the PATCH method.
type: string
consumedManoInterfaces:
description: >
Information of the interface consumed by the NFV-MANO functional entity
from the peer functional entity.
This attribute can be modified with the PATCH method.
The keys of the map, each of which identifies information about a particular
consumed NFV-MANO interface, are managed by the API consumer and referenced
from other data structures via the "consumedManoInterfaceIds" attribute.
type: object
additionalProperties:
$ref: "#/components/schemas/ConsumedManoInterfaceInfo"
peerEntityState:
description: >
State of the peer functional entity as provided by the API consumer when
creating the resource or when updating it with the PATCH method.
type: object
properties:
operationalState:
description: >
The operational state of the peer functional entity’s application.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
administrativeState:
description:
The administrative state of the peer functional entity’s application.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
required:
- operationalState
- administrativeState
required:
- id
- peerEntityId
- name
- type
- peerEntityState
PeerEntityConfigModificationRequest:
description: >
This type represents attribute modifications for configuration parameters
of a peer entity.
type: object
properties:
name:
description: >
New value of the "name" attribute in "PeerEntity".
type: string
description:
description: >
New value of the "description" attribute in "PeerEntity", or "null" to
remove the attribute.
type: string
consumedManoInterfaces:
description: >
Modification of the "consumedManoInterfaces" attribute
in the "PeerEntity", as defined below this table.
If present, these modifications shall be applied according to the rules of
JSON Merge PATCH (see IETF RFC 7396).
NOTE: Due to the security sensitive information contained within the attribute
(refer to "securityInfo" within the "ConsumedManoInterfaceInfo"), based on
access control policies, the API consumer might have read only, write only,
read/write, or no access at all to the attribute’s value. In case the
API consumer is not allowed to modify the value of the security sensitive
attribute, and the modification request includes new attribute values,
the whole modification request shall be rejected, and proper error information
returned.
type: object
additionalProperties:
$ref: "#/components/schemas/ConsumedManoInterfaceInfo"
operationalState:
description: >
New content of the "operationalState" attribute in the "peerEntityState"
structure in the "PeerEntity".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
New content of the "administrativeState" attribute in the "peerEntityState"
structure in the "PeerEntity".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
PeerEntityConfigModifications:
description: >
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
This type represents attribute modifications that were performed on an
"Individual peer entity" resource. The attributes that can be included
consist of those requested to be modified explicitly in the
"PeerEntityConfigModificationRequest" data structure. If applicable,
additional attributes of the "PeerEntity" data structure that were
modified implicitly shall also be provided.
type: object
properties:
name:
description: >
If present, this attribute signals modifications of the "name" attribute
in "PeerEntity", as defined in clause 5.6.2.15.
type: string
description:
description: >
If present, this attribute signals modifications of the "description"
attribute in "PeerEntity", as defined in clause 5.6.2.15.
type: string
consumedManoInterfaces:
description: >
If present, this attribute signals modifications of certain entries in
"consumedManoInterfaces" attribute in "PeerEntity", as defined in
clause 5.6.2.15.
NOTE: Due to the security sensitive information contained within the
attribute (refer to "securityInfo" within the "ConsumedManoInterfaceInfo"),
based on access control policies, the API consumer might have read only,
write only, read/write, or no access at all to the attribute’s value.
In case the API consumer is not allowed to read the value of the security
sensitive attribute, the attribute shall be omitted when the information
is to be provided in a response message.
type: array
items:
$ref: "#/components/schemas/ConsumedManoInterfaceInfo"
operationalState:
description: >
If present, this attribute signals modifications of the "operationalState"
attribute in the "peerEntityState" structure in the "PeerEntity", as defined
in clause 5.6.2.15.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
If present, this attribute signals modifications of the "administrativeState"
attribute in the "peerEntityState" structure in the "PeerEntity", as defined
in clause 5.6.2.15.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
ManoConfigurableParams:
description: >
# Warning: No definition found in the document
ManoConfigurableParams
#referenced
ManoEntityComponent:
description: >
This type represents information of a deployed component realizing part of an
NFV-MANO functional entity. It is optional for the API producer to support
this type.
type: object
properties:
id:
description: >
Identifier of the NFV-MANO functional entity component.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
manoServiceIds:
description: >
References to the NFV-MANO services that depend on the NFV-MANO functional
entity component. The identifier of the ManoService is referred. A service
may depend on multiple components. Multiple services may depend on the same
component.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
ManoService:
description: >
This type represents information about an NFV-MANO service provided by the
NFV-MANO functional entity.
type: object
properties:
id:
description: >
Identifier of the NFV-MANO service.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
name:
description: >
Human-readable name of the NFV-MANO service.
This attribute can be modified with the PATCH method.
type: string
description:
description: >
Human-readable description of the NFV-MANO service.
This attribute can be modified with the PATCH method.
type: string
manoServiceInterfaceIds:
description: >
Reference to the NFV-MANO interfaces associated to the NFV-MANO service.
If cardinality is greater than one, the type of ManoServiceInterface
(see clause 5.6.3.3) shall be the same. The identifier of the
ManoServiceInterface is referred.
NOTE: A cardinality greater than one supports having different interface
versions or apiEndpoints to be used for accessing the same instance of a
NFV-MANO service.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
minItems: 1
_links:
description: >
Links to resources related to this resource.
type: object
properties:
manoServiceInterfaces:
description: >
Link to the "individual NFV-MANO service interface" resources with
information about the associated interfaces to the NFV-MANO service.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
minItems: 1
required:
- manoServiceInterfaces
required:
- id
- name
- description
- manoServiceInterfaceIds
- _links
NfvoSpecificInfo:
description: >
This type represents information attributes specific to an NFVO entity,
and that can be relevant to more than one NFV-MANO service offered by an
NFVO entity.
type: object
properties:
maxOnboardedNsdNum:
description: >
Maximum number of NSDs that can be on-boarded on the NFVO.
NOTE: If this attribute is not present, the value of this parameter
is undefined.
type: integer
maxOnboardedVnfPkgNum:
description: >
Maximum number of VNF Packages that can be on-boarded on the NFVO.
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
NOTE: If this attribute is not present, the value of this parameter
is undefined.
type: integer
supportedVnfdFormats:
description: >
Supported VNFD data formats.
type: object
properties:
vnfdFormat:
description: >
Name of the VNFD format.
Permitted values:
- TOSCA: The VNFD follows TOSCA definition, according to ETSI
GS NFV-SOL 001 standard.
- YANG: The VNFD follows YANG definition according to ETSI
GS NFV-SOL 006 standard.
type: string
enum:
- TOSCA
- YANG
standardVersion:
description: >
Name and version of the standard the VNFD is compliant to.
NOTE: The information to be provided in this attribute shall relate
to the specification and version of the specification. For instance,
"ETSI GS NFV-SOL 001 (V2.5.1)".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
required:
- vnfdFormat
- standardVersion
supportedNsdFormats:
description: >
Supported NSD data formats.
type: object
properties:
nsdFormat:
description: >
Name of the NSD format.
Permitted values:
- TOSCA: The VNFD follows TOSCA definition, according to ETSI
GS NFV-SOL 001 standard.
- YANG: The VNFD follows YANG definition according to ETSI
GS NFV-SOL 006 standard.
type: string
enum:
- TOSCA
- YANG
standardVersion:
description: >
Name and version of the standard the NSD is compliant to.
NOTE: The information to be provided in this attribute shall relate
to the specification and version of the specification. For instance,
"ETSI GS NFV-SOL 001 (V2.5.1)".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
required:
- nsdFormat
- standardVersion
required:
- supportedVnfdFormats
- supportedNsdFormats
VnfmSpecificInfo:
description: >
This type represents information attributes specific to a VNFM entity,
and that can be relevant to more than one NFV-MANO service offered by
a VNFM entity.
type: object
properties:
resoruceMgmtModeSupport:
description: >
The supported resource management modes of the VNFM.
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
Permitted values:
- DIRECT: The VNFM supports direct mode only.
- INDIRECT: The VNFM supports indirect mode only.
- BOTH: The VNFM supports both direct and indirect mode.
type: string
enum:
- DIRECT
- INDIRECT
- BOTH
managedVnfInstanceInfos:
description: >
The kinds of VNF instances that can be managed, e.g. to determine the
compatibility of a VNF with certain VNFM according to the vnfmInfo
attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).
type: array
items:
type: string
minItems: 1
supportedVnfdFormats:
description: >
Supported VNFD data formats.
type: array
items:
type: object
properties:
vnfdFormat:
description: >
Name of the VNFD format.
Permitted values:
- TOSCA: The VNFD follows TOSCA definition, according to ETSI
GS NFV-SOL 001 standard.
- YANG: The VNFD follows YANG definition according to ETSI
GS NFV-SOL 006 standard.
type: string
enum:
- TOSCA
- YANG
standardVersion:
description: >
Name and version of the standard the VNFD is compliant to.
NOTE: The information to be provided in this attribute shall relate
to the specification and version of the specification. For instance,
"ETSI GS NFV-SOL 001 (V2.5.1)".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
required:
- vnfdFormat
- standardVersion
minItems: 1
required:
- resoruceMgmtModeSupport
- managedVnfInstanceInfos
- supportedVnfdFormats
VimSpecificInfo:
description: >
This type represents information attributes specific to a VIM entity,
and that can be relevant to more than one NFV-MANO service offered by
a VIM entity.
type: object
ManoEntityConfigurableParams:
description: >
This type represents list of parameters that can be configured on the
NFV MANO functional entity.
type: object
properties:
clockSyncs:
description:
Properties of the clock synchronization to be used by the NFV-MANO
functional entity.
type: array
items:
$ref: "#/components/schemas/ClockSyncInfo"
minItems: 1
defaultLogCompileBySizeValue:
description:
Default value for the log compilation by size to be used.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description:
Default value for the log compilation by timer to be used.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
required:
- clockSyncs
- defaultLogCompileBySizeValue
- defaultLogCompileByTimerValue
ConsumedManoInterfaceInfo:
description: >
This type represents an interface consumed by the producer NFV MANO
functional entity from another peer functional entity.
type: object
properties:
id:
description: >
Identifier of the consumed NFV-MANO interface. This identifier is
managed by the API consumer.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
name:
description: >
Human-readable name of the NFV-MANO interface.
type: string
type:
description: >
Type of the NFV-MANO service interface consumed by the NFV-MANO
functional entity. Valid values are defined in clause 5.6.4.3.
type: string
standardVersion:
description: >
Version of the standard the interface is compliant to.
NOTE: The information to be provided in this attribute shall relate
to the specification and its version. For instance,
"ETSI GS NFV-SOL 003 (V2.4.1)".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
apiVersion:
description: >
API version, in compliance with the version identifiers and parameters
format specified in clause 9.1 of ETSI GS NFV-SOL 013.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Version"
apiEndpoint:
description: >
Consumable API endpoint of the interface.
It provides the information relevant about the protocol, host and port,
and path where the interface API can be accessed.
type: object
properties:
apiRoot:
description: >
Indicates the scheme ("http" or "https"), the host name and optional
port, and an optional sequence of path segments that together
represent a prefix path. Shall be present for ETSI NFV specified
RESTful NFV-MANO APIs (see also clause 4.1 of ETSI GS NFV-SOL 013).
May be present otherwise.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
apiName:
description: >
Indicates the interface name in an abbreviated form. Shall be present
for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each
interface is defined in the standard the interface is compliant to
(see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiMajorVersion:
description: >
Indicates the current major version of the API. Shall be present for
ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined
in the standard the interface is compliant to (see also clause 4.1
of ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiUri:
description: >
URL of the API endpoint. For ETSI NFV specified RESTful NFV-MANO APIs,
the following prefix structure is used (see also clause 4.1 of ETSI
GS NFV-SOL 013): {apiRoot}/{apiName}/{apiMajorVersion}
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
required:
- apiUri
securityInfo:
description: >
Security related information including credentials information if needed
for consuming the API.
NOTE: Due to the security sensitive information associated to the attribute,
based on access control policies, the API consumer might have read only,
write only, read/write, or no access at all to the attribute’s value.
In case the API consumer is not allowed to read the value of the security
sensitive attribute, the attribute shall be omitted when the information
is to be provided in a response message, and shall be provided otherwise.
In case the API consumer is not allowed to modify the value of the security
sensitive attribute, and the modification request includes new attribute values,
the whole modification request shall be rejected, and proper error information
returned.
$ref: "#/components/schemas/ClientInterfaceSecurityInfo"
required:
- id
- name
- type
- standardVersion
- apiVersion
- apiEndpoint
CimNotificationsFilter:
description: >
This type represents a subscription filter related to notifications
about NFV-MANO configuration and information management.
type: object
properties:
manoEntitySubscriptionFilter:
description: >
Filter criteria to select the NFV-MANO functional entity and its
associated managed objects.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoEntitySubscriptionFilter"
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- InformationChangedNotification
- ChangeStateNotification
NOTE: 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:
- InformationChangedNotification
- ChangeStateNotification
ClockSyncInfo:
description: >
This type represents parameters for connecting to an NTP server.
type: object
properties:
type:
description: >
Type of clock synchronization.
Permitted values:
- NTP: For Network Time Protocol (NTP) based clock synchronization.
- OTHER: For other types of clock synchronization.
type: string
enum:
- NTP
- OTHER
ntpServerInfo:
description: >
Information for the NTP based clock synchronization.
Shall be present if type = "NTP".
type: object
properties:
ipAddress:
description: >
0..1 IP address of the NTP server.
NOTE: Either ipAddress or hostname shall be set, but not both
at the same time.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IpAddress"
hostname:
description: >
Indicates the hostname of the NTP server.
NOTE: Either ipAddress or hostname shall be set, but not both
at the same time.
type: string
otherClockSyncParams:
description: >
Information for the other types of clock synchronization.
May be present if type = "OTHER".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
ServerInterfaceSecurityInfo:
description: >
This type represents security related information of an NFV-MANO
service interface produced by an NFV-MANO functional entity.
type: object
properties:
authType:
description: >
Type of API request authorization to be used by the API producer.
The support of authorization methods for the API producer is specified
in clause 8.3.6 of ETSI GS NFV-SOL 013.
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
Permitted values:
- TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
- OAUTH2: Using access token, as defined by the OAuth 2.0 specification
in IETF RFC 6749.
type: array
items:
type: string
enum:
- TLS_TUNNEL
- OAUTH2
minItems: 1
oauthServerInfo:
description: >
OAuth 2.0 authorization server information and configuration.
type: object
properties:
dynamicDiscovery:
description: >
Configuration data used when performing dynamic discovery of
the authorization server identifier.
NOTE: Provided configuration of the OAuth 2.0 authorization
server information and configuration shall be supported, and
dynamic configuration may be supported.
type: object
properties:
webFingerHost:
description: >
Server where the WebFinger service is hosted. When used,
the request to the WebFinger resource shall conform as specified
in clause 5.1.3 of ETSI GS NFV-SEC 022.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
required:
- webFingerHost
providedConfiguration:
description: >
Configuration data used to setup the authorization server identifier.
NOTE: Provided configuration of the OAuth 2.0 authorization
server information and configuration shall be supported, and
dynamic configuration may be supported.
type: object
properties:
authServerId:
description: >
Authorization server identifier as defined in ETSI GS NFV-SEC 022.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
required:
- authServerId
tlsCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the
API producer when performing the SSL or TLS negotiation with the
authorization server. Valid values of cipher suites are defined
in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
required:
- providedConfiguration
- tlsCipherSuites
tlsTunnelInfo:
description: >
Information and configuration related to the use of TLS tunnel.
Shall be present if authType contains "TLS_TUNNEL".
type: object
properties:
tlsTunnelCipherSuites:
description:
List of cipher suites that shall be declared as supported by the API
producer when performing the SSL or TLS negotiation with the API client.
Valid values of cipher suites are defined in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
required:
- tlsTunnelCipherSuites
required:
- authType
- oauthServerInfo
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
ClientInterfaceSecurityInfo:
description: >
This type represents security related information for accessing an NFV-MANO
service interface produced by an NFV-MANO functional entity.
type: object
required:
- authType
- oauthServerInfo
properties:
authType:
description: >
Type of API request authorization to be used by the API consumer accessing
the API.
The support of authorization methods for the API consumer is specified in
clause 8.3.6 of ETSI GS NFV-SOL 013.
Permitted values:
- TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
- OAUTH2: Using access token, as defined by the OAuth 2.0 specification
in IETF RFC 6749.
type: array
items:
type: string
enum:
- TLS_TUNNEL
- OAUTH2
minItems: 1
oauthServerInfo:
description: >
OAuth 2.0 authorization server information and configuration.
type: object
properties:
dynamicDiscovery:
description: >
Configuration data used when performing dynamic discovery of the authorization
server identifier.
NOTE: Provided configuration of the OAuth 2.0 authorization server information
and configuration shall be supported, and dynamic configuration may be supported.
type: object
required:
- webFingerHost
properties:
webFingerHost:
description: >
Server where the WebFinger service is hosted. When used, the request to
the WebFinger resource shall conform as specified in clause 5.1.3 of
ETSI GS NFV-SEC 022.
type: string
format: uri
providedConfiguration:
description: >
Configuration data used to setup the authorization server identifier.
NOTE: Provided configuration of the OAuth 2.0 authorization server information
and configuration shall be supported, and dynamic configuration may be supported.
type: object
required:
- authServerId
properties:
authServerId:
description: >
Authorization server identifier as defined in ETSI GS NFV-SEC 022.
type: string
format: uri
tlsCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the API consumer when
performing the SSL or TLS negotiation with the authorization server. Valid values
of cipher suites are defined in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
tlsTunnelInfo:
description: >
Information and configuration related to the use of TLS tunnel. Shall be
present if authType contains "TLS_TUNNEL".
type: object
properties:
tlsTunnelCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the API
consumer when performing the SSL or TLS negotiation with the API producer.
Valid values of cipher suites are defined in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
#referenced simple data types
ManoServiceInterfaceTypeShortName:
description: >
For the RESTful NFV-MANO APIs, valid values are all values for "apiName" as defined
in ETSI GS NFV-SOL 002, ETSI GS NFV-SOL 003, and ETSI GS NFV-SOL 005.
For the NFV-MANO service interfaces for which no API is specified by ETSI NFV, valid
values are defined in table 5.6.4.3-1.
NOTE: The table is expected to be updated, by removing the corresponding listed entries,
once the interfaces are specified as a RESTful NFV-MANO API.
type: string
UsageStateEnumType:
description: >
The enumeration UsageStateEnumType defines values representing the usage
state of a managed entity.
The UsageStateEnumType shall comply with the provisions:
- IN_USE The managed entity is currently being used.
- NOT_IN_USE The managed entity is currently not being used.
type: string
enum:
- IN_USE
- NOT_IN_USE
ChangeOperationalStateEnumType:
description: >
The enumeration ChangeOperationalStateEnumType defines permitted values
for the change state operation.
The ChangeOperationalStateEnumType shall comply with the provisions:
- START To start the managed entity.
- STOP To stop the managed entity.
- RESTART To stop and start again the managed entity.
type: string
enum:
- START
- STOP
- RESTART
ChangeAdministrativeStateEnumType:
description: >
The enumeration ChangeAdministrativeStateEnumType defines permitted values
for the change of administrative state operation.
The ChangeAdministrativeStateEnumType shall comply with the provisions:
- LOCK To lock the managed entity.
- UNLOCK To unlock the managed entity.
type: string
enum:
- LOCK
- UNLOCK
InterfaceOperationalStateEnumType:
description: >
The enumeration InterfaceOperationalStateEnumType defines values representing
the operational state of an NFV-MANO service interface type of managed entity.
The InterfaceOperationalStateEnumType shall comply with the provisions :
- STARTED The managed entity is operational.
- STOPPED The managed entity is not operational.
- STOPPING The managed entity is in the transition to stop.
- STARTING The managed entity is in the transition to start and become operational.
type: string
enum:
- STARTED
- STOPPED
- STOPPING
- STARTING
StopEnumType:
description: >
The enumeration ChangeStateOpOccStateEnumType defines permitted values
for the change state operation. It shall comply with the provisions:
- GRACEFUL To stop the managed entity immediately after accepting the request.
- FORCEFUL To stop the managed entity attempting to gracefully discharge the entity from service.
type: string
enum:
- GRACEFUL
- FORCEFUL
ManoEntityEnumType:
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
The enumeration ManoEntityEnumType defines the permitted values to
represent NFV-MANO functional entities. It shall comply with
the provisions :
- NFVO The NFV-MANO functional entity is an NFVO.
- VNFM The NFV-MANO functional entity is a VNFM.
- VIM The NFV-MANO functional entity is a VIM.
type: string
enum:
- NFVO
- VNFM
- VIM
PeerEntityEnumType:
description: >
The enumeration PeerEntityEnumType defines the permitted values
to represent peer functional entities. it shall complains with
the provisions :
- NFVO The peer functional entity is an NFVO.
- VNFM The peer functional entity is a VNFM.
- VIM The peer functional entity is a VIM.
- WIM The peer functional entity is a WIM.
- EM The peer functional entity is an EM.
- OSS The peer functional entity is an OSS/BSS.
type: string
enum:
- NFVO
- VNFM
- VIM
- WIM
- EM
- OSS
parameters:
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
filter.ManoServiceInterface:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of
ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter
as part of the URI query string. The API consumer may supply this
parameter.
All attribute names that appear in the ManoServiceInterface and in data
types referenced from it shall be supported by the NFV-MANO functional
entity in the expression.
in: query
required: false
schema:
type: string
filter.CimSubscription:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of
ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter
as part of the URI query string. The API consumer may supply this
parameter.
All attribute names that appear in the CimSubscription and in data
types referenced from it shall be supported by the NFV-MANO functional
entity in the expression.
in: query
required: false
schema:
type: string
filter.ChangeStateOpOcc:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of
ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter
as part of the URI query string. The API consumer may supply this
parameter.
All attribute names that appear in the ChangeStateOpOcc and in data
types referenced from it shall be supported by the NFV-MANO functional
entity in the expression.
in: query
required: false
schema:
type: string
filter.PeerEntity:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of
ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter
as part of the URI query string. The API consumer may supply this
parameter.
All attribute names that appear in the PeerEntity and in data
types referenced from it shall be supported by the NFV-MANO functional
entity in the expression.
in: query
required: false
schema:
type: string
exclude_default.ManoServiceInterface:
name: exclude_default
description: >
Indicates to exclude the following complex attributes from the
response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The NFV-MANO functional entity shall support this parameter.
The following attributes shall be excluded from the ManoServiceInterface
structure in the response body if this parameter is provided, or none of
the parameters "all_fields," "fields", "exclude_fields", "exclude_default"
are provided:
- none
in: query
required: false
schema:
type: string
exclude_default.CimSubscription:
name: exclude_default
description: >
Indicates to exclude the following complex attributes from the
response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The NFV-MANO functional entity shall support this parameter.
The following attributes shall be excluded from the CimSubscription
structure in the response body if this parameter is provided, or none of
the parameters "all_fields," "fields", "exclude_fields", "exclude_default"
are provided:
- none
in: query
required: false
schema:
type: string
exclude_default.ChangeStateOpOcc:
name: exclude_default
description: >
Indicates to exclude the following complex attributes from the
response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The NFV-MANO functional entity shall support this parameter.
The following attributes shall be excluded from the ChangeStateOpOcc
structure in the response body if this parameter is provided, or none of
the parameters "all_fields," "fields", "exclude_fields", "exclude_default"
are provided:
- none
in: query
required: false
schema:
type: string
exclude_default.PeerEntity:
name: exclude_default
description: >
Indicates to exclude the following complex attributes from the
response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The NFV-MANO functional entity shall support this parameter.
The following attributes shall be excluded from the PeerEntity
structure in the response body if this parameter is provided, or none of
the parameters "all_fields," "fields", "exclude_fields", "exclude_default"
are provided:
- none
in: query
required: false
schema:
type: string
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
manoServiceInterfaceId:
name: manoServiceInterfaceId
in: path
description: >-
Identifier of the MANO service interface.
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
subscriptionId:
name: subscriptionId
in: path
description: >-
Identifier of the subscription
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
changeStateOpOccId:
name: changeStateOpOccId
in: path
description: >-
Identifier of the change state operation occurrence
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
peerEntityId:
name: peerEntityId
in: path
description: >-
Identifier of the peer entity
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
requestBodies:
ModifyManoEntityRequest:
description: >
Parameters for the NFV-MANO configuration and information
modification, as defined in clause 5.6.2.3.
The Content-Type header shall be set to "application/merge-patch+json"
according to IETF RFC 7396.
content:
application/merge-patch+json:
schema:
$ref: "#/components/schemas/ManoConfigModificationRequest"
required: true
ChangeManoEntityStateRequest:
description: >
Parameters for the change state operation, as defined in clause 5.6.2.8.
content:
application/json:
schema:
$ref: "#/components/schemas/ChangeStateRequest"
required: true
ModifyManoEnityInterfaceRequest:
description: >
Parameters for the modification of configuration parameters of
the NFV-MANO service interface, as defined in clause 5.6.2.12.
The Content-Type header shall be set to "application/merge-patch+json"
according to IETF RFC 7396.
content:
application/merge-patch+json:
schema:
$ref: "#/components/schemas/ManoServiceInterfaceModificationRequest"
required: true
ChangeManoEntityInterfaceStateRequest:
description: >
Parameters for the change state operation, as defined in
clause 5.6.2.8.
content:
application/json:
schema:
$ref: "#/components/schemas/ChangeStateRequest"
required: true
Giacomo Bernini
committed
CimSubscriptionRequest:
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
description: >
Details of the subscription to be created, as defined in
clause 5.6.2.5-1.
content:
application/json:
schema:
$ref: "#/components/schemas/CimSubscriptionRequest"
required: true
CreatePeerEntityRequest:
description: >
The peer entity creation parameters, as defined in clause 5.6.2.14.
content:
application/json:
schema:
$ref: "#/components/schemas/CreatePeerEntityRequest"
required: true
ModifyPeerEntityRequest:
description: >
Parameters for the modification of configuration parameters of
the peer functional entity, as defined in clause 5.6.2.16
The Content-Type header shall be set to "application/merge-patch+json"
according to IETF RFC 7396.
content:
application/merge-patch+json:
schema:
$ref: "#/components/schemas/PeerEntityConfigModificationRequest"
required: true
responses:
mano_entity.get.200:
description: >
200 OK
Shall be returned when configuration and information about
the NFV-MANO functional entity has been read successfully.
The response body shall contain a representation of the NFV-MANO
functional entity, as defined in clause 5.6.2.2.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/ManoEntity"
mano_entity.patch.200:
description: >
200 OK
Shall be returned when the modification of configuration on the
NFV-MANO functional entity has been accepted and completed.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/ManoConfigModifications"
mano_entity.patch.409:
description: >
409 CONFLICT
Shall be returned upon the following error: The operation cannot
be executed currently, due to a conflict with the state of the
"NFV-MANO entity" resource.
Typically, this is due to the fact that another configuration and
information modification is ongoing.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
mano_entity.patch.412:
description: >
412 PRECONDITION FAILED
Shall be returned upon the following error: A precondition given in
an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the resource
was modified by another entity.
The response body should contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
mano_entity-change_state.post.202:
description: >
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains
the URI of the newly-created "Individual change state operation occurrence"
resource corresponding to the operation.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual change state operation occurence" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
mano_entity-change_state.post.409:
description: >
409 CONFLICT
Shall be returned upon the following error: The operation cannot be
executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact that the resource is in an incompatible
state, or that another change state operation is ongoing.
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
mano_entity-mano_interfaces.get.200:
description: >
200 OK
Shall be returned when information about zero or more NFV-MANO
service interfaces has been queried successfully.
The response body shall contain in an array the representations
of zero or more NFV-MANO service interfaces, as defined in
clause 5.6.2.11.
If the “filter" URI parameter or one of the "all_fields", "fields"
(if supported), "exclude_fields" (if supported) or "exclude_default"
URI parameters was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in
clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the NFV-MANO functional entity supports alternative N°2 (paging)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
inclusion of the Link HTTP header in this response shall follow the
provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Link:
description: >
Reference to other resources. Link HTTP header in this response
shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ManoServiceInterface"
mano_entity-mano_interfaces.get.400:
description: >
400 BAD REQUEST
Shall be returned upon the following errors:
- Invalid attribute-based filtering expression.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Invalid attribute selector.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Response too big.
If the NFV-MANO functional entity supports alternative N°1 (error)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
this error response shall follow the provisions in clause 5.4.2.2 of
ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
mano_entity-mano_interface.get.200:
description: >
200 OK
Shall be returned when information about an individual NFV-MANO
service interface has been read successfully.
The response body shall contain a representation of the NFV-MANO
service interface, as defined in clause 5.6.2.11.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/ManoServiceInterface"
mano_entity-mano_interface.patch.200:
description: >
200 OK
Shall be returned when the request has been accepted and completed.
The response body shall contain a representation of the attribute
modifications for the "Individual NFV-MANO service interface" resource,
as defined in clause 5.6.2.13.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/ManoServiceInterfaceModifications"
mano_entity-mano_interface.patch.409:
description: >
409 CONFLICT
Shall be returned upon the following error: The operation cannot
be executed currently, due to a conflict with the state of the
"Individual NFV-MANO service interface" resource.
Typically, this is due to the fact that another operation is
ongoing.
The response body shall contain a ProblemDetails structure,
in which the "detail" attribute should convey more information
about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
mano_entity-mano_interface.patch.412:
description: >
412 PRECONDITION FAILED
Shall be returned upon the following error: A precondition given
in an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the
resource was modified by another entity.
The response body should contain a ProblemDetails structure,
in which the "detail" attribute should convey more information
about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
mano_entity-mano_interface-change_state.post.202:
description: >
202 ACCEPTED
Shall be returned when the request has been accepted for
processing.
The response body shall be empty.
The HTTP response shall include a “Location” HTTP header that
contains the URI of the newly-created "Individual change state
operation occurrence" resource corresponding to the operation.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual change state
operation occurence" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
mano_entity-mano_interface-change_state.post.409:
description: >
409 CONFLICT
Shall be returned upon the following error: The operation cannot be
executed currently, due to a conflict with the state of the resource.
Typically, this is due to the fact that the resource is in an incompatible
state, or that another change state operation is ongoing.
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
subscriptions.post.201:
description: >
201 CREATED
Shall be returned when the subscription has been created
successfully.
The response body shall contain a representation of the
created "Individual subscription" resource.
The HTTP response shall include a "Location" HTTP header
that points to the created "Individual subscription" resource.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual subscription" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
content:
application/json:
schema:
$ref: "#/components/schemas/CimSubscription"
subscriptions.post.303:
description: >
303 SEE OTHER
SShall be returned when a subscription with the same
callbackURI and the same filter already exists and the
policy of NFV-MANO functional entity is to not create
redundant subscriptions.
The HTTP response shall include a "Location" HTTP header
that contains the resource URI of the existing "Individual
subscription" resource.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual subscription" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
subscriptions.post.422:
description: >
422 Unprocessable Entity
Shall be returned upon the following error: The content type
of the payload body is supported and the payload body of a request
contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in
clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
of the response body.
Specifically in case of this resource, the response code 422 shall also
be returned if the API producer has tested the Notification endpoint as
described in clause 5.5.6.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure
shall convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
subscriptions.get.200:
description: >
200 OK
Shall be returned when the list of subscriptions has been queried
successfully.
The response body shall contain in an array the representations of
all active subscriptions of the functional block that invokes the
method, i.e., zero or more representations of NFV-MANO configuration
and information management subscriptions as defined in clause 5.6.2.6.
If the "filter" URI parameter was supplied in the request, the data in
the response body shall have been transformed according to the rules
specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the NFV-MANO functional entity supports alternative N°2 (paging)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
inclusion of the Link HTTP header in this response shall follow the
provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Link:
description: >
Reference to other resources. Link HTTP header in this response
shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/CimSubscription"
subscriptions.get.400:
description: >
400 BAD REQUEST
Shall be returned upon the following errors:
- Invalid attribute-based filtering expression.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Response too big.
If the NFV-MANO functional entity supports alternative N°1 (error)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
this error response shall follow the provisions in clause 5.4.2.2 of
ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
subscription.get.200:
description: >
200 OK
Shall be returned when information about an individual subscription
has been read successfully.
The response body shall contain a representation of the "Individual
subscription" resource.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/CimSubscription"
subscription.delete.204:
description: >
204 NO CONTENT
Shall be returned when the "Individual subscription" resource
has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
change_state_ops.get.200:
description: >
200 OK
Shall be returned when status information for zero or more
"change state operation occurrences" has been queried successfully.
The response body shall contain in an array the status information
about zero or more "Individual change state operation occurrences",
as defined in clause 5.6.2.9.
If the “filter" URI parameter or one of the "all_fields", "fields"
(if supported), "exclude_fields" (if supported) or "exclude_default"
URI parameters was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in
clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the NFV-MANO functional entity supports alternative N°2 (paging)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
inclusion of the Link HTTP header in this response shall follow the
provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Link:
description: >
Reference to other resources. Link HTTP header in this response
shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ChangeStateOpOcc"
change_state_ops.get.400:
description: >
400 BAD REQUEST
Shall be returned upon the following errors:
- Invalid attribute-based filtering expression.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Invalid attribute selector.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Response too big.
If the NFV-MANO functional entity supports alternative N°1 (error)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
this error response shall follow the provisions in clause 5.4.2.2 of
ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
change_state_op.get.200:
description: >
200 OK
Shall be returned when information about an "Individual change
state operation occurrence" resource has been read successfully.
The response body shall contain status information about a change
state operation occurrence, as defined in clause 5.6.2.9.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/ChangeStateOpOcc"
peer_entities.post.201:
description: >
201 CREATED
Shall be returned when a new "Individual peer entity" resource
has been created successfully.
The response body shall contain a representation of the created
resource with regards to a peer entity, as defined in
clause 5.6.2.15.
The HTTP response shall include a “Location” HTTP header that
points to the created "Individual peer entity" resource.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual peer entity" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
content:
application/json:
schema:
$ref: "#/components/schemas/PeerEntity"
peer_entities.get.200:
description: >
200 OK
Shall be returned when information about zero or more peer
entities has been queried successfully.
The response body shall contain in an array the resource
representations of zero or more peer entities, as defined
in clause 5.6.2.15.
If the “filter" URI parameter or one of the "all_fields", "fields"
(if supported), "exclude_fields" (if supported) or "exclude_default"
URI parameters was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in
clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the NFV-MANO functional entity supports alternative N°2 (paging)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
inclusion of the Link HTTP header in this response shall follow the
provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Link:
description: >
Reference to other resources. Link HTTP header in this response
shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PeerEntity"
peer_entities.get.400:
description: >
400 BAD REQUEST
Shall be returned upon the following errors:
- Invalid attribute-based filtering expression.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Invalid attribute selector.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
- Response too big.
If the NFV-MANO functional entity supports alternative N°1 (error)
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
this error response shall follow the provisions in clause 5.4.2.2 of
ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
peer_entitie.get.200:
description: >
200 OK
Shall be returned when information about an individual peer
functional entity has been read successfully.
The response body shall contain a resource representation of
the peer functional entity, as defined in clause 5.6.2.15.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/PeerEntity"
peer_entitie.patch.200:
description: >
200 OK
Shall be returned when the request has been accepted and completed.
The response body shall contain a representation of the attribute
modifications for the "Individual peer entity" resource, as defined
in clause 5.6.2.17.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/PeerEntityConfigModifications"
peer_entitie.patch.409:
description: >
409 CONFLICT.
Shall be returned upon the following error: The operation cannot be
executed currently, due to a conflict with the state of the
"Individual peer entity" resource.
Typically, this is due to the fact that another operation is ongoing.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
peer_entitie.patch.412:
description: >
412 PRECONDITION FAILED
Shall be returned upon the following error: A precondition given in
an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the
resource was modified by another entity.
The response body should contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
peer_entitie.delete.204:
description: >
204 NO CONTENT
Shall be returned when the "Individual peer entity" resource
has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
peer_entitie.delete.409:
description: >
409 CONFLICT.
Shall be returned upon the following error: The operation cannot be
executed currently, due to a conflict with the state of the
"Individual peer entity" resource.
Typically, this is due to the fact that another operation is ongoing.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
peer_entitie.delete.412:
description: >
412 PRECONDITION FAILED
Shall be returned upon the following error: A precondition given in
an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the
resource was modified by another entity.
The response body should contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"