Commit 9127953f authored by Samir Medjiah's avatar Samir Medjiah
Browse files

NFVMANO CIM Mgmt Interface (first push)

parent 550df6a0
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 V0.8.0
url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL009ed331_MANO_mgmt_stage_3/NFV-SOL009ed331v080.zip
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:
/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/mano_entity.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/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: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/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: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/all_fields"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.ManoServiceInterface"
- $ref: "#/components/parameters/nextpage_opaque_marker"
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/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: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/mano_entity/mano_interfaces/{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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/mano_entity-mano_interface.get.200"
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/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: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/mano_entity/mano_interfaces/{manoServiceInterfaceId}/change_state:
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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/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: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateSubscriptionRequest"
responses:
"201":
$ref: "#/components/responses/subscriptions.post.201"
"303":
$ref: "#/components/responses/subscriptions.post.303"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/nextpage_opaque_marker"
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscriptions.get.200"
"400":
$ref: "#/components/responses/subscriptions.get.400"
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/subscriptions/{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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscription.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/subscription.delete.204"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/all_fields"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.ChangeStateOpOcc"
- $ref: "#/components/parameters/nextpage_opaque_marker"
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/change_state_ops.get.200"
"400":
$ref: "#/components/responses/change_state_ops.get.400"
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/change_state_ops/{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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/change_state_op.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreatePeerEntityRequest"
responses:
"201":
$ref: "#/components/responses/peer_entities.post.201"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403