From: elinuxhenrik Date: Thu, 1 Dec 2022 14:19:01 +0000 (+0100) Subject: Refine documentation X-Git-Tag: 1.0.0~14^2~1 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=ef6957cb0304235c5b12e93148c1d6da17f6c11d;hp=faeeb4bfe079a2f20ac1639fc394a363306411c9;p=nonrtric%2Fplt%2Fsme.git Refine documentation Issue-ID: NONRTRIC-814 Signed-off-by: elinuxhenrik Change-Id: I552b5e1713b04a06db62ab24fc711844340aba8a --- diff --git a/capifcore/README.md b/capifcore/README.md index 9242007..922783c 100644 --- a/capifcore/README.md +++ b/capifcore/README.md @@ -28,9 +28,9 @@ The data used within CAPIF Core is shown in the diagram below. -An example of how an rApp that both exposes and consumes services can be registered in CAPIF Core is shown in the sequence diagram below. +An example of how an rApp that both exposes and consumes services can be registered in CAPIF Core is shown in the sequence diagram below. Discovery of services for an invoker is also shown. -***NOTE!*** It has not been decided that CAPIF Core will actually do the Helm chart installation and starting. This is just provided in the prototype as an example of what CAPIF Core could do. Before publisihing a service, the chart that belongs to the service must be registered in ChartMusem. When publishing the service the following information should be provided in the `ServiceAPIDescription::description` attribute; "namespace", "repoName", "chartName", "releaseName". An exaple of the information: "Description of rApp helloWorld,namespace,repoName,chartName,releaseName". +***NOTE!*** It has not been decided that CAPIF Core will actually do the Helm chart installation. This is just provided in the prototype as an example of what CAPIF Core could do. Before publisihing a service, the chart that belongs to the service must be registered in ChartMusem. When publishing the service the following information should be provided in the `ServiceAPIDescription::description` attribute; "namespace", "repoName", "chartName", "releaseName". An example of the information: "Description of rApp helloWorld,namespace,repoName,chartName,releaseName". diff --git a/capifcore/docs/diagrams/Information in rApp registration.svg b/capifcore/docs/diagrams/Information in rApp registration.svg index 4e7dd5f..5d1a14a 100644 --- a/capifcore/docs/diagrams/Information in rApp registration.svg +++ b/capifcore/docs/diagrams/Information in rApp registration.svg @@ -1,144 +1,161 @@ -APIProviderEnrolmentDetailsstring 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..N11Provider ServicePublish ServiceInvoker ManagementDiscover ServiceAPIProviderEnrolmentDetailsstring 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 CoreapfId matchingAPIProviderFunctionDetails::apiProvFuncIdmust be provided when publishingAefProfileDataFormat 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)DiscoveredAPIs[]ServiceAPIDescription serviceAPIDescriptionsSecret provided by CAPIF CoreId provided by CAPIF CoreServices can only be discoveredfor an onboarded invoker throughAPIInvokerEnrolmentDetails::apiId11..N111111..N11..N0..10..111..N0..10..N11..N11..N1..N1..N0..10..N110..N0..N11APIList containing servicesavailable for the invoker.Provided by capifcore11..N110..N0..N