diff --git a/doc/supported_nbis.md b/doc/supported_nbis.md index 4a79c258e3037f2356dd377d0e617cd9e23a3853..9322ddffa66b421d2b712d9e297f7d72b8d0f33b 100644 --- a/doc/supported_nbis.md +++ b/doc/supported_nbis.md @@ -16,137 +16,137 @@ This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to **Endpoint `/tfs-api/context_ids`** - Method: `GET` - - Used to list the context identifiers + - Used to list the context identifiers **Endpoint `/tfs-api/contexts`** - Method: `GET` - - Used to list the details of all contexts + - Used to list the details of all contexts **Endpoint `/tfs-api/dummy_contexts`** - Method: `GET` - - Used to dump contexts (including related topologies, devices, links, services, slices, and connections) in a snapshot format that can be imported directly in TeraFlowSDN WebUI. - - IMPORTANT: the resulting document is processed by WebUI in dummy mode, i.e., just to populate Context database, but not interacting with Device, Service, and Slice components. + - Used to dump contexts (including related topologies, devices, links, services, slices, and connections) in a snapshot format that can be imported directly in TeraFlowSDN WebUI. + - IMPORTANT: the resulting document is processed by WebUI in dummy mode, i.e., just to populate Context database, but not interacting with Device, Service, and Slice components. **Endpoint `/tfs-api/context/<path:context_uuid>`** - Method: `GET` - - Used to retrieve a specific context + - Used to retrieve a specific context **Endpoint `/tfs-api/context/<path:context_uuid>/topology_ids`** - Method: `GET` - - Used to list the topology identifiers in a context + - Used to list the topology identifiers in a context **Endpoint `/tfs-api/context/<path:context_uuid>/topologies`** - Method: `GET` - - Used to list all the topology details in a context + - Used to list all the topology details in a context **Endpoint `/tfs-api/context/<path:context_uuid>/topology/<path:topology_uuid>`** - Method: `GET` - - Used to retrieve a specific topology in a context + - Used to retrieve a specific topology in a context **Endpoint `/tfs-api/context/<path:context_uuid>/service_ids`** - Method: `GET` - - Used to list the service identifiers in a context + - Used to list the service identifiers in a context **Endpoint `/tfs-api/context/<path:context_uuid>/services`** - Method: `GET` - - Used to list all the service details in a context + - Used to list all the service details in a context - Method: `POST` - - Used to create a service + - Used to create a service - Method: `PUT` - - Used to update a service + - Used to update a service - Method: `DELETE` - - Used to delete a service + - Used to delete a service **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>`** - Method: `GET` - - Used to retrieve a specific service in a context + - Used to retrieve a specific service in a context **Endpoint `/tfs-api/context/<path:context_uuid>/slice_ids`** - Method: `GET` - - Used to list the slice identifiers in a context + - Used to list the slice identifiers in a context **Endpoint `/tfs-api/context/<path:context_uuid>/slices`** - Method: `GET` - - Used to list all the slice details in a context + - Used to list all the slice details in a context **Endpoint `/tfs-api/context/<path:context_uuid>/slice/<path:slice_uuid>`** - Method: `GET` - - Used to retrieve a specific slice in a context + - Used to retrieve a specific slice in a context **Endpoint `/tfs-api/device_ids`** - Method: `GET` - - Used to list the device identifiers + - Used to list the device identifiers **Endpoint `/tfs-api/devices`** - Method: `GET` - - Used to list the device details + - Used to list the device details **Endpoint `/tfs-api/device/<path:device_uuid>`** - Method: `GET` - - Used to retrieve a specific device + - Used to retrieve a specific device **Endpoint `/tfs-api/link_ids`** - Method: `GET` - - Used to list the link identifiers + - Used to list the link identifiers **Endpoint `/tfs-api/links`** - Method: `GET` - - Used to list the link details + - Used to list the link details **Endpoint `/tfs-api/link/<path:link_uuid>`** - Method: `GET` - - Used to retrieve a specific link + - Used to retrieve a specific link **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connection_ids`** - Method: `GET` - - Used to list the connection identifiers related to a service + - Used to list the connection identifiers related to a service **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connections`** - Method: `GET` - - Used to list all the connection details related to a service + - Used to list all the connection details related to a service **Endpoint `/tfs-api/connection/<path:connection_uuid>`** - Method: `GET` - - Used to retrieve a specific connection + - Used to retrieve a specific connection **Endpoint `/tfs-api/policyrule_ids`** - Method: `GET` - - Used to list all the policy rule identifiers + - Used to list all the policy rule identifiers **Endpoint `/tfs-api/policyrules`** - Method: `GET` - - Used to list all the policy rule details + - Used to list all the policy rule details **Endpoint `/tfs-api/policyrule/<path:policyrule_uuid>`** - Method: `GET` - - Used to retrieve a specific policy rule + - Used to retrieve a specific policy rule ## **6.2. ETSI Bandwidth Management (BWM)**