Apply feedback (c8e8c981) · Commits · OCF / documentation

doc/sdk/sdk_configuration.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -65,7 +65,7 @@ This section is mandatory when using the [CAPIF Publish Service API](https://git
		The `api_description_path` must point to the Publish API to be shared, and it should follow the [ServiceAPIDescription](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) schema.

		To obtain this schema, opencapif_sdk has a facility to translate Openapi structures to ServiceAPIDescription schemas.
		More information: [Translator functionality](./sdk_full_documentation.md#openapi-translation)
		More information: [Translator functionality](./sdk_openapi_translation.md)

		If the `publisher_aefs_ids` do not match the `aefProfiles` in the API description, an error will be raised by the SDK.

doc/sdk/sdk_full_documentation.md

+2 −16

Original line number	Diff line number	Diff line
		@@ -68,7 +68,7 @@ The SDK streamlines API publishing with the option to select specific APFs and A
		It is also important to have previously prepared the API schema description file of the API to be published. This file must follow the [CAPIF_Publish_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) 3GPP specification.

		To obtain this schema, opencapif_sdk has a facility to translate Openapi structures to ServiceAPIDescription schemas.
		More information: [Translator functionality](#openapi-translation)
		More information: [Translator functionality](./sdk_openapi_translation.md)

		Important: The SDK will automatically add in the `custom operations`, within the API description path, the capabilities for exposing the [AEF_security](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_AEF_Security_API.yaml) methods. The developer must code this API endpoints.

		@@ -343,21 +343,7 @@ Onboarding is required before utilizing these functions.

		![Invoker_update-offboard](../images/architecture/sdk/flows-invoker_update_offboard.jpg)

		## Other Features

		### Openapi translation

		The `api_description_path` must point to the Publish API to be shared, and it should follow the [ServiceAPIDescription](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) schema.

		This schema could be obtained by applying this code.
		```python
		import opencapif_sdk

		translator = opencapif_sdk.api_schema_translator("./path/to/openapi.yaml")
		translator.build("https://192.168.1.10:8080/exampleAPI/v1", "0", "0")
		```
		This code will read `openapi.yaml`, ensure the structure of it and translate the content into ServiceAPIDescription schema, then will create a .json named `api_description_name`. Also it is necessary to fill the ip and port fields to create correctly the schema.
		The supported_features and api_supp_features fields corresponds to the capabilities of the provider and the service that the user is sharing.
		## Additional Features

		### CAPIF Registration and Login

doc/sdk/sdk_introduction.md

+2 −1

Original line number	Diff line number	Diff line
		@@ -9,7 +9,8 @@ OpenCAPIF SDK provides a set of libraries that enable either CAPIF provider or i

		Current version of OpenCAPIF SDK is compatible with following publicly available releases:

		- [OpenCAPIF Release 1.0](../releasenotes.md#release-100)
		- [OpenCAPIF Release 3.0](../releasenotes.md#release-300)
		- [OpenCAPIF Release 2.0](../releasenotes.md#release-200)
		- [OpenCAPIF Release 1.0](../releasenotes.md#release-100)

		This document serves as the [main reference](./sdk_requirements.md#network-app-developer-path) to start working with OpenCAPIF SDK. For advanced users, refer to [OpenCAPIF full documentation](./sdk_full_documentation.md) section to dig into all available features.
		No newline at end of file

doc/sdk/sdk_known_issues.md

0 → 100644

+12 −0

Original line number	Diff line number	Diff line
		# OpenCAPIF SDK known issues

		There are some features which are not currently available at latest OpenCAPIF SDK release. Those are assumed to be technical debt and might be available in future releases:

		- [CAPIF Access control policy management](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Access_Control_Policy_API.yaml)
		- [CAPIF Auditing API management](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Auditing_API.yaml)
		- [CAPIF Routing info API management](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Routing_Info_API.yaml)
		- [CAPIF Security API management](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Security_API.yaml)
		- /trustedInvokers/{apiInvokerId}/delete (POST)
		- /trustedInvokers/{apiInvokerId} (GET)
		- /trustedInvokers/{apiInvokerId} (DELETE)
		- Nontype Error: When using SDK as a Provider, if the user does update the provider to more AEFs/APFs than previously, the SDK has an error using the publish functionality

doc/sdk/sdk_openapi_translation.md

0 → 100644

+15 −0

Original line number	Diff line number	Diff line
		# OpenAPI translation

		The `api_description_path` must point to the Publish API to be shared, and it should follow the [ServiceAPIDescription](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) schema.

		This schema could be obtained by applying this code.

		```python
		import opencapif_sdk

		translator = opencapif_sdk.api_schema_translator("./path/to/openapi.yaml")
		translator.build("https://192.168.1.10:8080/exampleAPI/v1", "0", "0")
		```

		This code will read `openapi.yaml`, ensure the structure of it and translate the content into ServiceAPIDescription schema, then will create a .json named `api_description_name`. Also it is necessary to fill the ip and port fields to create correctly the schema.
		The supported_features and api_supp_features fields corresponds to the capabilities of the provider and the service that the user is sharing.