ServiceAPIDescription

Represents the description of a service API as published by the APF.

JSON Example

{
    "apiName": "string",
    "apiId": "string",
    "aefProfiles": [
        {
            "aefId": "string",
            "versions": [
                {
                    "apiVersion": "string",
                    "expiry": "string",
                    "resources": [
                        {
                            "resourceName": "string",
                            "uri": "string",
                            "custOpName": "string",
                            "operations": [
                                {}
                            ],
                            "description": "string"
                        }
                    ],
                    "custOperations": [
                        {
                            "custOpName": "string",
                            "operations": [
                                {}
                            ],
                            "description": "string"
                        }
                    ]
                }
            ],
            "securityMethods": [
                {}
            ],
            "domainName": "string",
            "interfaceDescriptions": [
                {
                    "ipv4Addr": "string",
                    "ipv6Addr": "string",
                    "fqdn": "string",
                    "port": 0,
                    "apiPrefix": "string",
                    "securityMethods": [
                        {}
                    ]
                }
            ]
        }
    ],
    "description": "string",
    "supportedFeatures": "string",
    "shareableInfo": {
        "isShareable": false,
        "capifProvDoms": [
            "string"
        ]
    },
    "serviceAPICategory": "string",
    "apiSuppFeats": "string",
    "pubApiPath": {
        "ccfIds": [
            "string"
        ]
    },
    "ccfId": "string"
}

string

apiName

Required

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

string

apiId

Optional

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

array of AefProfile

aefProfiles

Optional

AEF profile information, which includes the exposed API details (e.g. protocol).

string

description

Optional

Text description of the API

SupportedFeatures

supportedFeatures

Optional

supportedFeatures