From faeeb4bfe079a2f20ac1639fc394a363306411c9 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Tue, 29 Nov 2022 10:25:16 +0100 Subject: [PATCH] Improve documentation Issue-ID: NONRTRIC-814 Signed-off-by: elinuxhenrik Change-Id: Ia36a37c17b8ce636aeda686f84ae0823c37af629 --- .../diagrams/Information in rApp registration.svg | 160 ++++++++++++++------- capifcore/docs/diagrams/Register Provider.svg | 5 +- capifcore/docs/diagrams/classdiagram.plantuml | 106 +++++++++----- .../registerpoviderandpublishservice.plantuml | 3 +- 4 files changed, 179 insertions(+), 95 deletions(-) diff --git a/capifcore/docs/diagrams/Information in rApp registration.svg b/capifcore/docs/diagrams/Information in rApp registration.svg index 46a0ccf..4e7dd5f 100644 --- a/capifcore/docs/diagrams/Information in rApp registration.svg +++ b/capifcore/docs/diagrams/Information in rApp registration.svg @@ -1,27 +1,46 @@ -APIProviderEnrolmentDetailsstring apiProvDomIdstring apiProvDomInfo[]APIProviderFunctionDetails apiProvFuncsId provided by CAPIF CoreAPIProviderFunctionDetailsstring apiProvFuncIdstring apiProvFuncInfoApiProviderFuncRole apiProviderFuncRole (required)RegistrationInformation regInfo (required)Id provided by CAPIF Core- AEF: API provider function is API Exposing Function.- APF: API provider function is API Publishing Function.- AMF: API Provider function is API Management Function.RegistrationInformationstring apiProvCertatring apiProvPubKey (required)ServiceAPIDescriptionstring apiIdstring description[]AefProfile aefProfilesstring apiName (required)Id provided by CAPIF CoreAefProfileDataFormat dataFormatstring domainName[]InterfaceDescription interfaceDescriptionsProtocol protocol[]SecurityMethod securityMethodsstring aefId (required)[]Version versions (required)- JSON: JavaScript Object Notation- HTTP_1_1: HTTP version 1.1- HTTP_2: HTTP version 2- PSK: Security method 1 (Using TLS-PSK)- PKI: Security method 2 (Using PKI)- OAUTH: Security method 3 (TLS with OAuth token)From APIProviderFunctionDetailsInterfaceDescriptionstring ipv4Addressstring ipv6Address[]Operation operations[]SecurityMethod securityMethodsSecurity methods supported by the interface,it take precedence over the security methodsprovided in AefProfile, for this specific interface.Versionstring apiVersion[]Resource resources- REQUEST_RESPONSE- SUBSCRIBE_NOTIFYAPIInvokerEnrolmentDetailsstring apiInvokerIdstring apiInvokerInformationAPIList apiListOnboardingInformation onboardingInformationOnboardingInformationstring apiInvokerCertificatestring onboardingSecretstring ApiInvokerPublicKey (required)Secret provided by CAPIF CoreId provided by CAPIF CoreAPIListAPIProviderEnrolmentDetailsstring apiProvDomIdstring apiProvDomInfo[]APIProviderFunctionDetails apiProvFuncsstring regSec (required)Id provided by CAPIF CoreAPIProviderFunctionDetailsstring apiProvFuncIdstring apiProvFuncInfoApiProviderFuncRole apiProviderFuncRole (required)RegistrationInformation regInfo (required)Id provided by CAPIF CoreApiProviderFuncRoleAEF: API provider function is API Exposing Function.APF: API provider function is API Publishing Function.AMF: API Provider function is API Management Function.RegistrationInformationstring apiProvCertstring apiProvPubKey (required)ServiceAPIDescriptionstring apiIdstring description[]AefProfile aefProfilesstring apiName (required)Id provided by CAPIF CoreAefProfileDataFormat dataFormatstring domainName[]InterfaceDescription interfaceDescriptionsProtocol protocol[]SecurityMethod securityMethodsstring aefId (required)[]Version versions (required)DataFormatJSONProtocolHTTP_1_1HTTP_2AefProfile::aefId should matchAPIProviderFunctionDetails::apiProvFuncIdInterfaceDescriptionstring ipv4Addressstring ipv6Addressint port[]SecurityMethod securityMethodsSecurity methods supported by the interface,it take precedence over the security methodsprovided in AefProfile, for this specific interface.Version[]CustomOperation custOperationsDateTime expiry[]Resource resourcesstring apiVersion (required)CustomOperationstring description[]Operation operationsCommunicationType commType (required)string custOpName (required)OperationGETPOSTPUTPATCHDELETESecurityMethodPSKPKIOAUTHResourcestring descriptionstring resourceName (required)string uri (required)CommunicationType commType (required)CommunicationTypeREQUEST_RESPONSESUBSCRIBE_NOTIFYAPIInvokerEnrolmentDetailsstring apiInvokerIdstring apiInvokerInformationAPIList apiListOnboardingInformation onboardingInformation (required)OnboardingInformationstring apiInvokerCertificatestring onboardingSecretstring ApiInvokerPublicKey (required)Secret provided by CAPIF CoreId provided by CAPIF Core11..N111111..N11..N0..10..111..N0..10..N11..N11..N1..N1..N0..10..N110..N0..N11APIList11..N11