openapi: 3.0.0 info: description: "API for API invoker management. \n© 2025, 3GPP Organizational Partners\ \ (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). \nAll rights reserved.\n" title: CAPIF_API_Invoker_Management_API version: 1.4.0-alpha.5 externalDocs: description: 3GPP TS 29.222 V19.4.0 Common API Framework for 3GPP Northbound APIs url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ servers: - url: "{apiRoot}/api-invoker-management/v1" variables: apiRoot: default: https://example.com description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 paths: /onboardedInvokers: post: callbacks: notificationDestination: '{$request.body#/notificationDestination}': post: operationId: notification_destination_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OnboardingNotification' required: true responses: "204": description: | No Content. The onboarding notification is successfully received. "307": description: Temporary Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "308": description: Permanent Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "400": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad request "401": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized "403": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden "404": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found "411": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Length Required "413": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Content Too Large "415": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unsupported Media Type "429": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests "500": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error "503": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable default: description: Generic Error x-callback-request: true operationId: create_onboarded_api_invoker requestBody: content: application/json: schema: $ref: '#/components/schemas/APIInvokerEnrolmentDetails' required: true responses: "201": content: application/json: schema: $ref: '#/components/schemas/APIInvokerEnrolmentDetails' description: | Created. The API Invoker is successfully on-boarded. headers: Location: description: | Contains the URI of the newly created resource. explode: false required: true schema: type: string style: simple "202": description: | Accepted. The CCF accepted the Onboarding request and is processing it. "400": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad request "401": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized "403": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden "404": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found "411": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Length Required "413": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Content Too Large "415": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unsupported Media Type "429": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests "500": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error "503": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable default: description: Generic Error summary: Request the Creation of a new On-boarded API Invoker. tags: - On-boarded API Invokers (Collection) x-openapi-router-controller: api_invoker_management.controllers.on_boarded_api_invokers_collection_controller /onboardedInvokers/{onboardingId}: delete: description: Deletes an existing Individual On-boarded API Invoker. operationId: delete_ind_onboarded_api_invoker parameters: - explode: false in: path name: onboardingId required: true schema: type: string style: simple responses: "204": description: | No Content. The Individual On-boarded API Invoker resource is successfully deleted. "307": description: Temporary Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "308": description: Permanent Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "400": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad request "401": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized "403": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden "404": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found "429": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests "500": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error "503": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable default: description: Generic Error summary: Delete an existing Individual On-boarded API Invoker resource. tags: - Individual On-boarded API Invoker (Document) x-openapi-router-controller: api_invoker_management.controllers.individual_on_boarded_api_invoker_document_controller patch: operationId: modify_ind_api_invoke_enrolment parameters: - explode: false in: path name: onboardingId required: true schema: type: string style: simple requestBody: content: application/merge-patch+json: schema: $ref: '#/components/schemas/APIInvokerEnrolmentDetailsPatch' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/APIInvokerEnrolmentDetails' description: | OK. The Individual On-boarded API Invoker resource is successfully modified and the representation of the updated resource is returned in the response body. "202": description: | Accepted. The request is accepted and under processing. "204": description: | No Content. The Individual On-boarded API Invoker resource is successfully modified and no content is returned in the response body. "307": description: Temporary Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "308": description: Permanent Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "400": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad request "401": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized "403": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden "404": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found "411": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Length Required "413": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Content Too Large "415": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unsupported Media Type "429": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests "500": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error "503": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable default: description: Generic Error tags: - Individual On-boarded API Invoker (Document) x-openapi-router-controller: api_invoker_management.controllers.individual_on_boarded_api_invoker_document_controller put: operationId: update_ind_onboarded_api_invoker parameters: - explode: false in: path name: onboardingId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/APIInvokerEnrolmentDetails' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/APIInvokerEnrolmentDetails' description: | OK. The Individual On-boarded API Invoker resource is successfully updated and the representation of the updated resource is returned in the response body. "202": description: | Accepted. The request is accepted and under processing. "204": description: | No Content. The Individual On-boarded API Invoker resource is successfully updated and no content is returned in the response body. "307": description: Temporary Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "308": description: Permanent Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "400": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad request "401": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized "403": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden "404": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found "411": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Length Required "413": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Content Too Large "415": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unsupported Media Type "429": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests "500": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error "503": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable default: description: Generic Error summary: Update an existing Individual On-boarded API Invoker resource. tags: - Individual On-boarded API Invoker (Document) x-openapi-router-controller: api_invoker_management.controllers.individual_on_boarded_api_invoker_document_controller components: responses: "400": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad request "401": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized "403": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden "404": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found "411": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Length Required "413": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Content Too Large "415": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unsupported Media Type "429": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests "500": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error "503": content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable default: description: Generic Error "307": description: Temporary Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string "308": description: Permanent Redirect headers: Location: description: An alternative URI of the resource. required: true schema: type: string schemas: OnboardingInformation: description: Represents the on-boarding information of the API Invoker. example: apiInvokerPublicKey: apiInvokerPublicKey onboardingSecret: onboardingSecret onboardingCriteria: - relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK - relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK apiInvokerCertificate: apiInvokerCertificate properties: apiInvokerPublicKey: description: The API Invoker's public key title: apiInvokerPublicKey type: string apiInvokerCertificate: description: | The API Invoker's generic client certificate, provided by the CAPIF core function. title: apiInvokerCertificate type: string onboardingSecret: description: | The API Invoker's onboarding secret, provided by the CAPIF core function. title: onboardingSecret type: string onboardingCriteria: items: $ref: '#/components/schemas/OnboardingCriteria' minItems: 1 title: onboardingCriteria type: array required: - apiInvokerPublicKey title: OnboardingInformation type: object APIList: description: Represents a list of APIs with the corresponding information. example: serviceAPIDescriptions: - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds properties: serviceAPIDescriptions: description: | Represents the list of service APIs that the API Invoker is allowed to invoke. items: $ref: '#/components/schemas/ServiceAPIDescription' minItems: 1 title: serviceAPIDescriptions type: array title: APIList type: object APIInvokerEnrolmentDetails: description: Represents the onboarding information of the API Invoker. example: notificationDestination: notificationDestination supportedFeatures: supportedFeatures apiInvokerId: apiInvokerId expTime: 2000-01-23T04:56:07.000+00:00 apiInvokerInformation: apiInvokerInformation failureReasons: - apiName: - apiName - apiName failureCode: AUTHORIZATION_ISSUE - apiName: - apiName - apiName failureCode: AUTHORIZATION_ISSUE websockNotifConfig: requestWebsocketUri: true websocketUri: websocketUri onboardingInformation: apiInvokerPublicKey: apiInvokerPublicKey onboardingSecret: onboardingSecret onboardingCriteria: - relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK - relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK apiInvokerCertificate: apiInvokerCertificate requestTestNotification: true apiList: serviceAPIDescriptions: - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds properties: apiInvokerId: description: | API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. readOnly: true title: apiInvokerId type: string onboardingInformation: $ref: '#/components/schemas/OnboardingInformation' notificationDestination: description: string providing an URI formatted according to IETF RFC 3986. title: notificationDestination type: string requestTestNotification: description: | Set to true to request the CCF to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise. title: requestTestNotification type: boolean websockNotifConfig: $ref: '#/components/schemas/WebsockNotifConfig' apiList: $ref: '#/components/schemas/APIList' apiInvokerInformation: description: | Generic information related to the API invoker such as details of the device or the application. title: apiInvokerInformation type: string expTime: description: string with format "date-time" as defined in OpenAPI. format: date-time title: DateTime type: string supportedFeatures: description: | A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. pattern: "^[A-Fa-f0-9]*$" title: SupportedFeatures type: string failureReasons: items: $ref: '#/components/schemas/EnrolFailReason' minItems: 1 title: failureReasons type: array required: - notificationDestination - onboardingInformation title: APIInvokerEnrolmentDetails type: object OnboardingNotification: description: Represents a notification of on-boarding creation or update result. example: result: true apiInvokerEnrolmentDetails: notificationDestination: notificationDestination supportedFeatures: supportedFeatures apiInvokerId: apiInvokerId expTime: 2000-01-23T04:56:07.000+00:00 apiInvokerInformation: apiInvokerInformation failureReasons: - apiName: - apiName - apiName failureCode: AUTHORIZATION_ISSUE - apiName: - apiName - apiName failureCode: AUTHORIZATION_ISSUE websockNotifConfig: requestWebsocketUri: true websocketUri: websocketUri onboardingInformation: apiInvokerPublicKey: apiInvokerPublicKey onboardingSecret: onboardingSecret onboardingCriteria: - relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK - relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK apiInvokerCertificate: apiInvokerCertificate requestTestNotification: true apiList: serviceAPIDescriptions: - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds resourceLocation: resourceLocation apiList: serviceAPIDescriptions: - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds - serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds properties: result: description: Set to "true" to indicate successful on-boarding. Otherwise set to "false". title: result type: boolean resourceLocation: description: string providing an URI formatted according to IETF RFC 3986. title: notificationDestination type: string apiInvokerEnrolmentDetails: $ref: '#/components/schemas/APIInvokerEnrolmentDetails' apiList: $ref: '#/components/schemas/APIList' required: - result title: OnboardingNotification type: object APIInvokerEnrolmentDetailsPatch: description: Represents an API Invoker's enrolment details to be updated. properties: onboardingInformation: $ref: '#/components/schemas/OnboardingInformation' notificationDestination: description: string providing an URI formatted according to IETF RFC 3986. title: notificationDestination type: string apiList: $ref: '#/components/schemas/APIList' apiInvokerInformation: description: | Generic information related to the API invoker such as details of the device or the application. title: apiInvokerInformation type: string expTime: description: | string with format "date-time" as defined in OpenAPI with "nullable=true" property. format: date-time nullable: true title: expTime type: string title: APIInvokerEnrolmentDetailsPatch type: object OnboardingCriteria: description: Represents the onboarding criteria information. example: relatedCriteria: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories secMethods: - PSK - PSK properties: secMethods: items: $ref: '#/components/schemas/SecurityMethod' minItems: 1 title: secMethods type: array relatedCriteria: $ref: '#/components/schemas/RelatedCriteria' required: - secMethods title: OnboardingCriteria type: object RelatedCriteria: anyOf: - required: [aefIds] - required: [apis] - required: [serviceAPICategories] not: required: [apis, serviceAPICategories] description: Represents onboarding related criteria. example: aefIds: - aefIds - aefIds apis: - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions - apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions serviceAPICategories: - serviceAPICategories - serviceAPICategories nullable: true properties: aefIds: items: type: string minItems: 1 title: aefIds type: array apis: items: $ref: '#/components/schemas/ApiInfo' minItems: 1 title: apis type: array serviceAPICategories: items: type: string minItems: 1 title: serviceAPICategories type: array title: RelatedCriteria type: object ApiInfo: description: Represents service API identification related information. example: apiName: apiName supportedApiVersions: - supportedApiVersions - supportedApiVersions properties: apiName: title: apiName type: string supportedApiVersions: items: type: string minItems: 1 title: supportedApiVersions type: array required: - apiName title: ApiInfo type: object EnrolFailReason: description: Represents the failure reason for not those APIs not enrolled successfully. example: apiName: - apiName - apiName failureCode: AUTHORIZATION_ISSUE properties: apiName: items: type: string title: apiName type: array failureCode: $ref: '#/components/schemas/EnrolFailCause' required: - apiName - failureCode title: EnrolFailReason type: object EnrolFailCause: enum: - AUTHORIZATION_ISSUE - ONBOARDING_CRI_NOT_MET - UNSPECIFIED type: string description: "Represents API Invoker's per API enrollment failure code. \n\ Possible values are:\n- AUTHORIZATION_ISSUE: Indicates that the service API\ \ enrollment failed because the service\n API is not authorized for the API\ \ Invoker.\n- ONBOARDING_CRI_NOT_MET: Indicates that the service API entollment\ \ failed because the\n onboarding criteria not met for this service API for\ \ the API Invoker.\n- UNSPECIFIED: Indicates that the service API enrollment\ \ failed due to an unspecified\n reason.\n" title: EnrolFailCause OnboardingFailReason: enum: - API_INVOKER_NOT_ALLOWED - ONBOARDING_CRI_NOT_MET - OTHER type: string description: "Represents the API Invoker onboarding failure reason. \nPossible\ \ values are:\n- API_INVOKER_NOT_ALLOWED: Indicates that the onboarding of\ \ the API Invoker failed because\n the API Invoker is not allowed.\n- ONBOARDING_CRI_NOT_MET:\ \ Indicates that the onboarding of the API Invoker failed because\n the onboarding\ \ criteria is not met.\n- OTHER: Indicates that the onboarding of the API\ \ Invoker failed because of other reasons.\n" ProblemDetails: description: Represents additional information and details on an error response. properties: type: description: string providing an URI formatted according to IETF RFC 3986. title: notificationDestination type: string title: description: "A short, human-readable summary of the problem type. It should\ \ not change from occurrence to occurrence of the problem. \n" title: title type: string status: description: The HTTP status code for this occurrence of the problem. title: status type: integer detail: description: A human-readable explanation specific to this occurrence of the problem. title: detail type: string instance: description: string providing an URI formatted according to IETF RFC 3986. title: notificationDestination type: string cause: description: | A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available. title: cause type: string invalidParams: description: | Description of invalid parameters, for a request rejected due to invalid parameters. items: $ref: '#/components/schemas/InvalidParam' minItems: 1 title: invalidParams type: array supportedFeatures: description: | A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. pattern: "^[A-Fa-f0-9]*$" title: SupportedFeatures type: string title: ProblemDetails type: object Uri: description: string providing an URI formatted according to IETF RFC 3986. title: notificationDestination type: string InvalidParam: description: | Represents the description of invalid parameters, for a request rejected due to invalid parameters. properties: param: description: "Attribute's name encoded as a JSON Pointer, or header's name." title: param type: string reason: description: "A human-readable reason, e.g. \"must be a positive integer\"\ ." title: reason type: string required: - param title: InvalidParam type: object ServiceAPIDescription: description: Represents the description of a service API as published by the APF. example: serviceAPICategory: serviceAPICategory ccfId: ccfId apiName: apiName apiProvName: apiProvName supportedFeatures: supportedFeatures description: description aefProfiles: - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp - protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp shareableInfo: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true netSliceInfo: - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId - ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId apiSuppFeats: apiSuppFeats apiId: apiId apiStatus: aefIds: - aefIds - aefIds pubApiPath: ccfIds: - ccfIds - ccfIds properties: apiName: description: | Contains the API name set to the value of the "" placeholder of the API URI as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. title: apiName type: string apiId: description: | 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). title: apiId type: string apiStatus: $ref: '#/components/schemas/ApiStatus' aefProfiles: description: | AEF profile information, which includes the exposed API details (e.g. protocol). items: $ref: '#/components/schemas/AefProfile' minItems: 1 title: aefProfiles type: array description: description: Text description of the API title: description type: string supportedFeatures: description: | A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. pattern: "^[A-Fa-f0-9]*$" title: SupportedFeatures type: string shareableInfo: $ref: '#/components/schemas/ShareableInformation' serviceAPICategory: description: The service API category to which the service API belongs to. title: serviceAPICategory type: string apiSuppFeats: description: | A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. pattern: "^[A-Fa-f0-9]*$" title: SupportedFeatures type: string pubApiPath: $ref: '#/components/schemas/PublishedApiPath' ccfId: description: CAPIF core function identifier. title: ccfId type: string apiProvName: description: Represents the API provider name. title: apiProvName type: string netSliceInfo: description: Represents the applicable network slice identifiers. items: $ref: '#/components/schemas/NetSliceId' minItems: 1 title: netSliceInfo type: array required: - apiName title: ServiceAPIDescription type: object ApiStatus: description: | Represents the API status. example: aefIds: - aefIds - aefIds properties: aefIds: description: "Indicates the list of AEF ID(s) where the API is active. If\ \ an empty array is provided, it indicates that the API is inactive in\ \ all AEF(s). \n" items: type: string title: aefIds type: array required: - aefIds title: ApiStatus type: object AefProfile: description: Represents the AEF profile data. example: protocol: HTTP_1_1 grantTypes: - CLIENT_CREDENTIALS - CLIENT_CREDENTIALS ueIpRange: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 securityMethods: - null - null versions: - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 - apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 dataFormat: JSON domainName: domainName aefLocation: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR aefId: aefId interfaceDescriptions: - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr - ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr serviceKpis: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp nullable: true oneOf: - required: ["domainName"] - required: ["interfaceDescriptions"] - {} properties: aefId: description: Identifier of the API exposing function title: aefId type: string versions: description: API version items: $ref: '#/components/schemas/Version' minItems: 1 title: versions type: array protocol: $ref: '#/components/schemas/Protocol' dataFormat: $ref: '#/components/schemas/DataFormat' securityMethods: description: Security methods supported by the AEF items: $ref: '#/components/schemas/SecurityMethod' minItems: 1 title: securityMethods type: array grantTypes: items: $ref: '#/components/schemas/OAuthGrantType' minItems: 1 title: grantTypes type: array domainName: description: Domain to which API belongs to title: domainName type: string interfaceDescriptions: description: Interface details items: $ref: '#/components/schemas/InterfaceDescription' minItems: 1 title: interfaceDescriptions type: array aefLocation: $ref: '#/components/schemas/AefLocation' serviceKpis: $ref: '#/components/schemas/ServiceKpis' ueIpRange: $ref: '#/components/schemas/IpAddrRange' required: - aefId - versions title: AefProfile type: object Version: description: Represents the API version information. example: apiVersion: apiVersion resources: - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri - operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName expiry: 2000-01-23T04:56:07.000+00:00 properties: apiVersion: description: API major version in URI (e.g. v1) title: apiVersion type: string expiry: description: string with format "date-time" as defined in OpenAPI. format: date-time title: DateTime type: string resources: description: Resources supported by the API. items: $ref: '#/components/schemas/Resource' minItems: 1 title: resources type: array custOperations: description: Custom operations without resource association. items: $ref: '#/components/schemas/CustomOperation' minItems: 1 title: custOperations type: array required: - apiVersion title: Version type: object Resource: description: Represents the API resource data. example: operations: - null - null commType: REQUEST_RESPONSE custOperations: - operations: - GET - GET commType: null description: description custOpName: custOpName - operations: - GET - GET commType: null description: description custOpName: custOpName description: description resourceName: resourceName custOpName: custOpName uri: uri properties: resourceName: description: Resource name title: resourceName type: string commType: $ref: '#/components/schemas/CommunicationType' uri: description: | Relative URI of the API resource, it is set as {apiSpecificSuffixes} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122. title: uri type: string custOpName: description: | it is set as {custOpName} part of the URI structure for a custom operation associated with a resource as defined in clause 5.2.4 of 3GPP TS 29.122. title: custOpName type: string custOperations: description: | Custom operations associated with this resource. items: $ref: '#/components/schemas/CustomOperation' minItems: 1 title: custOperations type: array operations: description: | Supported HTTP methods for the API resource. Only applicable when the protocol in AefProfile indicates HTTP. items: $ref: '#/components/schemas/Operation' minItems: 1 title: operations type: array description: description: Text description of the API resource title: description type: string required: - commType - resourceName - uri title: Resource type: object CommunicationType: enum: - REQUEST_RESPONSE - SUBSCRIBE_NOTIFY type: string description: "Indicates a communication type of the resource or the custom operation.\ \ \nPossible values are:\n- REQUEST_RESPONSE: The communication is of the\ \ type request-response.\n- SUBSCRIBE_NOTIFY: The communication is of the\ \ type subscribe-notify.\n" title: CommunicationType CustomOperation: description: Represents the description of a custom operation. example: operations: - GET - GET commType: null description: description custOpName: custOpName properties: commType: $ref: '#/components/schemas/CommunicationType' custOpName: description: | it is set as {custOpName} part of the URI structure for a custom operation without resource association as defined in clause 5.2.4 of 3GPP TS 29.122. title: custOpName type: string operations: description: | Supported HTTP methods for the API resource. Only applicable when the protocol in AefProfile indicates HTTP. items: $ref: '#/components/schemas/Operation' minItems: 1 title: operations type: array description: description: Text description of the custom operation title: description type: string required: - commType - custOpName title: CustomOperation type: object Operation: enum: - GET - POST - PUT - PATCH - DELETE type: string description: "Indicates an HTTP method. \nPossible values are:\n- GET: HTTP\ \ GET method.\n- POST: HTTP POST method.\n- PUT: HTTP PUT method.\n- PATCH:\ \ HTTP PATCH method.\n- DELETE: HTTP DELETE method.\n" title: Operation Protocol: enum: - HTTP_1_1 - HTTP_2 - MQTT - WEBSOCKET type: string description: "Indicates a protocol and protocol version used by the API. \n\ Possible values are:\n- HTTP_1_1: Indicates that the protocol is HTTP version\ \ 1.1.\n- HTTP_2: Indicates that the protocol is HTTP version 2.\n- MQTT:\ \ Indicates that the protocol is Message Queuing Telemetry Transport.\n- WEBSOCKET:\ \ Indicates that the protocol is Websocket.\n" title: Protocol DataFormat: enum: - JSON - XML - PROTOBUF3 type: string description: "Indicates a data format. \nPossible values are:\n- JSON: Indicates\ \ that the data format is JSON.\n- XML: Indicates that the data format is\ \ Extensible Markup Language.\n- PROTOBUF3: Indicates that the data format\ \ is Protocol buffers version 3.\n" title: DataFormat SecurityMethod: enum: - PSK - PKI - OAUTH type: string description: "Indicates the security method. \nPossible values are:\n- PSK:\ \ Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122.\n- PKI:\ \ Security method 2 (Using PKI) as described in 3GPP TS 33.122.\n- OAUTH:\ \ Security method 3 (TLS with OAuth token) as described in 3GPP TS 33.122.\n" title: SecurityMethod InterfaceDescription: description: Represents the description of an API's interface. example: ipv6Addr: ipv6Addr grantTypes: - null - null securityMethods: - null - null fqdn: fqdn port: 5248 apiPrefix: apiPrefix ipv4Addr: ipv4Addr nullable: true oneOf: - required: ["fqdn"] - required: ["ipv4Addr"] - required: ["ipv6Addr"] properties: ipv4Addr: description: | string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166. title: Ipv4Addr type: string ipv6Addr: description: | string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used. title: Ipv6Addr type: string fqdn: description: Fully Qualified Domain Name maxLength: 253 minLength: 4 pattern: "^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\\.)+[A-Za-z]{2,63}\\\ .?$" title: Fqdn type: string port: description: Unsigned integer with valid values between 0 and 65535. maximum: 65535 minimum: 0 title: Port type: integer apiPrefix: description: | A string representing a sequence of path segments that starts with the slash character. title: apiPrefix type: string securityMethods: description: | Security methods supported by the interface, it take precedence over the security methods provided in AefProfile, for this specific interface. items: $ref: '#/components/schemas/SecurityMethod' minItems: 1 title: securityMethods type: array grantTypes: items: $ref: '#/components/schemas/OAuthGrantType' minItems: 1 title: grantTypes type: array title: InterfaceDescription type: object AefLocation: description: | Represents the location information (e.g. civic address, GPS coordinates, data center ID) where the AEF providing the service API is located. example: dcId: dcId geoArea: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 civicAddr: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR properties: civicAddr: $ref: '#/components/schemas/CivicAddress' geoArea: $ref: '#/components/schemas/GeographicArea' dcId: description: | Identifies the data center where the AEF providing the service API is located. title: dcId type: string title: AefLocation type: object ServiceKpis: description: | Represents information about the service characteristics provided by a service API. example: avalMem: avalMem avalStor: avalStor avalComp: avalComp conBand: 0 maxRestime: 0 availability: 0 maxReqRate: 0 avalGraComp: avalGraComp properties: maxReqRate: description: "Unsigned Integer, i.e. only value 0 and integers above 0 are\ \ permissible." minimum: 0 title: Uinteger type: integer maxRestime: description: Unsigned integer identifying a period of time in units of seconds. minimum: 0 title: DurationSec type: integer availability: description: "Unsigned Integer, i.e. only value 0 and integers above 0 are\ \ permissible." minimum: 0 title: Uinteger type: integer avalComp: description: | The maximum compute resource available in FLOPS for the API Invoker. pattern: ^\d+(\.\d+)? (kFLOPS|MFLOPS|GFLOPS|TFLOPS|PFLOPS|EFLOPS|ZFLOPS)$ title: avalComp type: string avalGraComp: description: | The maximum graphical compute resource in FLOPS available for the API Invoker. pattern: ^\d+(\.\d+)? (kFLOPS|MFLOPS|GFLOPS|TFLOPS|PFLOPS|EFLOPS|ZFLOPS)$ title: avalGraComp type: string avalMem: description: | The maximum memory resource available for the API Invoker. pattern: ^\d+(\.\d+)? (KB|MB|GB|TB|PB|EB|ZB|YB)$ title: avalMem type: string avalStor: description: | The maximum storage resource available for the API Invoker. pattern: ^\d+(\.\d+)? (KB|MB|GB|TB|PB|EB|ZB|YB)$ title: avalStor type: string conBand: description: "Unsigned Integer, i.e. only value 0 and integers above 0 are\ \ permissible." minimum: 0 title: Uinteger type: integer title: ServiceKpis type: object IpAddrRange: anyOf: - required: ["ueIpv4AddrRanges"] - required: ["ueIpv6AddrRanges"] description: Represents the list of public IP ranges example: ueIpv4AddrRanges: - start: 198.51.100.1 end: 198.51.100.1 - start: 198.51.100.1 end: 198.51.100.1 ueIpv6AddrRanges: - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 - start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 nullable: true properties: ueIpv4AddrRanges: description: Represents the IPv4 Address ranges of the UE(s). items: $ref: '#/components/schemas/Ipv4AddressRange' minItems: 1 title: ueIpv4AddrRanges type: array ueIpv6AddrRanges: description: Represents the Ipv6 Address ranges of the UE(s). items: $ref: '#/components/schemas/Ipv6AddressRange' minItems: 1 title: ueIpv6AddrRanges type: array title: IpAddrRange type: object ShareableInformation: description: | Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains. example: capifProvDoms: - capifProvDoms - capifProvDoms isShareable: true properties: isShareable: description: | Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domain information. true indicates that the service API and/or the service API category can be shared to the list of CAPIF provider domain information. false indicates that the service API and/or the service API category can not be shared to the list of CAPIF provider domain information. title: isShareable type: boolean capifProvDoms: description: | List of CAPIF provider domains to which the service API information to be shared. items: type: string minItems: 1 title: capifProvDoms type: array required: - isShareable title: ShareableInformation type: object PublishedApiPath: description: Represents the published API path within the same CAPIF provider domain. example: ccfIds: - ccfIds - ccfIds properties: ccfIds: description: A list of CCF identifiers where the service API is already published. items: type: string minItems: 1 title: ccfIds type: array title: PublishedApiPath type: object WebsockNotifConfig: description: | Represents the configuration information for the delivery of notifications over Websockets. example: requestWebsocketUri: true websocketUri: websocketUri properties: websocketUri: description: string formatted according to IETF RFC 3986 identifying a referenced resource. title: Link type: string requestWebsocketUri: description: Set by the SCS/AS to indicate that the Websocket delivery is requested. title: requestWebsocketUri type: boolean title: WebsockNotifConfig type: object Link: description: string formatted according to IETF RFC 3986 identifying a referenced resource. title: Link type: string DateTime: description: string with format "date-time" as defined in OpenAPI. format: date-time title: DateTime type: string SupportedFeatures: description: | A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. pattern: "^[A-Fa-f0-9]*$" title: SupportedFeatures type: string DateTimeRm: description: | string with format "date-time" as defined in OpenAPI with "nullable=true" property. format: date-time nullable: true title: expTime type: string NetSliceId: description: | Represents the network slice identification information. example: ensi: ensi snssai: sd: sd sst: 237 nsiId: nsiId nullable: true oneOf: - required: ["snssai"] - required: ["nsiId"] - required: ["ensi"] properties: snssai: $ref: '#/components/schemas/Snssai' nsiId: description: Contains the Identifier of the selected Network Slice instance title: NsiId type: string ensi: description: | Represents the External Network Slice Information that is used to identify a network slice, as specified in 3GPP TS 33.501. title: Ensi type: string title: NetSliceId type: object Ensi: description: | Represents the External Network Slice Information that is used to identify a network slice, as specified in 3GPP TS 33.501. title: Ensi type: string OAuthGrantType: enum: - CLIENT_CREDENTIALS - AUTHORIZATION_CODE - AUTHORIZATION_CODE_WITH_PKCE type: string description: "Indicates the supported authorization flow (e.g. client credentials\ \ flow, authorization code flow, etc.) to the API invoker. \nPossible\ \ values are:\n- CLIENT_CREDENTIALS: Indicate that the grant type is is client\ \ credentials flow.\n- AUTHORIZATION_CODE: Indicate that the grant type is\ \ authorization code.\n- AUTHORIZATION_CODE_WITH_PKCE: Indicate that the grant\ \ type is authorization code with PKCE.\n" title: OAuthGrantType Ipv4Addr: description: | string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166. title: Ipv4Addr type: string Ipv6Addr: description: | string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used. title: Ipv6Addr type: string Fqdn: description: Fully Qualified Domain Name maxLength: 253 minLength: 4 pattern: "^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\\.)+[A-Za-z]{2,63}\\\ .?$" title: Fqdn type: string Port: description: Unsigned integer with valid values between 0 and 65535. maximum: 65535 minimum: 0 title: Port type: integer CivicAddress: description: Indicates a Civic address. example: POBOX: POBOX usageRules: usageRules country: country PRD: PRD PLC: PLC HNO: HNO PRM: PRM HNS: HNS FLR: FLR A1: A1 A2: A2 A3: A3 A4: A4 STS: STS A5: A5 A6: A6 RDSEC: RDSEC providedBy: providedBy LOC: LOC UNIT: UNIT SEAT: SEAT POD: POD RDBR: RDBR method: method LMK: LMK POM: POM ADDCODE: ADDCODE RD: RD PC: PC PCN: PCN NAM: NAM BLD: BLD ROOM: ROOM RDSUBBR: RDSUBBR properties: country: title: country type: string A1: title: A1 type: string A2: title: A2 type: string A3: title: A3 type: string A4: title: A4 type: string A5: title: A5 type: string A6: title: A6 type: string PRD: title: PRD type: string POD: title: POD type: string STS: title: STS type: string HNO: title: HNO type: string HNS: title: HNS type: string LMK: title: LMK type: string LOC: title: LOC type: string NAM: title: NAM type: string PC: title: PC type: string BLD: title: BLD type: string UNIT: title: UNIT type: string FLR: title: FLR type: string ROOM: title: ROOM type: string PLC: title: PLC type: string PCN: title: PCN type: string POBOX: title: POBOX type: string ADDCODE: title: ADDCODE type: string SEAT: title: SEAT type: string RD: title: RD type: string RDSEC: title: RDSEC type: string RDBR: title: RDBR type: string RDSUBBR: title: RDSUBBR type: string PRM: title: PRM type: string POM: title: POM type: string usageRules: title: usageRules type: string method: title: method type: string providedBy: title: providedBy type: string title: CivicAddress type: object GeographicArea: anyOf: - required: ["Point"] - required: ["PointUncertaintyCircle"] - required: ["PointUncertaintyEllipse"] - required: ["Polygon"] - required: ["PointAltitude"] - required: ["PointAltitudeUncertainty"] - required: ["EllipsoidArc"] description: Geographic area specified by different shape. title: GeographicArea Point: allOf: - $ref: '#/components/schemas/GADShape' - properties: point: $ref: '#/components/schemas/GeographicalCoordinates' required: - point type: object description: Ellipsoid Point. example: shape: POINT point: lon: 36.988422590534526 lat: -63.615366350946985 title: Point GADShape: description: Common base type for GAD shapes. discriminator: mapping: POINT: '#/components/schemas/Point' POINT_UNCERTAINTY_CIRCLE: '#/components/schemas/PointUncertaintyCircle' POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/PointUncertaintyEllipse' POLYGON: '#/components/schemas/Polygon' POINT_ALTITUDE: '#/components/schemas/PointAltitude' POINT_ALTITUDE_UNCERTAINTY: '#/components/schemas/PointAltitudeUncertainty' ELLIPSOID_ARC: '#/components/schemas/EllipsoidArc' LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/Local2dPointUncertaintyEllipse' LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID: '#/components/schemas/Local3dPointUncertaintyEllipsoid' propertyName: shape properties: shape: $ref: '#/components/schemas/SupportedGADShapes' required: - shape title: GADShape type: object SupportedGADShapes: enum: - POINT - POINT_UNCERTAINTY_CIRCLE - POINT_UNCERTAINTY_ELLIPSE - POLYGON - POINT_ALTITUDE - POINT_ALTITUDE_UNCERTAINTY - ELLIPSOID_ARC - LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE - LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID - DISTANCE_DIRECTION - RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE - RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID type: string description: Indicates supported GAD shapes. title: SupportedGADShapes PointUncertaintyCircle: allOf: - $ref: '#/components/schemas/GADShape' - properties: point: $ref: '#/components/schemas/GeographicalCoordinates' uncertainty: $ref: '#/components/schemas/Uncertainty' required: - point - uncertainty type: object description: Ellipsoid point with uncertainty circle. title: PointUncertaintyCircle GeographicalCoordinates: description: Geographical coordinates. example: lon: 36.988422590534526 lat: -63.615366350946985 properties: lon: format: double maximum: 180 minimum: -180 title: lon type: number lat: format: double maximum: 90 minimum: -90 title: lat type: number required: - lat - lon title: GeographicalCoordinates type: object Uncertainty: description: Indicates value of uncertainty. format: float minimum: 0 title: Uncertainty type: number PointUncertaintyEllipse: allOf: - $ref: '#/components/schemas/GADShape' - properties: point: $ref: '#/components/schemas/GeographicalCoordinates' uncertaintyEllipse: $ref: '#/components/schemas/UncertaintyEllipse' confidence: $ref: '#/components/schemas/Confidence' required: - confidence - point - uncertaintyEllipse type: object description: Ellipsoid point with uncertainty ellipse. title: PointUncertaintyEllipse UncertaintyEllipse: description: Ellipse with uncertainty. properties: semiMajor: description: Indicates value of uncertainty. format: float minimum: 0 title: Uncertainty type: number semiMinor: description: Indicates value of uncertainty. format: float minimum: 0 title: Uncertainty type: number orientationMajor: description: Indicates value of orientation angle. maximum: 180 minimum: 0 title: Orientation type: integer required: - orientationMajor - semiMajor - semiMinor title: UncertaintyEllipse type: object Orientation: description: Indicates value of orientation angle. maximum: 180 minimum: 0 title: Orientation type: integer Confidence: description: Indicates value of confidence. maximum: 100 minimum: 0 type: integer Polygon: allOf: - $ref: '#/components/schemas/GADShape' - properties: pointList: $ref: '#/components/schemas/PointList' required: - pointList type: object description: Polygon. title: Polygon PointList: description: List of points. items: $ref: '#/components/schemas/GeographicalCoordinates' maxItems: 15 minItems: 3 type: array PointAltitude: allOf: - $ref: '#/components/schemas/GADShape' - properties: point: $ref: '#/components/schemas/GeographicalCoordinates' altitude: $ref: '#/components/schemas/Altitude' required: - altitude - point type: object description: Ellipsoid point with altitude. title: PointAltitude Altitude: description: Indicates value of altitude. format: double maximum: 32767 minimum: -32767 type: number PointAltitudeUncertainty: allOf: - $ref: '#/components/schemas/GADShape' - properties: point: $ref: '#/components/schemas/GeographicalCoordinates' altitude: $ref: '#/components/schemas/Altitude' uncertaintyEllipse: $ref: '#/components/schemas/UncertaintyEllipse' uncertaintyAltitude: $ref: '#/components/schemas/Uncertainty' confidence: $ref: '#/components/schemas/Confidence' vConfidence: $ref: '#/components/schemas/Confidence' required: - altitude - confidence - point - uncertaintyAltitude - uncertaintyEllipse type: object description: Ellipsoid point with altitude and uncertainty ellipsoid. title: PointAltitudeUncertainty EllipsoidArc: allOf: - $ref: '#/components/schemas/GADShape' - properties: point: $ref: '#/components/schemas/GeographicalCoordinates' innerRadius: $ref: '#/components/schemas/InnerRadius' uncertaintyRadius: $ref: '#/components/schemas/Uncertainty' offsetAngle: $ref: '#/components/schemas/Angle' includedAngle: $ref: '#/components/schemas/Angle' confidence: $ref: '#/components/schemas/Confidence' required: - confidence - includedAngle - innerRadius - offsetAngle - point - uncertaintyRadius type: object description: Ellipsoid Arc. title: EllipsoidArc InnerRadius: description: Indicates value of the inner radius. format: int32 maximum: 327675 minimum: 0 type: integer Angle: description: Indicates value of angle. maximum: 360 minimum: 0 type: integer Local2dPointUncertaintyEllipse: allOf: - $ref: '#/components/schemas/GADShape' - properties: localOrigin: $ref: '#/components/schemas/LocalOrigin' point: $ref: '#/components/schemas/RelativeCartesianLocation' uncertaintyEllipse: $ref: '#/components/schemas/UncertaintyEllipse' confidence: $ref: '#/components/schemas/Confidence' required: - confidence - localOrigin - point - uncertaintyEllipse type: object description: Local 2D point with uncertainty ellipse LocalOrigin: description: Indicates a Local origin in a reference system properties: coordinateId: title: coordinateId type: string point: $ref: '#/components/schemas/GeographicalCoordinates' area: $ref: '#/components/schemas/GeographicArea' horizAxesOrientation: description: Horizontal axes orientation angle clockwise from northing in 0.1 degrees. maximum: 3600 minimum: 0 title: HorizAxesOrientation type: integer required: - coordinateId title: LocalOrigin type: object HorizAxesOrientation: description: Horizontal axes orientation angle clockwise from northing in 0.1 degrees. maximum: 3600 minimum: 0 title: HorizAxesOrientation type: integer RelativeCartesianLocation: description: Relative Cartesian Location properties: x: description: string with format 'float' as defined in OpenAPI. format: float title: Float type: number "y": description: string with format 'float' as defined in OpenAPI. format: float title: Float type: number z: description: string with format 'float' as defined in OpenAPI. format: float title: Float type: number required: - x - "y" title: RelativeCartesianLocation type: object Local3dPointUncertaintyEllipsoid: allOf: - $ref: '#/components/schemas/GADShape' - properties: localOrigin: $ref: '#/components/schemas/LocalOrigin' point: $ref: '#/components/schemas/RelativeCartesianLocation' uncertaintyEllipsoid: $ref: '#/components/schemas/UncertaintyEllipsoid' confidence: $ref: '#/components/schemas/Confidence' vConfidence: $ref: '#/components/schemas/Confidence' required: - confidence - localOrigin - point - uncertaintyEllipsoid type: object description: Local 3D point with uncertainty ellipsoid UncertaintyEllipsoid: description: Ellipsoid with uncertainty properties: semiMajor: description: Indicates value of uncertainty. format: float minimum: 0 title: Uncertainty type: number semiMinor: description: Indicates value of uncertainty. format: float minimum: 0 title: Uncertainty type: number vertical: description: Indicates value of uncertainty. format: float minimum: 0 title: Uncertainty type: number orientationMajor: description: Indicates value of orientation angle. maximum: 180 minimum: 0 title: Orientation type: integer required: - orientationMajor - semiMajor - semiMinor - vertical title: UncertaintyEllipsoid type: object Uinteger: description: "Unsigned Integer, i.e. only value 0 and integers above 0 are permissible." minimum: 0 title: Uinteger type: integer DurationSec: description: Unsigned integer identifying a period of time in units of seconds. minimum: 0 title: DurationSec type: integer Ipv4AddressRange: description: Range of IPv4 addresses example: start: 198.51.100.1 end: 198.51.100.1 properties: start: description: | String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166. example: 198.51.100.1 pattern: "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" title: Ipv4Addr_1 type: string end: description: | String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166. example: 198.51.100.1 pattern: "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" title: Ipv4Addr_1 type: string required: - end - start title: Ipv4AddressRange type: object Ipv4Addr_1: description: | String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166. example: 198.51.100.1 pattern: "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" title: Ipv4Addr_1 type: string Ipv6AddressRange: description: Range of IPv6 addresses example: start: 2001:db8:85a3::8a2e:370:7334 end: 2001:db8:85a3::8a2e:370:7334 properties: start: $ref: '#/components/schemas/Ipv6Addr_1' end: $ref: '#/components/schemas/Ipv6Addr_1' required: - end - start title: Ipv6AddressRange type: object Ipv6Addr_1: description: | String identifying an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used. example: 2001:db8:85a3::8a2e:370:7334 title: Ipv6Addr_1 type: string Snssai: description: | When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd". example: sd: sd sst: 237 properties: sst: description: "Unsigned integer, within the range 0 to 255, representing\ \ the Slice/Service Type. It indicates the expected Network Slice behaviour\ \ in terms of features and services. Values 0 to 127 correspond to the\ \ standardized SST range. Values 128 to 255 correspond to the Operator-specific\ \ range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are\ \ defined in clause 5.15.2.2 of 3GPP TS 23.501. \n" maximum: 255 minimum: 0 title: sst type: integer sd: description: | 3-octet string, representing the Slice Differentiator, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the SD shall appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE shall be absent if no SD value is associated with the SST. pattern: "^[A-Fa-f0-9]{6}$" title: sd type: string required: - sst title: Snssai type: object NsiId: description: Contains the Identifier of the selected Network Slice instance title: NsiId type: string Float: description: string with format 'float' as defined in OpenAPI. format: float title: Float type: number securitySchemes: oAuth2ClientCredentials: flows: clientCredentials: scopes: {} tokenUrl: "{tokenUrl}" type: oauth2 x-tokenInfoFunc: api_invoker_management.controllers.security_controller.info_from_oAuth2ClientCredentials x-scopeValidateFunc: api_invoker_management.controllers.security_controller.validate_scope_oAuth2ClientCredentials