Commit a39506cd authored by Tien-Thinh Nguyen's avatar Tien-Thinh Nguyen

add 3gpp specs

parent bbd6072d
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
openapi: 3.0.0
info:
title: 3gpp-ecr-control
version: 1.0.1
description: |
API for enhanced converage restriction control.
© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.122 V15.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-ecr-control/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
paths:
/query:
post:
summary: Query the status of enhanced converage restriction for a UE.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ECRControl'
responses:
'200':
description: The requested information was returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ECRData'
'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'
/configure:
post:
summary: Configure the enhanced converage restriction for a UE.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ECRControl'
responses:
'200':
description: The Enhanced Coverage Restriction setting was configured successfully..
content:
application/json:
schema:
$ref: '#/components/schemas/ECRData'
'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'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
ECRControl:
type: object
properties:
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
externalId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'
msisdn:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn'
restrictedPlmnIds:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId'
minItems: 0
description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted. This attribute shall not be present for the query custom operation.
allowedPlmnIds:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId'
minItems: 0
description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed. This attribute shall not be present for the query custom operation.
required:
- supportedFeatures
oneOf:
- required: [externalId]
- required: [msisdn]
not:
required: [restrictedPlmnIds, allowedPlmnIds]
ECRData:
type: object
properties:
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
visitedPlmnId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId'
restrictedPlmnIds:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId'
minItems: 0
description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted.
allowedPlmnIds:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId'
minItems: 0
description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed.
required:
- supportedFeatures
not:
required: [restrictedPlmnIds, allowedPlmnIds]
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
openapi: 3.0.0
info:
title: 3gpp-msisdn-less-mo-sms
version: 1.0.1
description: |
API for MSISDN-less Mobile Originated SMS.
© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.122 V15.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}'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
paths:
/:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MsisdnLessMoSmsNotification'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/MsisdnLessMoSmsNotificationReply'
'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'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
MsisdnLessMoSmsNotification:
type: object
properties:
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
sms:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes'
externalId:
type: string
description: External identifier has the form username@realm.
applicationPort:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Port'
required:
- supportedFeatures
- sms
- externalId
- applicationPort
MsisdnLessMoSmsNotificationReply:
type: object
properties:
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- supportedFeatures
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_AsSessionWithQoS.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_ChargeableParty.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_CommonData.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_CpProvisioning.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_DeviceTriggering.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_ECRControl.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_GMDviaMBMSbyMB2.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_GMDviaMBMSbyxMB.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_MonitoringEvent.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_MsisdnLessMoSms.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_NIDD.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_NpConfiguration.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_PfdManagement.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_ReportingNetworkStatus.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29122_ResourceManagementOfBdt.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29502_Nsmf_PDUSession.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29503_Nudm_EE.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29503_Nudm_NIDDAU.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29503_Nudm_PP.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29503_Nudm_SDM.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29503_Nudm_UEAU.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29503_Nudm_UECM.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29504_Nudr_DR.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29507_Npcf_AMPolicyControl.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29508_Nsmf_EventExposure.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29509_Nausf_SoRProtection.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29509_Nausf_UEAuthentication.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29509_Nausf_UPUProtection.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29510_Nnrf_AccessToken.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29510_Nnrf_NFDiscovery.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29510_Nnrf_NFManagement.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29518_Namf_Communication.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29518_Namf_EventExposure.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29518_Namf_Location.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29518_Namf_MT.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29519_Application_Data.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29519_Exposure_Data.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29519_Policy_Data.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29520_Nnwdaf_AnalyticsInfo.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29521_Nbsf_Management.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29522_NIDDConfigurationTrigger.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29522_TrafficInfluence.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29525_Npcf_UEPolicyControl.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29540_Nsmsf_SMService.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29551_Nnef_PFDmanagement.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29554_Npcf_BDTPolicyControl.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29571_CommonData.yaml https://www.3gpp.org/ftp/Specs/latest/Rel-16/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment