Adding documentation for provider

[nonrtric/plt/sme.git] / provider / docs / Register API Provider Domain.svg

diff --git a/provider/docs/Register API Provider Domain.svg b/provider/docs/Register API Provider Domain.svg
new file mode 100644 (file)
index 0000000..9308c71
--- /dev/null
+++ b/provider/docs/Register API Provider Domain.svg
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="452px" preserveAspectRatio="none" style="width:635px;height:452px;background:#FFFFFF;" version="1.1" viewBox="0 0 635 452" width="635px" zoomAndPan="magnify"><defs/><g><rect fill="#DDDDDD" height="440.0547" style="stroke:#181818;stroke-width:0.5;" width="391" x="238" y="6"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacing" textLength="104" x="381.5" y="18.0669">CAPIF Internal</text><rect fill="#98FB98" height="251.4609" style="stroke:#000000;stroke-width:1.5;" width="563.5" x="10" y="98.2969"/><line style="stroke:#181818;stroke-width:0.5;stroke-dasharray:5.0,5.0;" x1="70" x2="70" y1="81.2969" y2="366.7578"/><line style="stroke:#181818;stroke-width:0.5;stroke-dasharray:5.0,5.0;" x1="280" x2="280" y1="81.2969" y2="366.7578"/><line style="stroke:#181818;stroke-width:0.5;stroke-dasharray:5.0,5.0;" x1="412" x2="412" y1="81.2969" y2="366.7578"/><line style="stroke:#181818;stroke-width:0.5;stroke-dasharray:5.0,5.0;" x1="568" x2="568" y1="81.2969" y2="366.7578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="95" x="20" y="77.9951">ProviderClient</text><ellipse cx="70.5" cy="13.5" fill="#E2E2F0" rx="8" ry="8" style="stroke:#181818;stroke-width:0.5;"/><path d="M70.5,21.5 L70.5,48.5 M57.5,29.5 L83.5,29.5 M70.5,48.5 L57.5,63.5 M70.5,48.5 L83.5,63.5 " fill="none" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="95" x="20" y="378.7529">ProviderClient</text><ellipse cx="70.5" cy="390.5547" fill="#E2E2F0" rx="8" ry="8" style="stroke:#181818;stroke-width:0.5;"/><path d="M70.5,398.5547 L70.5,425.5547 M57.5,406.5547 L83.5,406.5547 M70.5,425.5547 L57.5,440.5547 M70.5,425.5547 L83.5,440.5547 " fill="none" style="stroke:#181818;stroke-width:0.5;"/><rect fill="#E2E2F0" height="30.2969" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="77" x="242" y="50"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="63" x="249" y="69.9951">capifcore</text><rect fill="#E2E2F0" height="30.2969" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="77" x="242" y="365.7578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="63" x="249" y="385.7529">capifcore</text><rect fill="#E2E2F0" height="30.2969" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="131" x="347" y="50"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="117" x="354" y="69.9951">providermanager</text><rect fill="#E2E2F0" height="30.2969" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="131" x="347" y="365.7578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="117" x="354" y="385.7529">providermanager</text><rect fill="#E2E2F0" height="30.2969" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="113" x="512" y="50"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="99" x="519" y="69.9951">publishservice</text><rect fill="#E2E2F0" height="30.2969" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="113" x="512" y="365.7578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="99" x="519" y="385.7529">publishservice</text><path d="M10,98.2969 L74,98.2969 L74,105.4297 L64,115.4297 L10,115.4297 L10,98.2969 " fill="#98FB98" style="stroke:#000000;stroke-width:1.5;"/><rect fill="none" height="251.4609" style="stroke:#000000;stroke-width:1.5;" width="563.5" x="10" y="98.2969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacing" textLength="19" x="25" y="111.3638">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacing" textLength="132" x="89" y="110.5073">[Provider Enrolment]</text><polygon fill="#181818" points="268.5,147.6953,278.5,151.6953,268.5,155.6953,272.5,151.6953" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="70.5" x2="274.5" y1="151.6953" y2="151.6953"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="137" x="77.5" y="131.4966">Register provider with</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="182" x="81.5" y="146.6294">APIProviderEnrolmentDetails</text><polygon fill="#181818" points="400.5,176.8281,410.5,180.8281,400.5,184.8281,404.5,180.8281" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="280.5" x2="406.5" y1="180.8281" y2="180.8281"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="108" x="287.5" y="175.7622">Register provider</text><line style="stroke:#181818;stroke-width:1.0;" x1="412.5" x2="454.5" y1="240.2266" y2="240.2266"/><line style="stroke:#181818;stroke-width:1.0;" x1="454.5" x2="454.5" y1="240.2266" y2="253.2266"/><line style="stroke:#181818;stroke-width:1.0;" x1="413.5" x2="454.5" y1="253.2266" y2="253.2266"/><polygon fill="#181818" points="423.5,249.2266,413.5,253.2266,423.5,257.2266,419.5,253.2266" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="136" x="419.5" y="204.895">Create apiProvDomId</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="123" x="423.5" y="220.0278">and apiProvFuncIds</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="138" x="423.5" y="235.1606">for provided functions</text><polygon fill="#181818" points="291.5,293.4922,281.5,297.4922,291.5,301.4922,287.5,297.4922" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="285.5" x2="411.5" y1="297.4922" y2="297.4922"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="81" x="297.5" y="277.2935">Provider with</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="101" x="301.5" y="292.4263">apfId and aefIds</text><polygon fill="#181818" points="81.5,337.7578,71.5,341.7578,81.5,345.7578,77.5,341.7578" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="75.5" x2="279.5" y1="341.7578" y2="341.7578"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="81" x="87.5" y="321.5591">Provider with</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="101" x="91.5" y="336.6919">apfId and aefIds</text><!--MD5=[e9ca64ac74341f2ea791570a7a08eb8d]
+@startuml Register API Provider Domain\r
+actor ProviderClient\r
+box "CAPIF Internal"\r
+participant capifcore\r
+participant providermanager\r
+participant publishservice\r
+\r
+end box\r
+\r
+alt#paleGreen #paleGreen Provider Enrolment\r
+    ProviderClient->capifcore: Register provider with\n APIProviderEnrolmentDetails\r
+    capifcore->providermanager:Register provider\r
+    providermanager->providermanager: Create apiProvDomId\n and apiProvFuncIds\n for provided functions\r
+    providermanager->capifcore: Provider with\n apfId and aefIds\r
+    capifcore->ProviderClient: Provider with\n apfId and aefIds\r
+end\r
+\r
+@enduml\r
+
+PlantUML version 1.2022.7(Mon Aug 22 19:01:30 CEST 2022)
+(GPL source distribution)
+Java Runtime: OpenJDK Runtime Environment
+JVM: OpenJDK 64-Bit Server VM
+Default Encoding: UTF-8
+Language: en
+Country: null
+--></g></svg>
\ No newline at end of file