From 631e0ba52434a220c89469aee04a5d06b5c10827 Mon Sep 17 00:00:00 2001
From: JorgeEcheva26 <jorge.echevarriauribarri.practicas@telefonica.es>
Date: Tue, 4 Feb 2025 12:25:57 +0100
Subject: [PATCH] Doc changes
---
README.md | 2 +-
doc/sdk_full_documentation.md | 3 ++-
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 337108e..1154502 100644
--- a/README.md
+++ b/README.md
@@ -159,7 +159,7 @@ Now, it is described in 4 simple steps how a Provider can be developed in just s
provider.onboard_provider()
#translator = opencapif_sdk.api_schema_translator("./path/to/openapi.yaml")
- #translator.build("api_description_name",ip="0.0.0.0",port=9090)
+ #translator.build("api_description_name",ip="0.0.0.0",port=9090,supported_features="0",api_supp_features="0")
provider.api_description_path = "./api_description_name.json"
APF = provider.provider_capif_ids["APF-1"]
diff --git a/doc/sdk_full_documentation.md b/doc/sdk_full_documentation.md
index 3377baa..990c0a8 100644
--- a/doc/sdk_full_documentation.md
+++ b/doc/sdk_full_documentation.md
@@ -337,9 +337,10 @@ This schema could be obtained by applying this code.
import opencapif_sdk
translator = opencapif_sdk.api_schema_translator("./path/to/openapi.yaml")
- translator.build("api_description_name",ip="0.0.0.0",port=9090)
+ translator.build("api_description_name",ip="0.0.0.0",port=9090,supported_features="0",api_supp_features="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.
### CAPIF Registration and Login
--
GitLab