1 Star 0 Fork 2

Kenny_ZhangWei / 5GC_APIs

forked from yuxi-o / 5GC_APIs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
TS29122_PfdManagement.yaml 23.23 KB
一键复制 编辑 Web IDE 原始数据 按行查看 历史
Jesus de Gregorio 提交于 2019-12-23 22:30 . Rel-16 Dec'19
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
openapi: 3.0.0
info:
title: 3gpp-pfd-management
version: 1.1.0.alpha-4
description: |
API for PFD management.
© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.122 V16.4.0 T8 reference point for Northbound APIs
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/3gpp-pfd-management/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
paths:
/{scsAsId}/transactions:
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.
required: true
schema:
type: string
get:
responses:
'200':
description: OK. All transactions related to the request URI are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdManagement'
'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:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
description: Create a new transaction for PFD management.
responses:
'201':
description: Created. The transaction was created successfully. The SCEF shall return the created transaction in the response payload body. PfdReport may be included to provide detailed failure information for some applications.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
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':
description: The PFDs for all applications were not created successfully. PfdReport is included with detailed information.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
responses:
'204':
description: No Content (successful notification)
'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'
/{scsAsId}/transactions/{transactionId}:
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.
required: true
schema:
type: string
- name: transactionId
in: path
description: Transaction ID
required: true
schema:
type: string
get:
responses:
'200':
description: OK. The transaction information related to the request URI is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
'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:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
description: Change information in PFD management transaction.
responses:
'200':
description: OK. The transaction was modified successfully. The SCEF shall return an updated transaction in the response payload body.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
'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':
description: The PFDs for all applications were not updated successfully. PfdReport is included with detailed information.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
responses:
'204':
description: No Content. The transaction was deleted successfully. The payload body shall be empty.
'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'
/{scsAsId}/transactions/{transactionId}/applications/{appId}:
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS as defined in subclause subclause 5.2.4 of 3GPP TS 29.122.
required: true
schema:
type: string
- name: transactionId
in: path
description: Transaction ID
required: true
schema:
type: string
- name: appId
in: path
description: Identifier of the application
required: true
schema:
type: string
get:
responses:
'200':
description: OK. The application information related to the request URI is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
'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:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
description: Change information in application.
responses:
'200':
description: OK. The application resource was modified successfully. The SCEF shall return an updated application resource in the response payload body.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'409':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'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':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/PfdData'
description: Change information in PFD management transaction.
responses:
'200':
description: OK. The transaction was modified successfully. The SCEF shall return an updated transaction in the response payload body.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'409':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'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':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
responses:
'204':
description: No Content. The application was deleted successfully. The payload body shall be empty.
'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:
PfdManagement:
type: object
properties:
self:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
pfdDatas:
type: object
additionalProperties:
$ref: '#/components/schemas/PfdData'
minProperties: 1
description: Each element uniquely identifies the PFDs for an external application identifier. Each element is identified in the map via an external application identifier as key. The response shall include successfully provisioned PFD data of application(s).
pfdReports:
type: object
additionalProperties:
$ref: '#/components/schemas/PfdReport'
minProperties: 1
description: Supplied by the SCEF and contains the external application identifiers for which PFD(s) are not added or modified successfully. The failure reason is also included. Each element provides the related information for one or more external application identifier(s) and is identified in the map via the failure identifier as key.
readOnly: true
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
requestTestNotification:
type: boolean
description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
required:
- pfdDatas
PfdData:
type: object
properties:
externalAppId:
type: string
description: Each element uniquely external application identifier
self:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
pfds:
type: object
additionalProperties:
$ref: '#/components/schemas/Pfd'
description: Contains the PFDs of the external application identifier. Each PFD is identified in the map via a key containing the PFD identifier.
allowedDelay:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'
cachingTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRo'
required:
- externalAppId
- pfds
Pfd:
type: object
properties:
pfdId:
type: string
description: Identifies a PDF of an application identifier.
flowDescriptions:
type: array
items:
type: string
minItems: 1
description: Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733.
urls:
type: array
items:
type: string
minItems: 1
description: Indicates a URL or a regular expression which is used to match the significant parts of the URL.
domainNames:
type: array
items:
type: string
minItems: 1
description: Indicates an FQDN or a regular expression as a domain name matching criteria.
dnProtocol:
$ref: '#/components/schemas/DomainNameProtocol'
required:
- pfdId
PfdReport:
type: object
properties:
externalAppIds:
type: array
items:
type: string
minItems: 1
description: Identifies the external application identifier(s) which PFD(s) are not added or modified successfully
failureCode:
$ref: '#/components/schemas/FailureCode'
cachingTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
locationArea:
$ref: '#/components/schemas/UserPlaneLocationArea'
required:
- externalAppIds
- failureCode
UserPlaneLocationArea:
type: object
properties:
locationArea:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea'
locationArea5G:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
dnais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 0
description: Identifies a list of DNAI which the user plane functions support.
FailureCode:
anyOf:
- type: string
enum:
- MALFUNCTION
- RESOURCE_LIMITATION
- SHORT_DELAY
- APP_ID_DUPLICATED
- PARTIAL_FAILURE
- OTHER_REASON
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description: >
Possible values are
- MALFUNCTION: This value indicates that something functions wrongly in PFD provisioning or the PFD provisioning does not function at all.
- RESOURCE_LIMITATION: This value indicates there is resource limitation for PFD storage.
- SHORT_DELAY: This value indicates that the allowed delay is too short and PFD(s) are not stored.
- APP_ID_DUPLICATED: The received external application identifier(s) are already provisioned.
- PARTIAL_FAILURE: The PFD(s) are not provisioned to all PCEFs/TDFs/SMFs.
- OTHER_REASON: Other reason unspecified.
DomainNameProtocol:
anyOf:
- type: string
enum:
- DNS_QNAME
- TLS_SNI
- TLS_SAN
- TSL_SCN
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description: >
Possible values are
- DNS_QNAME: Identifies the DNS protocol and the question name in DNS query.
- TLS_SNI: Identifies the Server Name Indication in TLS ClientHello message.
- TLS_SAN: Identifies the Subject Alternative Name in TLS ServerCertificate message.
- TLS_SCN: Identifies the Subject Common Name in TLS ServerCertificate message.
1
https://gitee.com/kenny.w.zhang/v5GC_APIs.git
git@gitee.com:kenny.w.zhang/v5GC_APIs.git
kenny.w.zhang
v5GC_APIs
5GC_APIs
master

搜索帮助

14c37bed 8189591 565d56ea 8189591