From a6c6e4b1721a3cf88f927d098d32e1c11562309a Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Wed, 7 Dec 2022 09:34:51 +0100 Subject: [PATCH] Refine documentation Issue-ID: NONRTRIC-814 Signed-off-by: elinuxhenrik Change-Id: Id29f0062687048e4a0d4f7e3a22d35808ebdf30b --- capifcore/README.md | 6 +- .../docs/diagrams/Information model for CAPIF.svg | 8 +-- capifcore/docs/diagrams/Register Provider.svg | 84 ++++++++++++---------- capifcore/docs/diagrams/classdiagram.plantuml | 2 +- .../registerpoviderandpublishservice.plantuml | 82 +++++++++++---------- 5 files changed, 101 insertions(+), 81 deletions(-) diff --git a/capifcore/README.md b/capifcore/README.md index 4ccb557..faa18a6 100644 --- a/capifcore/README.md +++ b/capifcore/README.md @@ -28,13 +28,13 @@ The, almost, complete data model for CAPIF is shown in the diagram below. -The data used within CAPIF Core for registering an rApp that both provides and consumes services is shown in the diagram below. +The data used within CAPIF Core for registering rApps that both provides and consumes services is shown in the diagram below. -An example of how an rApp that both provides and consumes services can be registered in CAPIF Core is shown in the sequence diagram below. Discovery of services, request for access token and event subscription for an invoker is also shown. +Some examples of interactions between components using the CAPIF interface are shown in the sequence diagram below. -***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. +***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. diff --git a/capifcore/docs/diagrams/Information model for CAPIF.svg b/capifcore/docs/diagrams/Information model for CAPIF.svg index 9130cdf..d24fe23 100644 --- a/capifcore/docs/diagrams/Information model for CAPIF.svg +++ b/capifcore/docs/diagrams/Information model for CAPIF.svg @@ -45,7 +45,7 @@ class Log-->GetApiInvocationLogsParamsstring aefIdstring apiInvokerIdDateTime timeRangeStartDateTime timeRangeEndstring apiIdstring apiNamestring apiVersionProtocol protocolOperation operationstring resultstring resourceNameInterfaceDescription srcInterfaceRoutingInfo[]RoutingRule routingRules (required)RoutingRule[]Ipv4AddressRange ipv4AddrRanges[]Ipv6AddressRange ipv6AddrRangesAefProfile aefProfile (required)GetServiceApisServiceApiIdParamsSupportedFeatures suppFeatstring aefId (required)A call withGetServiceApisServiceApiIdParamsreturns a RoutingRuleAPIList containing servicesavailable for the invoker.Provided by capifcoreServices 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 publishedA call withGetApiInvocationLogsParamsreturns an InvocationLogGetServiceApisServiceApiIdParamsSupportedFeatures suppFeatstring aefId (required)A call withGetServiceApisServiceApiIdParamsreturns a RoutingInfoAPIList containing servicesavailable for the invoker.Provided by capifcoreServices 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 publishedA call withGetApiInvocationLogsParamsreturns an InvocationLog11..N1111< reverse link RoutingRule to AefProfile-->11