diff options
Diffstat (limited to 'docs/offeredapis')
| -rw-r--r-- | docs/offeredapis/api_hub/swagger.json | 4 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceCatalog/swagger.json | 6 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceInventory/swagger.json | 6 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceOrder/swagger.json | 6 | ||||
| -rw-r--r-- | docs/offeredapis/api_status/swagger.json | 4 | ||||
| -rw-r--r-- | docs/offeredapis/offeredapis.rst | 12 |
6 files changed, 25 insertions, 13 deletions
diff --git a/docs/offeredapis/api_hub/swagger.json b/docs/offeredapis/api_hub/swagger.json index d8cc86e..9d98f10 100644 --- a/docs/offeredapis/api_hub/swagger.json +++ b/docs/offeredapis/api_hub/swagger.json @@ -22,10 +22,10 @@ } }, - "host": "serverRoot:30274", + "host": "nbi.api.simpledemo.onap.org:30274", "basePath": "/nbi/api/v4", "schemes": [ - "http", "https" + "https" ], "produces": [ "application/json;charset=utf-8" diff --git a/docs/offeredapis/api_serviceCatalog/swagger.json b/docs/offeredapis/api_serviceCatalog/swagger.json index efc57a1..9909a83 100644 --- a/docs/offeredapis/api_serviceCatalog/swagger.json +++ b/docs/offeredapis/api_serviceCatalog/swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "# About the ONAP Service Catalog API\n The Service Catalog API is based on a subset of the TM Forum 633 Service Catalog Management API.\n## API Overview\n### General Description \nThis Service Catalog API is used to retrieve the Service Specifications that ONAP supports. As Services are designed and distributed in ONAP SDC, the Service Catalog API allows external systems such as the Business Support Systems (BSS) to discover these Services\n\nThe Service Design Center (SDC) of ONAP allows for the creation of Services that can be orchestrated by ONAP. ONAP SDC provides the tools to design the Services composition and topology, which is then represented in TOSCA. This Service Catalog API allows a REST API JSON representation of the Service, including the required attributes needed for Service Instantiation of this Service Topology.\n### Relationship and Dependencies\n This Service Catalog API is related to the TM Forum 633 Service Catalog Management API and also to MEF LSO LEGATO Service Catalog API.\n\nThis API takes a subset of the Service Catalog Management API, namely the ServiceSpecification resource, and maps this standard resource to the ONAP SDC Service Templates/Topology. By doing this we allow a well known, standardized JSON REST representation of the Service Templates available in ONAP to be potentially ordered via Service Orders. \n\n### API Structure and Approach\nThe Service Catalog API can be used to get the details of a specific ONAP Service Template, or can be used to search/list the Service Templates that are available. \n## Getting Started with the API (Hello World)\nThe Service Catalog API is available via two schemes, http and https. For interacting with the API the simplest method is via http. To interact with the this API via https, your Client would be required to load the neccessary https certificate. \n\nThe default installation of ONAP via OOM, will configure the use of two Node ports for External APIs. NodePorts are used to allow client applications, that run outside of Kubernetes, access to ONAP components deployed by OOM. For this Service Catalog API, the External API Framework has a http Node port of 30274. For https, the Node port is 30292.\n\n From outside ONAP, a client can interact with External API by first getting the IP that the NBI docker container is running on, and then using the appropriate nodeport according to the access scheme. For example to access this Service Catalog API to retrieve a list of all Service Specifications available in ONAP you can use http method GET to http://{nbi_ip}:30274/nbi/api/v4/serviceSpecification/ \n### SDK quick intro\nThere are many tools that can be used to view and edit this swagger file like swagger editor, Atom and senya. For example this swagger file can be loaded into https://editor.swagger.io/. This UI acts both as an online editor and viewer. \n### How to start the client side implementation\n* Code generation, is available via the Generate Client option in the swagger editor. Client stubs can be generated in multiple languages, for example java, go, python etc. These Client stub code can be incorporated in the Application you wish to access the Service Catalog API from.\n\n### How to start the server side implementation\n* Not applicable, the service side for this API will be the NBI container running the External API Framework Springboot application.\n\n## API Description\nIncludes summary of information drawn from API definitions in OpenAPI / Swagger files\n### Resource Endpoint / Resource Quick Reference\nGET /serviceSpecification/ : This operation returns a list service specifications from a catalog\n\nGET /serviceSpecification/{id} : This operation returns the service specifications from a catalog associated with this id. Note the id maps to the uuid of the SDC Service Template in the SDC catalog\n\nGET /serviceSpecification/{id}/specificationInputSchema : This operation returns a service specification Input schema by its id from a catalog. Note again the id corresponds to the uuid of the Service Template in SDC.\n\n### Data Schema\n#### Main API Entities\nDescribe the major entities used in the API\n\nThe main entity of the API is the ServiceSpecification resource. This entity is the top level entity of the API, and is returned as either a single instance when queried with id, or as JSON arroy of ServiceSpecification entities when queried as a list.\n\nThe major child enties are relatedParty which points to the designer of the Template in SDC. The resourceSpecification which point to child resources for the Service Template. The serviceSpecCharacteristics entities are used to describe the attributes that can be supplied to instantiate a Service Instance of this Service Template.\n#### Payload data structures\nIf any, describe the appropriate data structures that are included within payload of the API.\n\nNot applicable\n### Security on the API\nAuthentication; Authorization; Credentials/access token; etc.\n\n https certificate required if using https. No authentication on http requests.In production this API should be behind an API Gateway with the necessary authentication\n### Response Codes\nThe meaning of Status Codes & Errors\n\nSee response codes for each API resource in the API section below\n### Rate Limits and Thresholds\nRequests per unit time allowed; Pagination\n\n No rate limits or thresholds, in production this API should be behind an API Gateway with the necessary limits.\n### Validation constraints\nDescribe any behavioral and structural validation constraints\n\nNot applicable\n### Assumptions\nFor example, any Pre/Post conditions\n\n For this API to function and return Service Specifications, SDC is required to be running and Service models designed in the SDC catalog\n## API Interactions and Flows\n### Interaction Examples\nIllustrate sequence of client calls to this API, possibly based on Use Cases, presented with diagrams, tables, etc\n\nThe Service Catalog API flow of use can generally follow the sequence below\n\n\n#### Call ONAP to discover what available services it can offer\n\n```\ncurl -X GET \"http://serverRoot:30274/nbi/api/v4/serviceSpecification/\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n[\n {\r\n \"id\": \"0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"name\": \"EPLServiceTemplate\",\r\n \"invariantUUID\": \"ddf31f35-8e71-4f5a-a383-4241b87ca7a7\",\r\n \"category\": \"Network L4+\",\r\n \"distributionStatus\": \"DISTRIBUTED\",\r\n \"version\": \"1.0\",\r\n \"lifecycleStatus\": \"CERTIFIED\",\r\n \"relatedParty\": {\r\n \"id\": \"jm0007\",\r\n \"role\": \"lastUpdater\"\r\n }\r\n }\n]\n```\n#### Using the id returned from the list of Service Specifications, drill into any specific Service Specificaton you want to orchestrate/order using\n\n```\ncurl -X GET \"http://serverRoot:30274/nbi/api/v4/serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n{\r\n \"id\": \"0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"name\": \"EPLServiceTemplate\",\r\n \"invariantUUID\": \"ddf31f35-8e71-4f5a-a383-4241b87ca7a7\",\r\n \"toscaModelURL\": \"/sdc/v1/catalog/services/0ec83a1f-51e7-44e7-b773-3f37ddb937cd/toscaModel\",\r\n \"category\": \"Network L4+\",\r\n \"distributionStatus\": \"DISTRIBUTED\",\r\n \"version\": \"1.0\",\r\n \"lifecycleStatus\": \"CERTIFIED\",\r\n \"relatedParty\": {\r\n \"id\": \"jm0007\",\r\n \"name\": \"Joni Mitchell\",\r\n \"role\": \"lastUpdater\"\r\n },\r\n \"resourceSpecification\": [\r\n {\r\n \"id\": \"ec910118-ba94-4517-98b5-5bc10f277f4a\",\r\n \"version\": \"1.0\",\r\n \"name\": \"TestVF_1579291137027\",\r\n \"resourceInstanceName\": \"TestVF_1579291137027 0\",\r\n \"modelCustomizationName\": \"TestVF_1579291137027 0\",\r\n \"resourceInvariantUUID\": \"df329320-fe21-49c2-96a8-7217ac7143de\",\r\n \"resourceType\": \"VF\",\r\n \"@type\": \"ONAPresource\",\r\n \"modelCustomizationId\": \"ad5fb501-e472-4d79-a303-1a4a56c0fa75\"\r\n }\r\n ],\r\n \"href\": \"serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"attachment\": [],\r\n \"@type\": \"ONAPservice\",\r\n \"instantiationType\": \"A-la-carte\",\r\n \"serviceSpecCharacteristic\": {\r\n \"name\": \"TestService_1579291137027_ServiceCharacteristics\",\r\n \"description\": \"This object describes all the inputs needed from the client to interact with the TestService_1579291137027 Service Topology\",\r\n \"valueType\": \"object\",\r\n \"@type\": \"ONAPServiceCharacteristic\",\r\n \"@schemaLocation\": \"null\",\r\n \"serviceSpecCharacteristicValue\": {\r\n \"valueType\": \"object\",\r\n \"@schemaLocation\": \"/serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd/specificationInputSchema\",\r\n \"@type\": \"TestService_1579291137027_ServiceCharacteristic\"\r\n }\r\n }\r\n}\n```\n\n#### To access Json Schema of the Parameters required to instantiate the Service from this Service Specification\n\n```\ncurl -X GET \"http://serverRoot:30274/nbi/api/v4/serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd/specificationInputSchema\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n{\r\n \"ServiceCharacteristics\" : {\r\n \"required\" : [ \"mscmevcendpointa_evcendpoint_endPointId\", \"mscmevcendpointz_evcendpoint_endPointId\", \"mscmsubscriberunia_subscriberuni_uniIdentifier\", \"mscmsubscriberuniz_subscriberuni_uniIdentifier\" ],\r\n \"properties\" : {\r\n \"mscmevcendpointa_evcendpoint_map\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmsubscriberunia_subscriberuni_uniIdentifier\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"String that is used to allow the Sub-scriber and Service Provider to uniquely identify the UNI for oper-ations purposes.\"\r\n },\r\n \"mscmevc0_evc_evcType\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"Point-to-Point, Multipoint-to-Mul-tipoint, or Rooted-Multipoint.\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_map\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_endPointUni\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"Specify the UNI where the EvcEndPoint is located. The EvcEndPoint is said to be at this Uni.\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_ingressBwp\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmsubscriberuniz_subscriberuni_uniIdentifier\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"String that is used to allow the Sub-scriber and Service Provider to uniquely identify the UNI for oper-ations purposes.\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_endPointId\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"A string that is used to allow the Subscriber and Service Provider to uniquely identify the EvcEndPoint for operations purposes.\"\r\n },\r\n \"mscmevcendpointa_evcendpoint_endPointId\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"A string that is used to allow the Subscriber and Service Provider to uniquely identify the EvcEndPoint for operations purposes.\"\r\n },\r\n \"mscmevcendpointa_evcendpoint_ingressBwp\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n\"mscmevc0_evc_listOfEvcEps\" : {\r\n \"type\" : \"array\",\r\n \"description\" : \"A list of EVC EP ID Service Attribute values.\"\r\n },\r\n \"mscmevc0_evc_evcId\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmevcendpointa_evcendpoint_endPointUni\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"Specify the UNI where the EvcEndPoint is located. The EvcEndPoint is said to be at this Uni.\"\r\n }\r\n }\r\n }\r\n\n```\n\n## Tutorials\nReference any tutorials or use cases. May use links.\n\nTo learn how the BBS use case used these APIs, please find the Low Level Designs at:\nhttps://wiki.onap.org/pages/viewpage.action?pageId=48532377\n\n## API Mapping Details\nIncludes:\n* Mapping between use cases/requirements and API calls. The BBS Use case used the Service Catalog API to learn the details of the Broad Service. This ServiceSpecification was then included in a Product Ordering as a Service Candidate from the BSS system.\n\n## Glossary\n### API Version\n\nThe version number has major, minor and revision numbers. E.g. v4.1.0 Only the major version number (without the minor number and revision number) is held in the URL. APIs are described with a major version with “v” following the API Name, e.g.: nbi/api/v4/serviceSpecification. The schema associated with a REST API must have its version number aligned with that of the REST API.\n\nThe major version number is incremented for an incompatible change. The minor version number is incremented for a compatible change. For minor modifications of the API, version numbering must not be updated, provided the following backward compatibility rules are respected:\n* New elements in a data type must be optional (minOccurs=0)\n* Changes in the cardinality of an attribute in a data type must be from mandatory to optional or from lower to greater\n* New attributes defined in an element must be optional (absence of use=”required”)\n* If new enumerated values are included, the former ones and its meaning must be kept\n* If new operations are added, the existing operations must be kept\n* New parameters added to existing operations must be optional and existing parameters must be kept\n\nFor major modifications of the API, not backward compatible and forcing client implementations to be changed, the major version number must be updated.", + "description": "# About the ONAP Service Catalog API\n The Service Catalog API is based on a subset of the TM Forum 633 Service Catalog Management API.\n## API Overview\n### General Description \nThis Service Catalog API is used to retrieve the Service Specifications that ONAP supports. As Services are designed and distributed in ONAP SDC, the Service Catalog API allows external systems such as the Business Support Systems (BSS) to discover these Services\n\nThe Service Design Center (SDC) of ONAP allows for the creation of Services that can be orchestrated by ONAP. ONAP SDC provides the tools to design the Services composition and topology, which is then represented in TOSCA. This Service Catalog API allows a REST API JSON representation of the Service, including the required attributes needed for Service Instantiation of this Service Topology.\n### Relationship and Dependencies\n This Service Catalog API is related to the TM Forum 633 Service Catalog Management API and also to MEF LSO LEGATO Service Catalog API.\n\nThis API takes a subset of the Service Catalog Management API, namely the ServiceSpecification resource, and maps this standard resource to the ONAP SDC Service Templates/Topology. By doing this we allow a well known, standardized JSON REST representation of the Service Templates available in ONAP to be potentially ordered via Service Orders. \n\n### API Structure and Approach\nThe Service Catalog API can be used to get the details of a specific ONAP Service Template, or can be used to search/list the Service Templates that are available. \n## Getting Started with the API (Hello World)\nThe Service Catalog API is available via two schemes, http and https. For interacting with the API the simplest method is via http. To interact with the this API via https, your Client would be required to load the neccessary https certificate. \n\nThe default installation of ONAP via OOM, will configure the use of two Node ports for External APIs. NodePorts are used to allow client applications, that run outside of Kubernetes, access to ONAP components deployed by OOM. For this Service Catalog API, the External API Framework has a http Node port of 30274. For https, the Node port is 30292.\n\n From outside ONAP, a client can interact with External API by first getting the IP that the NBI docker container is running on, and then using the appropriate nodeport according to the access scheme. For example to access this Service Catalog API to retrieve a list of all Service Specifications available in ONAP you can use http method GET to http://{nbi_ip}:30274/nbi/api/v4/serviceSpecification/ \n### SDK quick intro\nThere are many tools that can be used to view and edit this swagger file like swagger editor, Atom and senya. For example this swagger file can be loaded into https://editor.swagger.io/. This UI acts both as an online editor and viewer. \n### How to start the client side implementation\n* Code generation, is available via the Generate Client option in the swagger editor. Client stubs can be generated in multiple languages, for example java, go, python etc. These Client stub code can be incorporated in the Application you wish to access the Service Catalog API from.\n\n### How to start the server side implementation\n* Not applicable, the service side for this API will be the NBI container running the External API Framework Springboot application.\n\n## API Description\nIncludes summary of information drawn from API definitions in OpenAPI / Swagger files\n### Resource Endpoint / Resource Quick Reference\nGET /serviceSpecification/ : This operation returns a list service specifications from a catalog\n\nGET /serviceSpecification/{id} : This operation returns the service specifications from a catalog associated with this id. Note the id maps to the uuid of the SDC Service Template in the SDC catalog\n\nGET /serviceSpecification/{id}/specificationInputSchema : This operation returns a service specification Input schema by its id from a catalog. Note again the id corresponds to the uuid of the Service Template in SDC.\n\n### Data Schema\n#### Main API Entities\nDescribe the major entities used in the API\n\nThe main entity of the API is the ServiceSpecification resource. This entity is the top level entity of the API, and is returned as either a single instance when queried with id, or as JSON arroy of ServiceSpecification entities when queried as a list.\n\nThe major child enties are relatedParty which points to the designer of the Template in SDC. The resourceSpecification which point to child resources for the Service Template. The serviceSpecCharacteristics entities are used to describe the attributes that can be supplied to instantiate a Service Instance of this Service Template.\n#### Payload data structures\nIf any, describe the appropriate data structures that are included within payload of the API.\n\nNot applicable\n### Security on the API\nAuthentication; Authorization; Credentials/access token; etc.\n\n https certificate required if using https. No authentication on http requests.In production this API should be behind an API Gateway with the necessary authentication\n### Response Codes\nThe meaning of Status Codes & Errors\n\nSee response codes for each API resource in the API section below\n### Rate Limits and Thresholds\nRequests per unit time allowed; Pagination\n\n No rate limits or thresholds, in production this API should be behind an API Gateway with the necessary limits.\n### Validation constraints\nDescribe any behavioral and structural validation constraints\n\nNot applicable\n### Assumptions\nFor example, any Pre/Post conditions\n\n For this API to function and return Service Specifications, SDC is required to be running and Service models designed in the SDC catalog\n## API Interactions and Flows\n### Interaction Examples\nIllustrate sequence of client calls to this API, possibly based on Use Cases, presented with diagrams, tables, etc\n\nThe Service Catalog API flow of use can generally follow the sequence below\n\n\n#### Call ONAP to discover what available services it can offer\n\n```\ncurl -X GET \"http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceSpecification/\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n[\n {\r\n \"id\": \"0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"name\": \"EPLServiceTemplate\",\r\n \"invariantUUID\": \"ddf31f35-8e71-4f5a-a383-4241b87ca7a7\",\r\n \"category\": \"Network L4+\",\r\n \"distributionStatus\": \"DISTRIBUTED\",\r\n \"version\": \"1.0\",\r\n \"lifecycleStatus\": \"CERTIFIED\",\r\n \"relatedParty\": {\r\n \"id\": \"jm0007\",\r\n \"role\": \"lastUpdater\"\r\n }\r\n }\n]\n```\n#### Using the id returned from the list of Service Specifications, drill into any specific Service Specificaton you want to orchestrate/order using\n\n```\ncurl -X GET \"http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n{\r\n \"id\": \"0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"name\": \"EPLServiceTemplate\",\r\n \"invariantUUID\": \"ddf31f35-8e71-4f5a-a383-4241b87ca7a7\",\r\n \"toscaModelURL\": \"/sdc/v1/catalog/services/0ec83a1f-51e7-44e7-b773-3f37ddb937cd/toscaModel\",\r\n \"category\": \"Network L4+\",\r\n \"distributionStatus\": \"DISTRIBUTED\",\r\n \"version\": \"1.0\",\r\n \"lifecycleStatus\": \"CERTIFIED\",\r\n \"relatedParty\": {\r\n \"id\": \"jm0007\",\r\n \"name\": \"Joni Mitchell\",\r\n \"role\": \"lastUpdater\"\r\n },\r\n \"resourceSpecification\": [\r\n {\r\n \"id\": \"ec910118-ba94-4517-98b5-5bc10f277f4a\",\r\n \"version\": \"1.0\",\r\n \"name\": \"TestVF_1579291137027\",\r\n \"resourceInstanceName\": \"TestVF_1579291137027 0\",\r\n \"modelCustomizationName\": \"TestVF_1579291137027 0\",\r\n \"resourceInvariantUUID\": \"df329320-fe21-49c2-96a8-7217ac7143de\",\r\n \"resourceType\": \"VF\",\r\n \"@type\": \"ONAPresource\",\r\n \"modelCustomizationId\": \"ad5fb501-e472-4d79-a303-1a4a56c0fa75\"\r\n }\r\n ],\r\n \"href\": \"serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"attachment\": [],\r\n \"@type\": \"ONAPservice\",\r\n \"instantiationType\": \"A-la-carte\",\r\n \"serviceSpecCharacteristic\": {\r\n \"name\": \"TestService_1579291137027_ServiceCharacteristics\",\r\n \"description\": \"This object describes all the inputs needed from the client to interact with the TestService_1579291137027 Service Topology\",\r\n \"valueType\": \"object\",\r\n \"@type\": \"ONAPServiceCharacteristic\",\r\n \"@schemaLocation\": \"null\",\r\n \"serviceSpecCharacteristicValue\": {\r\n \"valueType\": \"object\",\r\n \"@schemaLocation\": \"/serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd/specificationInputSchema\",\r\n \"@type\": \"TestService_1579291137027_ServiceCharacteristic\"\r\n }\r\n }\r\n}\n```\n\n#### To access Json Schema of the Parameters required to instantiate the Service from this Service Specification\n\n```\ncurl -X GET \"http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceSpecification/0ec83a1f-51e7-44e7-b773-3f37ddb937cd/specificationInputSchema\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n{\r\n \"ServiceCharacteristics\" : {\r\n \"required\" : [ \"mscmevcendpointa_evcendpoint_endPointId\", \"mscmevcendpointz_evcendpoint_endPointId\", \"mscmsubscriberunia_subscriberuni_uniIdentifier\", \"mscmsubscriberuniz_subscriberuni_uniIdentifier\" ],\r\n \"properties\" : {\r\n \"mscmevcendpointa_evcendpoint_map\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmsubscriberunia_subscriberuni_uniIdentifier\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"String that is used to allow the Sub-scriber and Service Provider to uniquely identify the UNI for oper-ations purposes.\"\r\n },\r\n \"mscmevc0_evc_evcType\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"Point-to-Point, Multipoint-to-Mul-tipoint, or Rooted-Multipoint.\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_map\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_endPointUni\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"Specify the UNI where the EvcEndPoint is located. The EvcEndPoint is said to be at this Uni.\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_ingressBwp\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmsubscriberuniz_subscriberuni_uniIdentifier\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"String that is used to allow the Sub-scriber and Service Provider to uniquely identify the UNI for oper-ations purposes.\"\r\n },\r\n \"mscmevcendpointz_evcendpoint_endPointId\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"A string that is used to allow the Subscriber and Service Provider to uniquely identify the EvcEndPoint for operations purposes.\"\r\n },\r\n \"mscmevcendpointa_evcendpoint_endPointId\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"A string that is used to allow the Subscriber and Service Provider to uniquely identify the EvcEndPoint for operations purposes.\"\r\n },\r\n \"mscmevcendpointa_evcendpoint_ingressBwp\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n\"mscmevc0_evc_listOfEvcEps\" : {\r\n \"type\" : \"array\",\r\n \"description\" : \"A list of EVC EP ID Service Attribute values.\"\r\n },\r\n \"mscmevc0_evc_evcId\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"\"\r\n },\r\n \"mscmevcendpointa_evcendpoint_endPointUni\" : {\r\n \"type\" : \"string\",\r\n \"description\" : \"Specify the UNI where the EvcEndPoint is located. The EvcEndPoint is said to be at this Uni.\"\r\n }\r\n }\r\n }\r\n\n```\n\n## Tutorials\nReference any tutorials or use cases. May use links.\n\nTo learn how the BBS use case used these APIs, please find the Low Level Designs at:\nhttps://wiki.onap.org/pages/viewpage.action?pageId=48532377\n\n## API Mapping Details\nIncludes:\n* Mapping between use cases/requirements and API calls. The BBS Use case used the Service Catalog API to learn the details of the Broad Service. This ServiceSpecification was then included in a Product Ordering as a Service Candidate from the BSS system.\n\n## Glossary\n### API Version\n\nThe version number has major, minor and revision numbers. E.g. v4.1.0 Only the major version number (without the minor number and revision number) is held in the URL. APIs are described with a major version with “v” following the API Name, e.g.: nbi/api/v4/serviceSpecification. The schema associated with a REST API must have its version number aligned with that of the REST API.\n\nThe major version number is incremented for an incompatible change. The minor version number is incremented for a compatible change. For minor modifications of the API, version numbering must not be updated, provided the following backward compatibility rules are respected:\n* New elements in a data type must be optional (minOccurs=0)\n* Changes in the cardinality of an attribute in a data type must be from mandatory to optional or from lower to greater\n* New attributes defined in an element must be optional (absence of use=”required”)\n* If new enumerated values are included, the former ones and its meaning must be kept\n* If new operations are added, the existing operations must be kept\n* New parameters added to existing operations must be optional and existing parameters must be kept\n\nFor major modifications of the API, not backward compatible and forcing client implementations to be changed, the major version number must be updated.", "version": "4.1.0", "title": "ServiceCatalog API", "contact": { @@ -20,7 +20,7 @@ "backgroundColor": "#FFFFFF" } }, - "host": "serverRoot:30274", + "host": "nbi.api.simpledemo.onap.org:30274", "basePath": "/nbi/api/v4", "schemes": [ "http", @@ -683,4 +683,4 @@ } } } -}
\ No newline at end of file +} diff --git a/docs/offeredapis/api_serviceInventory/swagger.json b/docs/offeredapis/api_serviceInventory/swagger.json index 5756209..ec94681 100644 --- a/docs/offeredapis/api_serviceInventory/swagger.json +++ b/docs/offeredapis/api_serviceInventory/swagger.json @@ -2,7 +2,7 @@ { "swagger": "2.0", "info": { - "description": "# About the ONAP Service Inventory API\n The Service Inventory API is based on a subset of the TM Forum 638 Service Inventory API.\n## API Overview\n### General Description \nThis Service Inventory API is used to retrieve the Service Instances from the ONAP inventory. As Services are ordered from ONAP via the Service Order API, the Service Inventory API allows external systems such as the Business Support Systems (BSS) to discover the Services that have been created in the ONAP Inventory.\n\nThe Service Design Center (SDC) of ONAP allows for the creation of Services that can be orchestrated by ONAP. Once a Service from the Catalog is ordered, the ONAP Service Orchestrator will create a Service Instance within the AAI of ONAP. This API allows a representation of the Service Inventory in TMF 638 format. The Service Inventory API also supports inventory notifications to external listeners. A List of available subscription for serviceInventory notifications, see /hub resources for more information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n- ServiceRemoveNotification\n\n \n### Relationship and Dependencies\n This Service Inventory API is related to the TM Forum 638 Service Inventory API and also to MEF LSO LEGATO Service Inventory API.\n\nThis API takes a subset of the Service Inventory API, namely the Service resource, and maps this standard resource to the ONAP AAI Service Instance. By doing this we allow a well known, standardized JSON REST representation of the Service Instances available in ONAP to be visible by external systems. \n\n### API Structure and Approach\nThe Service Inventory API can be used to get the details of a specific ONAP Service Instance, or can be used to search/list the Service Instances that are in the ONAP AAI. \n## Getting Started with the API (Hello World)\nThe Service Inventory API is available via two schemes, http and https. For interacting with the API the simplest method is via http. To interact with the this API via https, your Client would be required to load the neccessary https certificate. \n\nThe default installation of ONAP via OOM, will configure the use of two Node ports for External APIs. NodePorts are used to allow client applications, that run outside of Kubernetes, access to ONAP components deployed by OOM. For this Service Inventory API, the External API Framework has a http Node port of 30274. For https, the Node port is 30292.\n\n From outside ONAP, a client can interact with External API by first getting the IP that the NBI docker container is running on, and then using the appropriate nodeport according to the access scheme. For example to access this Service Inventory API to retrieve a list of all Service Instances available in ONAP you can use http method GET to http://{nbi_ip}:30274/nbi/api/v4/service/ \n### SDK quick intro\nThere are many tools that can be used to view and edit this swagger file like swagger editor, Atom and senya. For example this swagger file can be loaded into https://editor.swagger.io/. This UI acts both as an online editor and viewer. \n### How to start the client side implementation\n* Code generation, is available via the Generate Client option in the swagger editor. Client stubs can be generated in multiple languages, for example java, go, python etc. These Client stub code can be incorporated in the Application you wish to access the Service Inventory API from.\n\n### How to start the server side implementation\n* Not applicable, the service side for this API will be the NBI container running the External API Framework Springboot application.\n\n## API Description\nIncludes summary of information drawn from API definitions in OpenAPI / Swagger files\n### Resource Endpoint / Resource Quick Reference\nGET /service/ : This operation returns a list service instances from AAI\n\nGET /service/{id} : This operation returns the specific service instance associated with this id. Note the id maps to the service-instance-id of the service-instance object in AAI.\n\n### Data Schema\n#### Main API Entities\nDescribe the major entities used in the API\n\nThe main entity of the API is the Service resource. This entity is the top level entity of the API, and is returned as either a single instance when queried with id, or as JSON arroy of Service entities when queried as a list.\n\nThe major child enties are relatedParty which points to the Customer who ordered the Service. The serviceSpecification which points to the Service template in SDC Catalog that was used to create this service instance.\n#### Payload data structures\nIf any, describe the appropriate data structures that are included within payload of the API.\n\nNot applicable\n### Security on the API\nAuthentication; Authorization; Credentials/access token; etc.\n\n https certificate required if using https. No authentication on http requests.In production this API should be behind an API Gateway with the necessary authentication\n### Response Codes\nThe meaning of Status Codes & Errors\n\nSee response codes for each API resource in the API section below\n### Rate Limits and Thresholds\nRequests per unit time allowed; Pagination\n\n No rate limits or thresholds, in production this API should be behind an API Gateway with the necessary limits.\n### Validation constraints\nDescribe any behavioral and structural validation constraints\n\nNot applicable\n### Assumptions\nFor example, any Pre/Post conditions\n\n For this API to function and return Service Instances, SDC is required to be running and Service models designed in the SDC catalog that have been ordered and instantiated by SO in AAI.\n## API Interactions and Flows\n### Interaction Examples\nIllustrate sequence of client calls to this API, possibly based on Use Cases, presented with diagrams, tables, etc\n\nThe Service Inventory API flow of use can generally follow the sequence below\n\n\n#### Call ONAP to discover what available services it has in the service inventory by listing them\n\n```\ncurl -X GET \"http://serverRoot:30274/nbi/api/v4/service/\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Using the id returned from the list of Service instances, drill into any specific Service instance you want to view using\n\n\n\n```\ncurl -X GET \"http://serverRoot:30274/nbi/api/v4/service/0ec83a1f-51e7-44e7-b773-3f37ddb937cd\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n{\"id\":\"c96fb8ec-8552-4956-8a8d-65680aaa57cc\",\"name\":\"Service_1234\",\"@type\":\"serviceONAP\",\"supportingResource\":[],\"serviceSpecification\":{\"id\":\"462f84e5-f0e5-44c5-ab95-38fb4bf77064\",\"name\":\"CS Template Name\",\"invariantUUID\":\"88dcb2f0-085b-4548-8b93-0882e37d25d8\",\"@type\":\"ONAPservice\"},\"state\":\"active\",\"relatedParty\":{\"role\":\"ONAPcustomer\",\"id\":\"CustomerId1\"},\"type\":\"service-instance\"}\r\n\n```\n\n", + "description": "# About the ONAP Service Inventory API\n The Service Inventory API is based on a subset of the TM Forum 638 Service Inventory API.\n## API Overview\n### General Description \nThis Service Inventory API is used to retrieve the Service Instances from the ONAP inventory. As Services are ordered from ONAP via the Service Order API, the Service Inventory API allows external systems such as the Business Support Systems (BSS) to discover the Services that have been created in the ONAP Inventory.\n\nThe Service Design Center (SDC) of ONAP allows for the creation of Services that can be orchestrated by ONAP. Once a Service from the Catalog is ordered, the ONAP Service Orchestrator will create a Service Instance within the AAI of ONAP. This API allows a representation of the Service Inventory in TMF 638 format. The Service Inventory API also supports inventory notifications to external listeners. A List of available subscription for serviceInventory notifications, see /hub resources for more information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n- ServiceRemoveNotification\n\n \n### Relationship and Dependencies\n This Service Inventory API is related to the TM Forum 638 Service Inventory API and also to MEF LSO LEGATO Service Inventory API.\n\nThis API takes a subset of the Service Inventory API, namely the Service resource, and maps this standard resource to the ONAP AAI Service Instance. By doing this we allow a well known, standardized JSON REST representation of the Service Instances available in ONAP to be visible by external systems. \n\n### API Structure and Approach\nThe Service Inventory API can be used to get the details of a specific ONAP Service Instance, or can be used to search/list the Service Instances that are in the ONAP AAI. \n## Getting Started with the API (Hello World)\nThe Service Inventory API is available via two schemes, http and https. For interacting with the API the simplest method is via http. To interact with the this API via https, your Client would be required to load the neccessary https certificate. \n\nThe default installation of ONAP via OOM, will configure the use of two Node ports for External APIs. NodePorts are used to allow client applications, that run outside of Kubernetes, access to ONAP components deployed by OOM. For this Service Inventory API, the External API Framework has a http Node port of 30274. For https, the Node port is 30292.\n\n From outside ONAP, a client can interact with External API by first getting the IP that the NBI docker container is running on, and then using the appropriate nodeport according to the access scheme. For example to access this Service Inventory API to retrieve a list of all Service Instances available in ONAP you can use http method GET to http://{nbi_ip}:30274/nbi/api/v4/service/ \n### SDK quick intro\nThere are many tools that can be used to view and edit this swagger file like swagger editor, Atom and senya. For example this swagger file can be loaded into https://editor.swagger.io/. This UI acts both as an online editor and viewer. \n### How to start the client side implementation\n* Code generation, is available via the Generate Client option in the swagger editor. Client stubs can be generated in multiple languages, for example java, go, python etc. These Client stub code can be incorporated in the Application you wish to access the Service Inventory API from.\n\n### How to start the server side implementation\n* Not applicable, the service side for this API will be the NBI container running the External API Framework Springboot application.\n\n## API Description\nIncludes summary of information drawn from API definitions in OpenAPI / Swagger files\n### Resource Endpoint / Resource Quick Reference\nGET /service/ : This operation returns a list service instances from AAI\n\nGET /service/{id} : This operation returns the specific service instance associated with this id. Note the id maps to the service-instance-id of the service-instance object in AAI.\n\n### Data Schema\n#### Main API Entities\nDescribe the major entities used in the API\n\nThe main entity of the API is the Service resource. This entity is the top level entity of the API, and is returned as either a single instance when queried with id, or as JSON arroy of Service entities when queried as a list.\n\nThe major child enties are relatedParty which points to the Customer who ordered the Service. The serviceSpecification which points to the Service template in SDC Catalog that was used to create this service instance.\n#### Payload data structures\nIf any, describe the appropriate data structures that are included within payload of the API.\n\nNot applicable\n### Security on the API\nAuthentication; Authorization; Credentials/access token; etc.\n\n https certificate required if using https. No authentication on http requests.In production this API should be behind an API Gateway with the necessary authentication\n### Response Codes\nThe meaning of Status Codes & Errors\n\nSee response codes for each API resource in the API section below\n### Rate Limits and Thresholds\nRequests per unit time allowed; Pagination\n\n No rate limits or thresholds, in production this API should be behind an API Gateway with the necessary limits.\n### Validation constraints\nDescribe any behavioral and structural validation constraints\n\nNot applicable\n### Assumptions\nFor example, any Pre/Post conditions\n\n For this API to function and return Service Instances, SDC is required to be running and Service models designed in the SDC catalog that have been ordered and instantiated by SO in AAI.\n## API Interactions and Flows\n### Interaction Examples\nIllustrate sequence of client calls to this API, possibly based on Use Cases, presented with diagrams, tables, etc\n\nThe Service Inventory API flow of use can generally follow the sequence below\n\n\n#### Call ONAP to discover what available services it has in the service inventory by listing them\n\n```\ncurl -X GET \"http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/service/\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Using the id returned from the list of Service instances, drill into any specific Service instance you want to view using\n\n\n\n```\ncurl -X GET \"http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/service/0ec83a1f-51e7-44e7-b773-3f37ddb937cd\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n{\"id\":\"c96fb8ec-8552-4956-8a8d-65680aaa57cc\",\"name\":\"Service_1234\",\"@type\":\"serviceONAP\",\"supportingResource\":[],\"serviceSpecification\":{\"id\":\"462f84e5-f0e5-44c5-ab95-38fb4bf77064\",\"name\":\"CS Template Name\",\"invariantUUID\":\"88dcb2f0-085b-4548-8b93-0882e37d25d8\",\"@type\":\"ONAPservice\"},\"state\":\"active\",\"relatedParty\":{\"role\":\"ONAPcustomer\",\"id\":\"CustomerId1\"},\"type\":\"service-instance\"}\r\n\n```\n\n", "version": "4.1.0", "title": "ServiceInventory API", "contact": { @@ -22,10 +22,10 @@ } }, - "host": "serverRoot:30274", + "host": "nbi.api.simpledemo.onap.org:30274", "basePath": "/nbi/api/v4", "schemes": [ - "http", "https" + "https" ], "produces": [ "application/json;charset=utf-8" diff --git a/docs/offeredapis/api_serviceOrder/swagger.json b/docs/offeredapis/api_serviceOrder/swagger.json index 94b0d61..d5d1c1e 100644 --- a/docs/offeredapis/api_serviceOrder/swagger.json +++ b/docs/offeredapis/api_serviceOrder/swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "# About the ONAP Service Order API\n The Service Catalog API is based on the TM Forum 641 Service Ordering API.\n ## API Overview\n### General Description \n The Service Order API is used to request the instantiation, deletion or modification of a service\n\nA Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describes the operation to be completed on a service (add, delete for example). The service order is triggered from external system such as the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.\n\nList of available subscription for serviceOrdering notifications, see /hub resources swagger for more detailed information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\n### Relationship and Dependencies\n This Service Ordering API is related to the TM Forum 641 Service Ordering API and also to MEF LSO LEGATO Service Ordering API.\n\nThis API takes a subset of the Service Ordering API formal specification and maps it to the internals of ONAP APIS. By doing this we allow a well known, standardized JSON REST representation of the Service Templates available in ONAP to be ordered via well known Service Order formet. The main interaction for a Service Order are with ONAP Service Orchestrator (SO) for Service Instanctiation, ONAP Service and Design Center (SDC) for validating the order is for a known ONAP Service and AAI to make sure that for a service deltion or modification order, that the service instance is a valid Service instance in the ONAP Inventory\n\n### API Structure and Approach\nThe Service Ordering API can be used to order a Service from ONAP for any specific ONAP Service Template offering in the ONAP Service Catalog, or it can be used to modify or delete a Service Instance that has been already created in ONAP inventory. \n## Getting Started with the API (Hello World)\nThe Service Ordering API is available via two schemes, http and https. For interacting with the API the simplest method is via http. To interact with this API via https, your Client would be required to load the neccessary https certificate. \n\nThe default installation of ONAP via OOM, will configure the use of two Node ports for External APIs. NodePorts are used to allow client applications, that run outside of Kubernetes, access to ONAP components deployed by OOM. For this Service Ordering API, the External API Framework has a http Node port of 30274. For https, the Node port is 30292.\n\n From outside ONAP, a client can interact with External API by first getting the IP that the NBI docker container is running on, and then using the appropriate nodeport according to the access scheme. For example to retrieve a list of all Service orders in ONAP SOM you can use http method GET to http://{nbi_ip}:30274/nbi/api/v4/serviceOrder/ \n### SDK quick intro\nThere are many tools that can be used to view and edit this swagger file like swagger editor, Atom and senya. For example this swagger file can be loaded into https://editor.swagger.io/. This UI acts both as an online editor and viewer. \n### How to start the client side implementation\n* Code generation, is available via the Generate Client option in the swagger editor. Client stubs can be generated in multiple languages, for example java, go, python etc. These Client stub code can be incorporated in the Application you wish to access the Service Ordering API from.\n\n### How to start the server side implementation\n* Not applicable, the service side for this API will be the NBI container running the External API Framework Springboot application.\n\n## API Description\nIncludes summary of information drawn from API definitions in OpenAPI / Swagger files\n### Resource Endpoint / Resource Quick Reference\nGET /serviceOrder/ : This operation returns a list service orders from External API Framework DB\n\nGET /serviceOrder/{id} : This operation returns the service order associated with this id.\n\n POST /serviceOrder : This operation is used to create a service order, with one of the following three action types, add, delete or modify. Note add is used to Instantiate a new service Instance of the specified Service Template ( SDC uuid) when NBI makes calls to SO to execute the instantiation workflows. The delete action is used to delete a specified service instance id ( AAI instance id ), while action modify is to modify the service instance.\n\n### Data Schema\n#### Main API Entities\nDescribe the major entities used in the API\n\nThe main entity of the API is the ServiceOrder resource. This entity is the top level entity of the API, and is returned as either a single instance when queried with id, or as JSON arroy of ServiceOrder entities when queried as a list.\n\nThe major child enties are relatedParty which points to the customer who is ordering the Service. This customer is related to the customer in the AAI where this servie instance for the order is placed. The orderItem is an array, meaning more that one service can be orders within the one Serice Order. i.e. each orderItem corresponds to one service instance. The serviceSpecCharacteristics entities are used to describe the attributes that can be supplied to instantiate a Service Instance of this Service Template.\n#### Payload data structures\nIf any, describe the appropriate data structures that are included within payload of the API.\n\nNot applicable\n### Security on the API\nAuthentication; Authorization; Credentials/access token; etc.\n\n https certificate required if using https. No authentication on http requests.In production this API should be behind an API Gateway with the necessary authentication\n### Response Codes\nThe meaning of Status Codes & Errors\n\nSee response codes for each API resource in the API section below\n### Rate Limits and Thresholds\nRequests per unit time allowed; Pagination\n\n No rate limits or thresholds, in production this API should be behind an API Gateway with the necessary limits.\n### Validation constraints\nDescribe any behavioral and structural validation constraints\n\nNot applicable\n### Assumptions\nFor example, any Pre/Post conditions\n\n For this API to function, SDC is required to be running and Service models designed in the SDC catalog. SO, AAI and DMaaP also need to be running as a minimum. \n## API Interactions and Flows\n### Interaction Examples\nIllustrate sequence of client calls to this API, possibly based on Use Cases, presented with diagrams, tables, etc\n\nThe Service Order API flow of use can generally follow the sequence below\n\n\n#### Call ONAP to discover what available services it can offer\n```\ncurl -X GET \"http://serverRoot:30274/nbi/api/v4/serviceSpecification/\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n[\n {\r\n \"id\": \"0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"name\": \"EPLServiceTemplate\",\r\n \"invariantUUID\": \"ddf31f35-8e71-4f5a-a383-4241b87ca7a7\",\r\n \"category\": \"Network L4+\",\r\n \"distributionStatus\": \"DISTRIBUTED\",\r\n \"version\": \"1.0\",\r\n \"lifecycleStatus\": \"CERTIFIED\",\r\n \"relatedParty\": {\r\n \"id\": \"jm0007\",\r\n \"role\": \"lastUpdater\"\r\n }\r\n }\n]\n```\n\nUsing the id returned from the list of Service Specifications, pick one you would like to order an instance of.\n Using the instantation serviceCharacteristics from the Catalog construct the Service Order POST body associated with this template.\n Then POST the Service Order with an action of add to ask ONAP to instanctiate a Service Instance.\n\n#### Example POST Service Order Body\n\n```\n{\r\n \"externalId\": \"BBS_BSS_TrackindId8888\",\r\n \"priority\": \"1\",\r\n \"description\": \"Service Order for a new HSIA CFS\",\r\n \"category\": \"Network Service\",\r\n \"relatedParty\": [\r\n {\r\n \"id\": \"BBSCustomer\",\r\n \"href\": null,\r\n \"role\": \"ONAPcustomer\",\r\n \"name\": \"EnterpriseA\",\r\n \"@referredType\": \"Consumer\"\r\n }\r\n ],\r\n \"orderItem\": [\r\n {\r\n \"id\": \"1\",\r\n \"action\": \"add\",\r\n \"service\": {\r\n \"name\": \"BBS_E2E_Service\",\r\n \"serviceState\": \"active\",\r\n \"serviceCharacteristic\": [\r\n {\r\n \"name\": \"ont_ont_serial_num\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_serial_num\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_rg_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"rg_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_downstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_access_id\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"profile_ip_access_id\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_swVersion\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_swVersion\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_manufacturer\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_manufacturer\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_service_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"service_type\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_pnf_name\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_pnf_name\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_upstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_nf_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_nf_type\"\r\n }\r\n }\r\n ],\r\n \"serviceSpecification\": {\r\n \"id\": \"90b476bc-0988-4417-bae9-41b376f0e1b6\"\r\n }\r\n }\r\n }\r\n ]\r\n}\n```\n\n\n#### You can then track the Service Order progress using the returned order id from the POST response. Use GET with the returned order id GET /nbi/api/v4/serviceOrder/5c988c98e3caf4000173cb4d\n\n#### Example GET Service Order by specific order id Response\n```\n\n{\r\n \"id\": \"5c988c98e3caf4000173cb4d\",\r\n \"href\": \"serviceOrder\/5c988c98e3caf4000173cb4d\",\r\n \"externalId\": \"BBS_BSS_TrackindId6979\",\r\n \"priority\": \"1\",\r\n \"description\": \"Service Order for a new HSIA CFS\",\r\n \"category\": \"Network Service\",\r\n \"state\": \"inProgress\",\r\n \"orderDate\": \"2019-03-25T08:08:56.297Z\",\r\n \"completionDateTime\": null,\r\n \"expectedCompletionDate\": null,\r\n \"requestedStartDate\": null,\r\n \"requestedCompletionDate\": null,\r\n \"startDate\": null,\r\n \"@baseType\": null,\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"relatedParty\": [\r\n {\r\n \"id\": \"testcustomer5\",\r\n \"href\": null,\r\n \"role\": \"ONAPcustomer\",\r\n \"name\": \"EnterpriseA\",\r\n \"@referredType\": \"Consumer\"\r\n }\r\n ],\r\n \"orderRelationship\": null,\r\n \"orderItem\": [\r\n {\r\n \"orderMessage\": [],\r\n \"id\": \"1\",\r\n \"action\": \"add\",\r\n \"state\": \"inProgress\",\r\n \"percentProgress\": \"0\",\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"@baseType\": null,\r\n \"orderItemRelationship\": [],\r\n \"service\": {\r\n \"id\": \"ee8ddf86-b653-4377-809a-05811fea8501\",\r\n \"href\": null,\r\n \"name\": \"BBS_E2E_Service\",\r\n \"serviceState\": \"active\",\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristic\": [\r\n {\r\n \"name\": \"ont_ont_serial_num\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_serial_num\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_rg_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"rg_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_downstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_access_id\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"profile_ip_access_id\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_swVersion\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_swVersion\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_manufacturer\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_manufacturer\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_service_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"service_type\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_pnf_name\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_pnf_name\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_upstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_nf_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_nf_type\"\r\n }\r\n }\r\n ],\r\n \"serviceRelationship\": null,\r\n \"relatedParty\": null,\r\n \"serviceSpecification\": {\r\n \"id\": \"90b476bc-0988-4417-bae9-41b376f0e1b6\",\r\n \"href\": null,\r\n \"name\": null,\r\n \"version\": null,\r\n \"targetServiceSchema\": null,\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"@baseType\": null\r\n }\r\n },\r\n \"orderItemMessage\": []\r\n }\r\n ],\r\n \"orderMessage\": null\r\n}\n```\n\n", + "description": "# About the ONAP Service Order API\n The Service Catalog API is based on the TM Forum 641 Service Ordering API.\n ## API Overview\n### General Description \n The Service Order API is used to request the instantiation, deletion or modification of a service\n\nA Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describes the operation to be completed on a service (add, delete for example). The service order is triggered from external system such as the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.\n\nList of available subscription for serviceOrdering notifications, see /hub resources swagger for more detailed information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\n### Relationship and Dependencies\n This Service Ordering API is related to the TM Forum 641 Service Ordering API and also to MEF LSO LEGATO Service Ordering API.\n\nThis API takes a subset of the Service Ordering API formal specification and maps it to the internals of ONAP APIS. By doing this we allow a well known, standardized JSON REST representation of the Service Templates available in ONAP to be ordered via well known Service Order formet. The main interaction for a Service Order are with ONAP Service Orchestrator (SO) for Service Instanctiation, ONAP Service and Design Center (SDC) for validating the order is for a known ONAP Service and AAI to make sure that for a service deltion or modification order, that the service instance is a valid Service instance in the ONAP Inventory\n\n### API Structure and Approach\nThe Service Ordering API can be used to order a Service from ONAP for any specific ONAP Service Template offering in the ONAP Service Catalog, or it can be used to modify or delete a Service Instance that has been already created in ONAP inventory. \n## Getting Started with the API (Hello World)\nThe Service Ordering API is available via two schemes, http and https. For interacting with the API the simplest method is via http. To interact with this API via https, your Client would be required to load the neccessary https certificate. \n\nThe default installation of ONAP via OOM, will configure the use of two Node ports for External APIs. NodePorts are used to allow client applications, that run outside of Kubernetes, access to ONAP components deployed by OOM. For this Service Ordering API, the External API Framework has a http Node port of 30274. For https, the Node port is 30292.\n\n From outside ONAP, a client can interact with External API by first getting the IP that the NBI docker container is running on, and then using the appropriate nodeport according to the access scheme. For example to retrieve a list of all Service orders in ONAP SOM you can use http method GET to http://{nbi_ip}:30274/nbi/api/v4/serviceOrder/ \n### SDK quick intro\nThere are many tools that can be used to view and edit this swagger file like swagger editor, Atom and senya. For example this swagger file can be loaded into https://editor.swagger.io/. This UI acts both as an online editor and viewer. \n### How to start the client side implementation\n* Code generation, is available via the Generate Client option in the swagger editor. Client stubs can be generated in multiple languages, for example java, go, python etc. These Client stub code can be incorporated in the Application you wish to access the Service Ordering API from.\n\n### How to start the server side implementation\n* Not applicable, the service side for this API will be the NBI container running the External API Framework Springboot application.\n\n## API Description\nIncludes summary of information drawn from API definitions in OpenAPI / Swagger files\n### Resource Endpoint / Resource Quick Reference\nGET /serviceOrder/ : This operation returns a list service orders from External API Framework DB\n\nGET /serviceOrder/{id} : This operation returns the service order associated with this id.\n\n POST /serviceOrder : This operation is used to create a service order, with one of the following three action types, add, delete or modify. Note add is used to Instantiate a new service Instance of the specified Service Template ( SDC uuid) when NBI makes calls to SO to execute the instantiation workflows. The delete action is used to delete a specified service instance id ( AAI instance id ), while action modify is to modify the service instance.\n\n### Data Schema\n#### Main API Entities\nDescribe the major entities used in the API\n\nThe main entity of the API is the ServiceOrder resource. This entity is the top level entity of the API, and is returned as either a single instance when queried with id, or as JSON arroy of ServiceOrder entities when queried as a list.\n\nThe major child enties are relatedParty which points to the customer who is ordering the Service. This customer is related to the customer in the AAI where this servie instance for the order is placed. The orderItem is an array, meaning more that one service can be orders within the one Serice Order. i.e. each orderItem corresponds to one service instance. The serviceSpecCharacteristics entities are used to describe the attributes that can be supplied to instantiate a Service Instance of this Service Template.\n#### Payload data structures\nIf any, describe the appropriate data structures that are included within payload of the API.\n\nNot applicable\n### Security on the API\nAuthentication; Authorization; Credentials/access token; etc.\n\n https certificate required if using https. No authentication on http requests.In production this API should be behind an API Gateway with the necessary authentication\n### Response Codes\nThe meaning of Status Codes & Errors\n\nSee response codes for each API resource in the API section below\n### Rate Limits and Thresholds\nRequests per unit time allowed; Pagination\n\n No rate limits or thresholds, in production this API should be behind an API Gateway with the necessary limits.\n### Validation constraints\nDescribe any behavioral and structural validation constraints\n\nNot applicable\n### Assumptions\nFor example, any Pre/Post conditions\n\n For this API to function, SDC is required to be running and Service models designed in the SDC catalog. SO, AAI and DMaaP also need to be running as a minimum. \n## API Interactions and Flows\n### Interaction Examples\nIllustrate sequence of client calls to this API, possibly based on Use Cases, presented with diagrams, tables, etc\n\nThe Service Order API flow of use can generally follow the sequence below\n\n\n#### Call ONAP to discover what available services it can offer\n```\ncurl -X GET \"http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceSpecification/\" -H \"accept: application/json;charset=utf-8\"\n```\n#### Example Response Values\n```\n[\n {\r\n \"id\": \"0ec83a1f-51e7-44e7-b773-3f37ddb937cd\",\r\n \"name\": \"EPLServiceTemplate\",\r\n \"invariantUUID\": \"ddf31f35-8e71-4f5a-a383-4241b87ca7a7\",\r\n \"category\": \"Network L4+\",\r\n \"distributionStatus\": \"DISTRIBUTED\",\r\n \"version\": \"1.0\",\r\n \"lifecycleStatus\": \"CERTIFIED\",\r\n \"relatedParty\": {\r\n \"id\": \"jm0007\",\r\n \"role\": \"lastUpdater\"\r\n }\r\n }\n]\n```\n\nUsing the id returned from the list of Service Specifications, pick one you would like to order an instance of.\n Using the instantation serviceCharacteristics from the Catalog construct the Service Order POST body associated with this template.\n Then POST the Service Order with an action of add to ask ONAP to instanctiate a Service Instance.\n\n#### Example POST Service Order Body\n\n```\n{\r\n \"externalId\": \"BBS_BSS_TrackindId8888\",\r\n \"priority\": \"1\",\r\n \"description\": \"Service Order for a new HSIA CFS\",\r\n \"category\": \"Network Service\",\r\n \"relatedParty\": [\r\n {\r\n \"id\": \"BBSCustomer\",\r\n \"href\": null,\r\n \"role\": \"ONAPcustomer\",\r\n \"name\": \"EnterpriseA\",\r\n \"@referredType\": \"Consumer\"\r\n }\r\n ],\r\n \"orderItem\": [\r\n {\r\n \"id\": \"1\",\r\n \"action\": \"add\",\r\n \"service\": {\r\n \"name\": \"BBS_E2E_Service\",\r\n \"serviceState\": \"active\",\r\n \"serviceCharacteristic\": [\r\n {\r\n \"name\": \"ont_ont_serial_num\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_serial_num\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_rg_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"rg_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_downstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_access_id\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"profile_ip_access_id\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_swVersion\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_swVersion\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_manufacturer\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_manufacturer\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_service_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"service_type\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_pnf_name\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_pnf_name\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_upstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_nf_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_nf_type\"\r\n }\r\n }\r\n ],\r\n \"serviceSpecification\": {\r\n \"id\": \"90b476bc-0988-4417-bae9-41b376f0e1b6\"\r\n }\r\n }\r\n }\r\n ]\r\n}\n```\n\n\n#### You can then track the Service Order progress using the returned order id from the POST response. Use GET with the returned order id GET /nbi/api/v4/serviceOrder/5c988c98e3caf4000173cb4d\n\n#### Example GET Service Order by specific order id Response\n```\n\n{\r\n \"id\": \"5c988c98e3caf4000173cb4d\",\r\n \"href\": \"serviceOrder\/5c988c98e3caf4000173cb4d\",\r\n \"externalId\": \"BBS_BSS_TrackindId6979\",\r\n \"priority\": \"1\",\r\n \"description\": \"Service Order for a new HSIA CFS\",\r\n \"category\": \"Network Service\",\r\n \"state\": \"inProgress\",\r\n \"orderDate\": \"2019-03-25T08:08:56.297Z\",\r\n \"completionDateTime\": null,\r\n \"expectedCompletionDate\": null,\r\n \"requestedStartDate\": null,\r\n \"requestedCompletionDate\": null,\r\n \"startDate\": null,\r\n \"@baseType\": null,\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"relatedParty\": [\r\n {\r\n \"id\": \"testcustomer5\",\r\n \"href\": null,\r\n \"role\": \"ONAPcustomer\",\r\n \"name\": \"EnterpriseA\",\r\n \"@referredType\": \"Consumer\"\r\n }\r\n ],\r\n \"orderRelationship\": null,\r\n \"orderItem\": [\r\n {\r\n \"orderMessage\": [],\r\n \"id\": \"1\",\r\n \"action\": \"add\",\r\n \"state\": \"inProgress\",\r\n \"percentProgress\": \"0\",\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"@baseType\": null,\r\n \"orderItemRelationship\": [],\r\n \"service\": {\r\n \"id\": \"ee8ddf86-b653-4377-809a-05811fea8501\",\r\n \"href\": null,\r\n \"name\": \"BBS_E2E_Service\",\r\n \"serviceState\": \"active\",\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristic\": [\r\n {\r\n \"name\": \"ont_ont_serial_num\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_serial_num\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_rg_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"rg_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_downstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_mac_addr\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_mac_addr\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_access_id\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"profile_ip_access_id\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_swVersion\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_swVersion\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_manufacturer\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_manufacturer\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_service_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"service_type\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_pnf_name\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_pnf_name\"\r\n }\r\n },\r\n {\r\n \"name\": \"edgeinternetprofile_ip_upstream_speed\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"10\"\r\n }\r\n },\r\n {\r\n \"name\": \"ont_ont_nf_type\",\r\n \"valueType\": null,\r\n \"value\": {\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"serviceCharacteristicValue\": \"ont_ont_nf_type\"\r\n }\r\n }\r\n ],\r\n \"serviceRelationship\": null,\r\n \"relatedParty\": null,\r\n \"serviceSpecification\": {\r\n \"id\": \"90b476bc-0988-4417-bae9-41b376f0e1b6\",\r\n \"href\": null,\r\n \"name\": null,\r\n \"version\": null,\r\n \"targetServiceSchema\": null,\r\n \"@type\": null,\r\n \"@schemaLocation\": null,\r\n \"@baseType\": null\r\n }\r\n },\r\n \"orderItemMessage\": []\r\n }\r\n ],\r\n \"orderMessage\": null\r\n}\n```\n\n", "version": "4.1.0", "title": "ServiceOrder API", "contact": { @@ -20,10 +20,10 @@ "backgroundColor": "#FFFFFF" } }, - "host": "serverRoot:30274", + "host": "nbi.api.simpledemo.onap.org:30274", "basePath": "/nbi/api/v4", "schemes": [ - "http", "https" + "https" ], "produces": [ "application/json;charset=utf-8" diff --git a/docs/offeredapis/api_status/swagger.json b/docs/offeredapis/api_status/swagger.json index 70e6a04..9e8885c 100644 --- a/docs/offeredapis/api_status/swagger.json +++ b/docs/offeredapis/api_status/swagger.json @@ -22,10 +22,10 @@ } }, - "host": "serverRoot:30274", + "host": "nbi.api.simpledemo.onap.org:30274", "basePath":"/nbi/api/v4", "schemes": [ - "http", "https" + "https" ], "produces": [ "application/json;charset=utf-8" diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 02817f3..0d1bb04 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -26,6 +26,18 @@ integration with other ONAP components and API resource/operation provided. .. image:: ../images/onap_nbi_dublin.jpg :width: 800px +************ +API Endpoint +************ + +Since Frankfurt, in an OOM ONAP deployment context: + +https://nbi.api.simpledemo.onap.org:30274/nbi/api/v4 + +Locally, for dev and testing purpose: + +http://localhost:8080/nbi/api/v4 + *********** API Version *********** |