Commit 972970d0 authored by JorgeEcheva26's avatar JorgeEcheva26
Browse files

Doc changes

parent 04a765d8

README.md

+1 −1
Original line number Diff line number Diff line
@@ -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"]

doc/sdk_full_documentation.md

+2 −1
Original line number Diff line number Diff line
@@ -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