Skip to content
Show whitespace changes
Inline Side-by-side
TS29553_Npanf_ResolveRemoteUserId.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.1.0' version: '1.2.0-alpha.1'
title: 'Npanf_ResolveRemoteUserId' title: 'Npanf_ResolveRemoteUserId'
description: | description: |
PAnF Resolve Remote User Id Service. PAnF Resolve Remote User Id Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.553 V18.4.0; 5G System; 5G ProSe Anchor Services; Stage 3. description: 3GPP TS 29.553 V19.0.0; 5G System; 5G ProSe Anchor Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/
servers: servers:
......
TS29554_Npcf_BDTPolicyControl.yaml
View file @ 1a359940
...@@ -2,15 +2,15 @@ openapi: 3.0.0 ...@@ -2,15 +2,15 @@ openapi: 3.0.0
info: info:
title: Npcf_BDTPolicyControl Service API title: Npcf_BDTPolicyControl Service API
version: 1.3.0 version: 1.4.0-alpha.1
description: | description: |
PCF BDT Policy Control Service. PCF BDT Policy Control Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.554 V18.3.0; 5G System; Background Data Transfer Policy Control Service. 3GPP TS 29.554 V19.0.0; 5G System; Background Data Transfer Policy Control Service.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.554/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.554/'
servers: servers:
...@@ -299,6 +299,12 @@ components: ...@@ -299,6 +299,12 @@ components:
description: Indicates whether the BDT warning notification is enabled or disabled. description: Indicates whether the BDT warning notification is enabled or disabled.
type: boolean type: boolean
default: false default: false
energyInd:
description: >
Indicates whether the service consumer would like to transfer data
in time windows that consume lower energy.
type: boolean
default: false
BdtPolicyData: BdtPolicyData:
description: Describes the authorization data of an Individual BDT policy resource. description: Describes the authorization data of an Individual BDT policy resource.
......
TS29556_Neasdf_BaselineDNSPattern.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.2.0-alpha.1' version: '1.2.0-alpha.2'
title: 'Neasdf_BaselineDNSPattern' title: 'Neasdf_BaselineDNSPattern'
description: | description: |
EASDF Baseline DNS Pattern Service. EASDF Baseline DNS Pattern Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.556 V19.1.0; 5G System; Edge Application Server Discovery Services; Stage 3 description: 3GPP TS 29.556 V19.2.0; 5G System; Edge Application Server Discovery Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/'
servers: servers:
......
TS29556_Neasdf_DNSContext.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.2.0-alpha.1' version: '1.2.0-alpha.2'
title: 'Neasdf_DNSContext' title: 'Neasdf_DNSContext'
description: | description: |
EASDF DNS Context Service. EASDF DNS Context Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.556 V19.1.0; 5G System; Edge Application Server Discovery Services; Stage3 description: 3GPP TS 29.556 V19.2.0; 5G System; Edge Application Server Discovery Services; Stage3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/
servers: servers:
......
TS29557_Naf_ProSe.yaml
View file @ 1a359940
...@@ -2,15 +2,15 @@ openapi: 3.0.0 ...@@ -2,15 +2,15 @@ openapi: 3.0.0
info: info:
title: Naf_ProSe API title: Naf_ProSe API
version: 1.1.0 version: 1.2.0-alpha.1
description: | description: |
Naf_ProSe Service. Naf_ProSe Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.557 V18.3.0; 5G System; Application Function ProSe Service; Stage 3. 3GPP TS 29.557 V19.1.0; 5G System; Application Function ProSe Service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.557/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.557/
servers: servers:
......
TS29558_Eecs_ECSServiceProvisioning.yaml
View file @ 1a359940
...@@ -2,7 +2,7 @@ openapi: 3.0.0 ...@@ -2,7 +2,7 @@ openapi: 3.0.0
info: info:
title: ECS Service Provisioning Service title: ECS Service Provisioning Service
version: 1.1.0-alpha.3 version: 1.1.0-alpha.4
description: | description: |
ECS Service Provisioning Service. ECS Service Provisioning Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...@@ -10,7 +10,7 @@ info: ...@@ -10,7 +10,7 @@ info:
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.558 V19.2.0; Enabling Edge Applications; 3GPP TS 29.558 V19.3.0; Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3. Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
......
TS29558_Eecs_EESRegistration.yaml
View file @ 1a359940
...@@ -4,13 +4,13 @@ info: ...@@ -4,13 +4,13 @@ info:
title: ECS EES Registration_API title: ECS EES Registration_API
description: | description: |
API for EES Registration. API for EES Registration.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.558 V19.1.0 Enabling Edge Applications; 3GPP TS 29.558 V19.3.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3 Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
...@@ -373,8 +373,7 @@ components: ...@@ -373,8 +373,7 @@ components:
type: boolean type: boolean
description: > description: >
Set to true if the EEC is required to register to the EES to use edge service. Set to true if the EEC is required to register to the EES to use edge service.
Set to false if the EEC is not required to register to use edge services. Default Set to false if the EEC is not required to register to use edge services.
Value is false if omitted.
ueServingSat: ueServingSat:
$ref: '#/components/schemas/UeServSatInfo' $ref: '#/components/schemas/UeServSatInfo'
...@@ -531,11 +530,19 @@ components: ...@@ -531,11 +530,19 @@ components:
dynServAreaInd: dynServAreaInd:
type: boolean type: boolean
description: > description: >
Indicates whether the service is mobile or not. Indicates whether the EES service area is mobile or not.
true indicates that the EES service area is mobile (e.g., case of a MEO or LEO
satellite).
false indicates that the EES service area is not mobile (e.g., case of a GEO
satellite).
The default value is "false" when this attribute is omitted.
satId: satId:
type: string type: string
trajId: trajId:
type: string type: string
required:
- satId
ACRScenario: ACRScenario:
anyOf: anyOf:
......
TS29558_Eecs_TargetEESDiscovery.yaml
View file @ 1a359940
...@@ -3,12 +3,12 @@ info: ...@@ -3,12 +3,12 @@ info:
title: ECS Target EES Discovery API title: ECS Target EES Discovery API
description: | description: |
API for Target EES Discovery. API for Target EES Discovery.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.558 V19.1.0 Enabling Edge Applications; 3GPP TS 29.558 V19.3.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3 Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
security: security:
...@@ -50,6 +50,21 @@ paths: ...@@ -50,6 +50,21 @@ paths:
required: false required: false
schema: schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
- name: cand-dnais-info
in: query
description: >
Contains the candidate DNAI(s) related information.
This query parameter is applicable only for the common EAS case.
When the "EdgeApp_3" feature is supported, this query parameter and the target-dnai
Query parameter are mutually exclusive.
required: false
style: form
explode: false
schema:
type: array
items:
$ref: '#/components/schemas/CandidateDnaisInfo'
minItems: 1
- name: ue-id - name: ue-id
in: query in: query
description: Identifier of the UE. description: Identifier of the UE.
...@@ -207,3 +222,27 @@ components: ...@@ -207,3 +222,27 @@ components:
required: required:
- servProvId - servProvId
- endPoint - endPoint
CandidateDnaisInfo:
description: >
Represents the candidate DNAI(s) related information.
type: object
properties:
candidateDnais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 1
candDnaisPrioInd:
type: boolean
description: >
Indicates whether the candidate DNAI(s) provided within the candidateDnais attribute are
in descending priority order, i.e., the lower the array index of the candidateDnais
attribute the higher the priority of the respective DNAI.
true indicates that the candidate DNAI(s) provided within the candidateDnais attribute
are in descending priority order.
false indicates that the candidate DNAI(s) provided within the candidateDnais attribute
are not in descending priority order.
The default value is false if this attribute is omitted.
required:
- candidateDnais
TS29558_Eees_EASRegistration.yaml
View file @ 1a359940
...@@ -6,11 +6,11 @@ info: ...@@ -6,11 +6,11 @@ info:
API for EAS Registration. API for EAS Registration.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.558 V19.2.0 Enabling Edge Applications; 3GPP TS 29.558 V19.3.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3 Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
...@@ -41,14 +41,15 @@ paths: ...@@ -41,14 +41,15 @@ paths:
$ref: '#/components/schemas/EASRegistration' $ref: '#/components/schemas/EASRegistration'
responses: responses:
'201': '201':
description: EAS information is registered successfully at EES. description: >
Created. The EAS information is registered successfully at the EES.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/EASRegistration' $ref: '#/components/schemas/EASRegistration'
headers: headers:
Location: Location:
description: 'Contains the URI of the newly created resource' description: Contains the URI of the newly created resource.
required: true required: true
schema: schema:
type: string type: string
...@@ -77,7 +78,7 @@ paths: ...@@ -77,7 +78,7 @@ paths:
/registrations/{registrationId}: /registrations/{registrationId}:
get: get:
summary: Read an Individual EAS Registration resource summary: Retrieve an existing Individual EAS Registration resource.
operationId: ReadIndEASRegistration operationId: ReadIndEASRegistration
tags: tags:
- Individual EAS Registration (Document) - Individual EAS Registration (Document)
...@@ -85,13 +86,13 @@ paths: ...@@ -85,13 +86,13 @@ paths:
parameters: parameters:
- name: registrationId - name: registrationId
in: path in: path
description: Registration Id. description: Represents the identifier of the Individual EAS Registration resource.
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'200': '200':
description: OK (The EAS registration information at the EES). description: OK. The requested Individual EAS Registration resource is returned.
content: content:
application/json: application/json:
schema: schema:
...@@ -120,7 +121,7 @@ paths: ...@@ -120,7 +121,7 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/default' $ref: 'TS29122_CommonData.yaml#/components/responses/default'
put: put:
summary: Update an Individual EAS Registration resource summary: Update an existing Individual EAS Registration resource.
operationId: UpdateIndEASRegistration operationId: UpdateIndEASRegistration
tags: tags:
- Individual EAS Registration (Document) - Individual EAS Registration (Document)
...@@ -128,7 +129,7 @@ paths: ...@@ -128,7 +129,7 @@ paths:
parameters: parameters:
- name: registrationId - name: registrationId
in: path in: path
description: EAS registration Id. description: Represents the identifier of the Individual EAS Registration resource.
required: true required: true
schema: schema:
type: string type: string
...@@ -140,14 +141,17 @@ paths: ...@@ -140,14 +141,17 @@ paths:
$ref: '#/components/schemas/EASRegistration' $ref: '#/components/schemas/EASRegistration'
responses: responses:
'200': '200':
description: OK (The EAS registration information is updated successfully). description: >
OK. The Individual EAS Registration resource is successfully updated and a
representation of the updated resource shall be returned in the response body.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/EASRegistration' $ref: '#/components/schemas/EASRegistration'
'204': '204':
description: > description: >
No Content. The individual EAS registration information is updated successfully. No Content. The Individual EAS Registration resource is successfully updated and no
content is returned in the response body.
'307': '307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307' $ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308': '308':
...@@ -176,7 +180,7 @@ paths: ...@@ -176,7 +180,7 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/default' $ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch: patch:
summary: Modify an Individual EAS Registration resource summary: Modify an existing Individual EAS Registration resource.
operationId: ModifyIndEASRegistration operationId: ModifyIndEASRegistration
tags: tags:
- Individual EAS Registration (Document) - Individual EAS Registration (Document)
...@@ -184,7 +188,7 @@ paths: ...@@ -184,7 +188,7 @@ paths:
parameters: parameters:
- name: registrationId - name: registrationId
in: path in: path
description: EAS registration Id. description: Represents the identifier of the Individual EAS Registration resource..
required: true required: true
schema: schema:
type: string type: string
...@@ -198,15 +202,16 @@ paths: ...@@ -198,15 +202,16 @@ paths:
responses: responses:
'200': '200':
description: > description: >
The Individual EAS registration is successfully modified and the updated OK. The Individual EAS Registration resource is successfully modified and a
registration information is returned in the response. representation of the updated resource shall be returned in the response body.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/EASRegistration' $ref: '#/components/schemas/EASRegistration'
'204': '204':
description: > description: >
No Content. The individual EAS registration information is updated successfully. No Content. The Individual EAS Registration resource is successfully modified and no
content is returned in the response body.
'307': '307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307' $ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308': '308':
...@@ -235,7 +240,7 @@ paths: ...@@ -235,7 +240,7 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/default' $ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete: delete:
summary: Delete an Individual EAS Registration resource summary: Delete an existing Individual EAS Registration resource.
operationId: DeleteIndEASRegistration operationId: DeleteIndEASRegistration
tags: tags:
- Individual EAS Registration (Document) - Individual EAS Registration (Document)
...@@ -243,7 +248,7 @@ paths: ...@@ -243,7 +248,7 @@ paths:
parameters: parameters:
- name: registrationId - name: registrationId
in: path in: path
description: EAS registration Id. description: Represents the identifier of the Individual EAS Registration resource..
required: true required: true
schema: schema:
type: string type: string
...@@ -369,12 +374,13 @@ components: ...@@ -369,12 +374,13 @@ components:
$ref: '#/components/schemas/EASBundleInfo' $ref: '#/components/schemas/EASBundleInfo'
minItems: 1 minItems: 1
description: > description: >
Represents the information related to the EAS ability to handle bundled EAS coordinated Represents the information related to the EAS ability to handle
ACRs. bundled EAS coordinated ACRs.
This attribute may be present only when the "svcContSupp" attribute is also present. This attribute may be present only when the "svcContSupp" attribute is also present.
When this attribute is present, it indicates that the EAS (identified by the "easId" When this attribute is present, it indicates that the EAS (identified
attribute) is able to handle bundled EAS coordinated ACRs and contains the information by the "easId" attribute) is able to handle bundled by the "easId" coordinated ACRs and
of the EAS bundle(s) for which the EAS is able to handle bundled EAS coordinated ACRs. contains the information of the EAS bundle(s) for which the EAS is able to handle
bundled EAS coordinated ACRs.
transContSupp: transContSupp:
$ref: '#/components/schemas/TransContSuppDetails' $ref: '#/components/schemas/TransContSuppDetails'
avlRep: avlRep:
...@@ -390,9 +396,16 @@ components: ...@@ -390,9 +396,16 @@ components:
type: boolean type: boolean
default: false default: false
description: > description: >
Set to true to indicate that content synchronization between EASs is supported. Set to true to indicate that content synchronization between EASs is
Set to false to indicate that content synchronization between EASs is not supported. supported.
Set to false to indicate that content synchronization between EASs is
not supported.
The default value when this attribute is omitted is false. The default value when this attribute is omitted is false.
assoDevList:
type: array
items:
$ref: '#/components/schemas/AssociatedDevice'
minItems: 1
required: required:
- easId - easId
- endPt - endPt
...@@ -404,7 +417,9 @@ components: ...@@ -404,7 +417,9 @@ components:
EASRegistrationPatch: EASRegistrationPatch:
type: object type: object
description: Represents partial update request of individual EAS registration information. description: >
Represents the requested modification to an
EAS registration information.
properties: properties:
easProf: easProf:
$ref: '#/components/schemas/EASProfile' $ref: '#/components/schemas/EASProfile'
...@@ -474,7 +489,8 @@ components: ...@@ -474,7 +489,8 @@ components:
CoordinatedAcrReqs: CoordinatedAcrReqs:
type: object type: object
description: Represents the coordinated ACR related requirements for an EAS bundle. description: >
Represents the coordinated ACR related requirements for an EAS bundle.
properties: properties:
coordinatedAcrInd: coordinatedAcrInd:
type: boolean type: boolean
...@@ -482,7 +498,6 @@ components: ...@@ -482,7 +498,6 @@ components:
description: > description: >
Set to true to indicate that coordianted ACR is required. Set to true to indicate that coordianted ACR is required.
Set to false to indicate that coordianted ACR is not required. Set to false to indicate that coordianted ACR is not required.
The default value when this attribute is omitted is false.
failureAction: failureAction:
$ref: '#/components/schemas/FailureAction' $ref: '#/components/schemas/FailureAction'
required: required:
...@@ -490,7 +505,7 @@ components: ...@@ -490,7 +505,7 @@ components:
EndPoint: EndPoint:
type: object type: object
description: The end point information to reach EAS. description: Represents the end point information.
properties: properties:
fqdn: fqdn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn'
...@@ -514,6 +529,18 @@ components: ...@@ -514,6 +529,18 @@ components:
- required: [ipv4Addrs] - required: [ipv4Addrs]
- required: [ipv6Addrs] - required: [ipv6Addrs]
AssociatedDevice:
type: object
description: Represents the associated device along with the UE.
properties:
devInfo:
type: string
devType:
$ref: '#/components/schemas/DeviceType'
anyOf:
- required: [devInfo]
- required: [devType]
PermissionLevel: PermissionLevel:
anyOf: anyOf:
- type: string - type: string
...@@ -528,7 +555,7 @@ components: ...@@ -528,7 +555,7 @@ components:
extensions to the enumeration but is not used to encode extensions to the enumeration but is not used to encode
content defined in the present version of this API. content defined in the present version of this API.
description: | description: |
Indicates the level of service permissions supported by the EAS. Indicates the level of service permissions.
Possible values are: Possible values are:
- TRIAL: Level of service permission supported is TRIAL. - TRIAL: Level of service permission supported is TRIAL.
- GOLD: Level of service permission supported is GOLD. - GOLD: Level of service permission supported is GOLD.
...@@ -667,3 +694,21 @@ components: ...@@ -667,3 +694,21 @@ components:
- DISABLED: Indicates that the EAS status is disabled - DISABLED: Indicates that the EAS status is disabled
- OVERLOAD_WARNING: Indicates that the EAS status is overload warning. - OVERLOAD_WARNING: Indicates that the EAS status is overload warning.
- OTHER: Indicates the EAS status is another status. - OTHER: Indicates the EAS status is another status.
DeviceType:
anyOf:
- type: string
enum:
- HAPTIC_DEVICE
- JOY_STICK
- OTHER
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration and
is not used to encode content defined in the present version of this API.
description: |
Represents the device type.
Possible values are:
- HAPTIC_DEVICE: Indicates that the device type is haptic device.
- JOY_STICK: Indicates that the device type is joy stick
- OTHER: Indicates any other device type.
TS29558_Eees_EECContextRelocation.yaml
View file @ 1a359940
...@@ -2,15 +2,15 @@ openapi: 3.0.0 ...@@ -2,15 +2,15 @@ openapi: 3.0.0
info: info:
title: EES EEC Context Relocation API title: EES EEC Context Relocation API
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
description: | description: |
API for EEC Context Relocation. API for EEC Context Relocation.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.558 V19.1.0 Enabling Edge Applications; 3GPP TS 29.558 V19.3.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3 Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
...@@ -275,7 +275,6 @@ components: ...@@ -275,7 +275,6 @@ components:
description: > description: >
Set to true if EEC supports service continuity. Set to true if EEC supports service continuity.
Set to false if EEC does not supports service continuity. Set to false if EEC does not supports service continuity.
The default value when omitted is false.
acrScenarios: acrScenarios:
type: array type: array
items: items:
......
TS29558_Eees_SessionWithQoS.yaml
View file @ 1a359940
...@@ -5,10 +5,10 @@ info: ...@@ -5,10 +5,10 @@ info:
API for EES Session with Qos service. API for EES Session with Qos service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
version: 1.2.0-alpha.1 version: 1.2.0-alpha.2
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.558 V19.2.0 Enabling Edge Applications; 3GPP TS 29.558 V19.3.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3 Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
security: security:
......
TS29559_Npkmf_Discovery.yaml
View file @ 1a359940
...@@ -2,14 +2,14 @@ openapi: 3.0.0 ...@@ -2,14 +2,14 @@ openapi: 3.0.0
info: info:
title: Npkmf_Discovery API title: Npkmf_Discovery API
version: '1.2.0-alpha.1' version: '1.2.0-alpha.2'
description: | description: |
Npkmf_Discovery Service. Npkmf_Discovery Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.559 V19.1.0; 5G System; 5G ProSe Key Management Services; Stage 3. description: 3GPP TS 29.559 V19.2.0; 5G System; 5G ProSe Key Management Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/
servers: servers:
......
TS29559_Npkmf_PKMFKeyRequest.yaml
View file @ 1a359940
...@@ -2,14 +2,14 @@ openapi: 3.0.0 ...@@ -2,14 +2,14 @@ openapi: 3.0.0
info: info:
title: Npkmf_PKMFKeyRequest title: Npkmf_PKMFKeyRequest
version: 1.0.1 version: 1.2.0-alpha.1
description: | description: |
PKMF KeyRequest Service. PKMF KeyRequest Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.559 V17.2.0; 5G System; 5G ProSe Key Management Services; Stage 3. description: 3GPP TS 29.559 V19.2.0; 5G System; 5G ProSe Key Management Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/
servers: servers:
......
TS29559_Npkmf_UserId.yaml
View file @ 1a359940
...@@ -2,14 +2,14 @@ openapi: 3.0.0 ...@@ -2,14 +2,14 @@ openapi: 3.0.0
info: info:
title: Npkmf_ResolveRemoteUserId title: Npkmf_ResolveRemoteUserId
version: 1.0.0 version: 1.2.0-alpha.1
description: | description: |
PKMF Resolve Remote User Id Service. PKMF Resolve Remote User Id Service.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.559 V17.3.0; 5G System; 5G ProSe Anchor Services; Stage 3. description: 3GPP TS 29.559 V19.2.0; 5G System; 5G ProSe Anchor Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/
servers: servers:
......
TS29562_Nhss_gbaSDM.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.1.0' version: '1.2.0-alpha.1'
title: 'Nhss_gbaSDM' title: 'Nhss_gbaSDM'
description: | description: |
Nhss Subscriber Data Management Service for GBA. Nhss Subscriber Data Management Service for GBA.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.5.0 description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 19.2.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/'
servers: servers:
......
TS29562_Nhss_gbaUEAU.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.1.0' version: '1.2.0-alpha.1'
title: 'Nhss_gbaUEAU' title: 'Nhss_gbaUEAU'
description: | description: |
Nhss UE Authentication Service for GBA. Nhss UE Authentication Service for GBA.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.5.0 description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 19.2.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/'
servers: servers:
......
TS29562_Nhss_imsEE.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
version: '1.0.0-alpha.1'
title: 'Nhss_imsEE'
description: |
Nhss Event Exposure Service for IMS.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.562 V19.2.0; Home Subscriber Server (HSS) Services
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/
servers:
- url: '{apiRoot}/nhss-ims-ee/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
- {}
- oAuth2ClientCredentials:
- nhss-ims-ee
paths:
/{imsUeId}/ee-subscriptions:
post:
summary: Subscribe to IMS Event
operationId: ImsEventSubscribe
tags:
- IMS Event Subscription Creation
security:
- {}
- oAuth2ClientCredentials:
- nhss-ims-ee
- oAuth2ClientCredentials:
- nhss-ims-ee
- nhss-ims-ee:ee-subscriptions:create
parameters:
- name: imsUeId
in: path
description: IMS Identity
required: true
schema:
$ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImsEeSubscription'
required: true
responses:
'201':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedImsEeSubscription'
headers:
Location:
description: >
Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nhss-ims-ee/v1/{imsUeId}/ee-subscriptions/{subscriptionId}
required: true
schema:
type: string
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'501':
$ref: 'TS29571_CommonData.yaml#/components/responses/501'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/{imsUeId}/ee-subscriptions/{subscriptionId}:
delete:
summary: unsubscribe from Individual IMS Event
operationId: ImsEventUnsubscribe
tags:
- Individual IMS Event Subscription Deletion
security:
- {}
- oAuth2ClientCredentials:
- nhss-ims-ee
- oAuth2ClientCredentials:
- nhss-ims-ee
- nhss-ims-ee:ee-subscriptions:modify
parameters:
- name: imsUeId
in: path
description: IMS Identity
required: true
schema:
$ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'
- name: subscriptionId
in: path
description: Id of the Subscription
required: true
schema:
type: string
responses:
'204':
description: Successful response
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
patch:
summary: modify the subscription
operationId: ImsEventSubsModify
tags:
- Individual IMS Event Subscription Modification
security:
- {}
- oAuth2ClientCredentials:
- nhss-ims-ee
- oAuth2ClientCredentials:
- nhss-ims-ee
- nhss-ims-ee:subscription:modify
parameters:
- name: imsUeId
in: path
description: IMS Identity
required: true
schema:
$ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'
- name: subscriptionId
in: path
description: Id of the Subscription
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
minItems: 1
required: true
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedImsEeSubscription'
'204':
description: Successful response
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nhss-ims-ee: Access to the Nhss IMS Event Exposure API
nhss-ims-ee:ee-subscriptions:create: >-
Access to create IMS Event Subscriptions resource
nhss-ims-ee:ee-subscriptions:modify: >-
Access to update/delete the Individual IMS Event Subscription resource
schemas:
#
# COMPLEX TYPES:
#
ImsEeSubscription:
description: An Individual IMS Event Subscription
type: object
required:
- notificationURI
- subscrImsEvents
properties:
notifId:
type: string
afId:
type: string
notificationURI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
subscrImsEvents:
description: >
the IMS events to be subscribed or successfully subscribed in a
subscription reponse within the referenceId converted from integer
to string is the key of the map.
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEventConfiguration'
minProperties: 1
imsReportingOptions:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsReportingOptions'
CreatedImsEeSubscription:
description: The created Individual IMS Event Subscription
type: object
required:
- imsEeSubscription
properties:
imsEeSubscription:
$ref: '#/components/schemas/ImsEeSubscription'
statusEvents:
type: array
minItems: 1
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEventReport'
#
# SIMPLE TYPES
#
#
# ENUMS
#
TS29562_Nhss_imsSDM.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.3.0-alpha.2' version: '1.3.0-alpha.3'
title: 'Nhss_imsSDM' title: 'Nhss_imsSDM'
description: | description: |
Nhss Subscriber Data Management Service for IMS. Nhss Subscriber Data Management Service for IMS.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.562 HSS Services for interworking with IMS, version 19.1.0 description: 3GPP TS 29.562 HSS Services for interworking with IMS, version 19.2.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/'
servers: servers:
......
TS29562_Nhss_imsUEAU.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.2.0' version: '1.3.0-alpha.1'
title: 'Nhss_imsUEAU' title: 'Nhss_imsUEAU'
description: | description: |
Nhss UE Authentication Service for IMS. Nhss UE Authentication Service for IMS.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.5.0 description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 19.2.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/'
servers: servers:
......
TS29562_Nhss_imsUECM.yaml
View file @ 1a359940
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.3.0-alpha.2' version: '1.3.0-alpha.3'
title: 'Nhss_imsUECM' title: 'Nhss_imsUECM'
description: | description: |
Nhss UE Context Management Service for IMS. Nhss UE Context Management Service for IMS.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 19.1.0 description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 19.2.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/'
servers: servers:
......