X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=capifcore%2Fdocs%2Fdiagrams%2FInformation%20in%20rApp%20registration.svg;h=2ce5f1a4ef5a413a0c554c7296125dc30bc7efee;hb=refs%2Fchanges%2F54%2F9954%2F2;hp=46a0ccf909690b72946620f0403acbdb8f9908a7;hpb=cf1b587eba848c3500c4ffa020d1665f3fc7021f;p=nonrtric%2Fplt%2Fsme.git diff --git a/capifcore/docs/diagrams/Information in rApp registration.svg b/capifcore/docs/diagrams/Information in rApp registration.svg index 46a0ccf..2ce5f1a 100644 --- a/capifcore/docs/diagrams/Information in rApp registration.svg +++ b/capifcore/docs/diagrams/Information in rApp registration.svg @@ -1,130 +1,620 @@ -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 CoreAPIListProvider ServicePublish ServiceInvoker ManagementDiscover ServiceSecurity ServiceEvent ServiceAccess Control PolicyAPIProviderEnrolmentDetailsstring 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 serviceAPIDescriptionsAccessTokenReqstring client_secretstring scopestring grant_type (required)string client_id (required)AccessTokenRspstring scopestring access_token (required)string token_type (required)DurationSec expires_in (required)EventSubscriptionReportingInformation eventReq[]CAPIFEventFilter eventFilters[]CAPIFEvent events (required)Uri notificationDestination (required)CAPIFEventFilter[]string aefIds[]string apiIds[]string apiInvokerIdsCAPIFEventSERVICE_API_AVAILABLESERVICE_API_UNAVAILABLESERVICE_API_UPDATEAPI_INVOKER_ONBOARDEDAPI_INVOKER_OFFBOARDEDSERVICE_API_INVOCATION_SUCCESSSERVICE_API_INVOCATION_FAILUREACCESS_CONTROL_POLICY_UPDATEACCESS_CONTROL_POLICY_UNAVAILABLEAPI_INVOKER_AUTHORIZATION_REVOKEDAPI_INVOKER_UPDATEDAPI_TOPOLOGY_HIDING_CREATEDAPI_TOPOLOGY_HIDING_REVOKEDReportingInformationDurationSec grpRepTimebool immRepUinteger maxReportNbrNotificationFlag notifFlagNotificationMethod notifMethodPartitioningCriteria partitionCriteriaDurationSec repPeriodSamplingRation sampRatioCAPIFEventDetailAccessControlPolicyListExt accCtrlPolList[]string apiIds[]string apiInvokerIds[]ServiceAPIDescription serviceAPIDescriptionsAccessControlPolicyListExtAccessControlPolicyList accessControlPolicyListstring apiIdAccessControlPolicyList[]ApiInvokerPolicy apiInvokerPoliciesApiInvokerPolicy[]TimeRangeList allowedInvocationTimeRangeListint allowedInvocationsPerSecondint allowedTotalInvocationsstring apiInvokerId (required)TimeRangeListDateTime startTimeDateTime stopTimeId provided by CAPIF CoreSecret provided by CAPIF CoreServices can only be discoveredfor an onboarded invoker throughAPIInvokerEnrolmentDetails::apiInvokerIdAccessTokenReq::client_id andAccessTokenReq::client_secretmust match registered invokerFunction provided inAccessTokenReq:scopemust be registered for a providerAPI provided inAccessTokenReq:scopemust be published11..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..N0..N0..N11..N0..N0..N0..N0..N0..N0..N0..N0..N0..N0..N0..N0..N