+package "Publish Service" #lightblue {
+ struct ServiceAPIDescription {
+ string apiId
+ string apiName (required)
+ string description
+ []AefProfile aefProfiles
+ }
+ note left of ServiceAPIDescription::apiId
+ Id provided by CAPIF Core
+ end note
+ note "apfId matching\n APIProviderFunctionDetails::apiProvFuncId\n must be provided when publishing" as publishProviderRel
+ ServiceAPIDescription .. publishProviderRel
+ publishProviderRel .. APIProviderFunctionDetails::apiProvFuncId
+ struct AefProfile {
+ string aefId (required)
+ DataFormat dataFormat
+ string domainName
+ []InterfaceDescription interfaceDescriptions
+ Protocol protocol
+ []SecurityMethod securityMethods
+ []Version versions (required)
+ }
+ enum DataFormat {
+ JSON
+ }
+ enum Protocol {
+ HTTP_1_1
+ HTTP_2
+ }
+ note "AefProfile::aefId should match\n APIProviderFunctionDetails::apiProvFuncId" as aefIdRel
+ APIProviderFunctionDetails::apiProvFuncId .. aefIdRel
+ aefIdRel .. AefProfile::aefId
+ struct InterfaceDescription {
+ string ipv4Address
+ string ipv6Address
+ int port
+ []SecurityMethod securityMethods
+ }
+ note left of InterfaceDescription::securityMethods
+ Security methods supported by the interface,
+ it take precedence over the security methods
+ provided in AefProfile, for this specific interface.
+ end note
+ struct Version {
+ []CustomOperation custOperations
+ DateTime expiry
+ []Resource resources
+ string apiVersion (required)
+ }
+ struct CustomOperation {
+ CommunicationType commType (required)
+ string custOpName (required)
+ string description
+ []Operation operations
+ }
+ enum Operation {
+ GET
+ POST
+ PUT
+ PATCH
+ DELETE
+ }
+ enum SecurityMethod {
+ PSK
+ PKI
+ OAUTH
+ }
+ struct Resource {
+ string resourceName (required)
+ string uri (required)
+ CommunicationType commType (required)
+ string description
+ }
+ enum CommunicationType {
+ REQUEST_RESPONSE
+ SUBSCRIBE_NOTIFY
+ }