mirror of
https://github.com/open5gs/open5gs.git
synced 2026-05-05 15:24:14 +00:00
406 lines
14 KiB
YAML
406 lines
14 KiB
YAML
openapi: 3.0.0
|
|
|
|
info:
|
|
title: 3gpp-asti
|
|
version: 1.0.1
|
|
description: |
|
|
API for ASTI.
|
|
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
|
All rights reserved.
|
|
|
|
externalDocs:
|
|
description: >
|
|
3GPP TS 29.522 V17.7.0; 5G System; Network Exposure Function Northbound APIs.
|
|
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
|
|
|
|
security:
|
|
- {}
|
|
- oAuth2ClientCredentials: []
|
|
|
|
servers:
|
|
- url: '{apiRoot}/3gpp-asti/v1'
|
|
variables:
|
|
apiRoot:
|
|
default: https://example.com
|
|
description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
|
|
|
|
paths:
|
|
/{afId}/configurations:
|
|
get:
|
|
summary: read all of the active configurations of 5G access stratum time distribution for the AF
|
|
operationId: ReadAllConfigurations
|
|
tags:
|
|
- ASTI Configurations
|
|
parameters:
|
|
- name: afId
|
|
in: path
|
|
description: Identifier of the AF
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK (Successful get all of the active configurations for the AF)
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessTimeDistributionData'
|
|
minItems: 0
|
|
'307':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
|
|
'308':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
|
|
'400':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
|
|
'401':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
|
|
'403':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
|
|
'404':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'406':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
|
|
'429':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
|
|
'500':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
|
|
'503':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
|
|
default:
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
|
|
|
|
post:
|
|
summary: Creates a new configuration resource
|
|
operationId: CreateNewConfiguration
|
|
tags:
|
|
- ASTI Configurations
|
|
parameters:
|
|
- name: afId
|
|
in: path
|
|
description: Identifier of the AF
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: new configuration creation
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessTimeDistributionData'
|
|
responses:
|
|
'201':
|
|
description: Created (Successful creation)
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessTimeDistributionData'
|
|
headers:
|
|
Location:
|
|
description: 'Contains the URI of the newly created resource'
|
|
required: true
|
|
schema:
|
|
type: string
|
|
'400':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
|
|
'401':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
|
|
'403':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
|
|
'404':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'411':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
|
|
'413':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
|
|
'415':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
|
|
'429':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
|
|
'500':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
|
|
'503':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
|
|
default:
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
|
|
|
|
/{afId}/configurations/retrieve:
|
|
post:
|
|
summary: Request the status of the 5G access stratum time distribution configuration for a list of UEs.
|
|
operationId: RetrieveStatusofConfiguration
|
|
tags:
|
|
- ASTI Configurations
|
|
parameters:
|
|
- name: afId
|
|
in: path
|
|
description: Identifier of the AF
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Contains the list of GPSIs.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StatusRequestData'
|
|
responses:
|
|
'200':
|
|
description: Successful retrieval of the status of the 5G access stratum time distribution
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StatusResponseData'
|
|
'400':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
|
|
'401':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
|
|
'403':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'404':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'411':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
|
|
'413':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
|
|
'415':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
|
|
'429':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
|
|
'500':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
|
|
'503':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
|
|
default:
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
|
|
|
|
/{afId}/configurations/{configId}:
|
|
get:
|
|
summary: Reads an active configuration for the AF and the configuration Id
|
|
operationId: ReadAnConfiguration
|
|
tags:
|
|
- Individual ASTI Configuration
|
|
parameters:
|
|
- name: afId
|
|
in: path
|
|
description: Identifier of the AF
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: configId
|
|
in: path
|
|
description: Identifier of the configuration resource
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK (Successful get the active configuration)
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessTimeDistributionData'
|
|
'307':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
|
|
'308':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
|
|
'400':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
|
|
'401':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
|
|
'403':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
|
|
'404':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'406':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
|
|
'429':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
|
|
'500':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
|
|
'503':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
|
|
default:
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
|
|
|
|
put:
|
|
summary: Modifies an active configuration for the AF and the configuration Id
|
|
operationId: FullyModifyAnConfiguration
|
|
tags:
|
|
- Individual ASTI Configuration
|
|
parameters:
|
|
- name: afId
|
|
in: path
|
|
description: Identifier of the AF
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: configId
|
|
in: path
|
|
description: Identifier of the configuration resource
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Parameters to update/replace the existing configuration
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessTimeDistributionData'
|
|
responses:
|
|
'200':
|
|
description: OK (Successful update of the configuration)
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AccessTimeDistributionData'
|
|
'204':
|
|
description: No Content
|
|
'307':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
|
|
'308':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
|
|
'400':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
|
|
'401':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
|
|
'403':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
|
|
'404':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'411':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
|
|
'413':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
|
|
'415':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
|
|
'429':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
|
|
'500':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
|
|
'503':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
|
|
default:
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
|
|
|
|
delete:
|
|
summary: Deletes an already existing configuration
|
|
operationId: DeleteAnConfiguration
|
|
tags:
|
|
- Individual ASTI Configuration
|
|
parameters:
|
|
- name: afId
|
|
in: path
|
|
description: Identifier of the AF
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: configId
|
|
in: path
|
|
description: Identifier of the configuration resource
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'204':
|
|
description: No Content (Successful deletion of the existing configuration)
|
|
'307':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
|
|
'308':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
|
|
'400':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
|
|
'401':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
|
|
'403':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
|
|
'404':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
|
|
'429':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
|
|
'500':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
|
|
'503':
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
|
|
default:
|
|
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
|
|
|
|
|
|
components:
|
|
|
|
securitySchemes:
|
|
oAuth2ClientCredentials:
|
|
type: oauth2
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: '{tokenUrl}'
|
|
scopes: {}
|
|
|
|
schemas:
|
|
|
|
AccessTimeDistributionData:
|
|
description: >
|
|
Contains the parameters for the creation of 5G access stratum time distribution configuration.
|
|
type: object
|
|
properties:
|
|
gpsis:
|
|
type: array
|
|
items:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
|
|
minItems: 1
|
|
exterGroupId:
|
|
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
|
|
asTimeDisParam:
|
|
$ref: 'TS29565_Ntsctsf_ASTI.yaml#/components/schemas/AsTimeDistributionParam'
|
|
suppFeat:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
|
|
required:
|
|
- asTimeDisParam
|
|
oneOf:
|
|
- required: [gpsis]
|
|
- required: [interGrpId]
|
|
|
|
StatusRequestData:
|
|
description: >
|
|
Contains the parameters for retrieval of the status of the access stratum time distribution
|
|
for a list of UEs.
|
|
type: object
|
|
properties:
|
|
gpsis:
|
|
type: array
|
|
items:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
|
|
minItems: 1
|
|
required:
|
|
- gpsis
|
|
|
|
StatusResponseData:
|
|
description: >
|
|
Contains the parameters for the status of the access stratum time distribution for a list of
|
|
UEs.
|
|
type: object
|
|
properties:
|
|
inactiveUes:
|
|
type: array
|
|
items:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
|
|
minItems: 1
|
|
activeUes:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ActiveUe'
|
|
minItems: 1
|
|
|
|
ActiveUe:
|
|
description: >
|
|
Contains the UE identifier whose status of the access stratum time distribution is active and
|
|
the optional requested time synchronization error budget.
|
|
type: object
|
|
properties:
|
|
gpsi:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
|
|
timeSyncErrBdgt:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
|