mirror of
https://github.com/open5gs/open5gs.git
synced 2026-05-05 15:24:14 +00:00
ce668c556c
MAP was generated incorrectly because {{#items}}..{{#items}} was
missing.
Because of this, If scpInfo has scpPort, NRF crashes.
162 lines
4.7 KiB
YAML
162 lines
4.7 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
version: 1.1.2
|
|
title: Nausf_SoRProtection Service
|
|
description: |
|
|
AUSF SoR Protection Service.
|
|
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
|
All rights reserved.
|
|
|
|
externalDocs:
|
|
description: 3GPP TS 29.509 V16.7.0; 5G System; Authentication Server Services
|
|
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.509'
|
|
|
|
servers:
|
|
- url: '{apiRoot}/nausf-sorprotection/v1'
|
|
variables:
|
|
apiRoot:
|
|
default: https://example.com
|
|
description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501.
|
|
security:
|
|
- {}
|
|
- oAuth2ClientCredentials:
|
|
- nausf-sorprotection
|
|
paths:
|
|
/{supi}/ue-sor:
|
|
post:
|
|
parameters:
|
|
- name: supi
|
|
in: path
|
|
description: Identifier of the UE
|
|
required: true
|
|
schema:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SorInfo'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: SorSecurityInfo
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SorSecurityInfo'
|
|
'307':
|
|
description: temporary redirect
|
|
headers:
|
|
Location:
|
|
description: 'An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set '
|
|
required: true
|
|
schema:
|
|
type: string
|
|
3gpp-Sbi-Target-Nf-Id:
|
|
description: 'Identifier of target AUSF (service) instance towards which the request is redirected'
|
|
schema:
|
|
type: string
|
|
'308':
|
|
description: permanent redirect
|
|
headers:
|
|
Location:
|
|
description: 'An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set '
|
|
required: true
|
|
schema:
|
|
type: string
|
|
3gpp-Sbi-Target-Nf-Id:
|
|
description: 'Identifier of target AUSF (service) instance towards which the request is redirected'
|
|
schema:
|
|
type: string
|
|
|
|
'503':
|
|
description: Service Unavailable
|
|
content:
|
|
application/problem+json:
|
|
schema:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
|
|
components:
|
|
securitySchemes:
|
|
oAuth2ClientCredentials:
|
|
type: oauth2
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: '{nrfApiRoot}/oauth2/token'
|
|
scopes:
|
|
nausf-sorprotection: Access to the Nausf_SoRProtection API
|
|
schemas:
|
|
# COMPLEX TYPES:
|
|
#
|
|
SorInfo:
|
|
type: object
|
|
properties:
|
|
steeringContainer:
|
|
$ref: '#/components/schemas/SteeringContainer'
|
|
ackInd:
|
|
$ref: '#/components/schemas/AckInd'
|
|
supportedFeatures:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
|
|
required:
|
|
- ackInd
|
|
SorSecurityInfo:
|
|
type: object
|
|
properties:
|
|
sorMacIausf:
|
|
$ref: '#/components/schemas/SorMac'
|
|
counterSor:
|
|
$ref: '#/components/schemas/CounterSor'
|
|
sorXmacIue:
|
|
$ref: '#/components/schemas/SorMac'
|
|
required:
|
|
- sorMacIausf
|
|
- counterSor
|
|
SteeringContainer:
|
|
oneOf:
|
|
- type: array
|
|
items:
|
|
$ref: '#/components/schemas/SteeringInfo'
|
|
minItems: 1
|
|
- $ref: '#/components/schemas/SecuredPacket'
|
|
SteeringInfo:
|
|
type: object
|
|
properties:
|
|
plmnId:
|
|
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
|
|
accessTechList:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessTech'
|
|
minItems: 1
|
|
required:
|
|
- plmnId
|
|
# SIMPLE TYPES:
|
|
#
|
|
SorMac:
|
|
type: string
|
|
pattern: '^[A-Fa-f0-9]{32}$'
|
|
CounterSor:
|
|
type: string
|
|
pattern: '^[A-Fa-f0-9]{4}$'
|
|
AckInd:
|
|
type: boolean
|
|
SecuredPacket:
|
|
type: string
|
|
format: base64
|
|
# ENUMS:
|
|
|
|
AccessTech:
|
|
anyOf:
|
|
- type: string
|
|
enum:
|
|
- NR
|
|
- EUTRAN_IN_WBS1_MODE_AND_NBS1_MODE
|
|
- EUTRAN_IN_NBS1_MODE_ONLY
|
|
- EUTRAN_IN_WBS1_MODE_ONLY
|
|
- UTRAN
|
|
- GSM_AND_ECGSM_IoT
|
|
- GSM_WITHOUT_ECGSM_IoT
|
|
- ECGSM_IoT_ONLY
|
|
- CDMA_1xRTT
|
|
- CDMA_HRPD
|
|
- GSM_COMPACT
|
|
- type: string
|