Commit d00a72e2 authored by Mirko Cano Soveri's avatar Mirko Cano Soveri

Merge branch 'Anatoly_YAMLs_from_specs_approved_at_SA87' into 'master'

Add the YAML baseline (from TSs approved at the March 2020 SA plenary)

See merge request !31
parents 7866ec3e 2e0868e5
Pipeline #3274 passed with stage
in 0 seconds
This diff is collapsed.
This diff is collapsed.
openapi: 3.0.1
info:
title: TS 28.532 Performance Threshold Monitoring Service
version: 16.1.0
description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service
servers:
- url: 'http://{monitoringNotifTarget}'
variables:
monitoringNotifTarget:
description: >-
The open API server of the performance threshold monitoring service is
located in the consumer side, see monitoringNotifTarget attribute of
the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11].
default: example.com
paths:
/notificationSink:
post:
summary: Send notifications about performance threshold crossing
description: To send a notifyThresholdCrossing notification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/notifyThresholdCrossing-NotifType'
responses:
'204':
description: >-
Success case ("204 No Content"). The notification is successfully
delivered. The response message body is absent.
default:
description: Error case.
content:
application/json:
schema:
$ref: '#/components/schemas/error-ResponseType'
components:
schemas:
dateTime-Type:
type: string
format: date-Time
uri-Type:
type: string
long-Type:
type: string
format: long
thresholdLevel-Type:
type: integer
measurementTypeName-Type:
type: string
measurementValue-Type:
type: string
additionalText-Type:
type: string
error-ResponseType:
type: object
properties:
error:
type: object
properties:
errorInfo:
type: string
header-Type:
description: Header used in notifications as notification header
type: object
properties:
uri:
$ref: '#/components/schemas/uri-Type'
notificationId:
$ref: '#/components/schemas/notificationId-Type'
notificationType:
$ref: '#/components/schemas/notificationType-Type'
eventTime:
$ref: '#/components/schemas/dateTime-Type'
notificationId-Type:
$ref: '#/components/schemas/long-Type'
notificationType-Type:
type: string
enum:
- notifyThresholdCrossing
notifyThresholdCrossing-NotifType:
type: object
properties:
header:
$ref: '#/components/schemas/header-Type'
body:
type: object
properties:
startOfMonitoringGP:
$ref: '#/components/schemas/dateTime-Type'
endOfMonitoringGP:
$ref: '#/components/schemas/dateTime-Type'
monitoredObjectInstance:
$ref: '#/components/schemas/uri-Type'
thresholdLevel:
$ref: '#/components/schemas/thresholdLevel-Type'
measurementTypeName:
$ref: '#/components/schemas/measurementTypeName-Type'
measurementValue:
$ref: '#/components/schemas/measurementValue-Type'
additionalText:
$ref: '#/components/schemas/additionalText-Type'
## 3GPP SA5 models and MnS OpenAPI definitions
(c) 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML file of each API:
<!-- APIs -->
## Network Resource Models (NRM)
* Generic NRM (TS 28.623)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/genericNrm.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/genericNrm.yaml))
* NR NRM (TS 28.541)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/nrNrm.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/nrNrm.yaml))
* 5GC NRM (TS 28.541)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/5gcNrm.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/5gcNrm.yaml))
* Slice NRM (TS 28.541)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/sliceNrm.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/sliceNrm.yaml))
## Management Services (MnS)
* Provisioning MnS (TS 28.532)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/provMnS.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/provMnS.yaml))
* Fault Supervision MnS (TS 28.532)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/faultMnS.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/faultMnS.yaml))
* Performance Data File Reporting MnS (TS 28.532)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/PerDataFileReportMnS.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/PerDataFileReportMnS.yaml))
* Performance Threshold Monitoring MnS (TS 28.532)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/PerThresMonMnS.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/PerThresMonMnS.yaml))
* Heartbeat Notifications(TS 28.532)
([Editor](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&yaml=OpenAPI/heartbeatNtf.yaml))
([UI](https://forge.etsi.org/swagger/tools/loader.html?repo=3GPP/SA5/data-models&branch=Anatoly_YAMLs_from_specs_approved_at_SA87&action=ui&yaml=OpenAPI/heartbeatNtf.yaml))
#### Tools
* <a href="https://forge.etsi.org/swagger/tools/GitlabOpenAPIFrontend.htm" target="_blank">Frontend</a> to invoke the Swagger Editor, Swagger UI, or to parse OpenAPI files with APIDevTools Swagger Parser/Validator, or to search for APIs referencing a data structure
* <a href="https://forge.etsi.org/swagger/tools/parser.html" target="_blank">API Parser/Linter</a> to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of <a href="https://en.wikipedia.org/wiki/Lint_(software)" target="_blank">lint</a> rules to improve API quality
* <a href="https://forge.etsi.org/swagger/tools/types.html" target="_blank">Data Type Finder</a> to find the impacted APIs due to a change on a given data type
* <a href="https://forge.etsi.org/swagger/tools/versions.html" target="_blank">API Versions Overview</a> to show a comprehensive report of the versions of all APIs in the repository
#### Other 3GPP API definitions
* <a href="https://forge.etsi.org/rep/3GPP/5G_APIs">CT4</a> specifications (29.xxx series).
This diff is collapsed.
This diff is collapsed.
openapi: 3.0.1
info:
title: Heartbeat notification
version: 16.3.0
description: >-
OAS 3.0.1 specification of the heartbeat notification
@ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 28.532 V16.3.0; Heartbeat notification
url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/
paths: {}
components:
schemas:
hearbeatNtfPeriod-Type:
type: integer
notifyHeartbeat-NotifType:
allOf:
- $ref: 'provMnS.yaml#/components/schemas/header-Type'
- type: object
properties:
heartbeatNtfPeriod:
$ref: '#/components/schemas/hearbeatNtfPeriod-Type'
This diff is collapsed.
This diff is collapsed.
openapi: 3.0.1
info:
title: Slice NRM
version: 16.4.0
description: >-
OAS 3.0.1 specification of the Slice NRM
@ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 28.541 V16.4.0; 5G NRM, Slice NRM
url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/
paths: {}
components:
schemas:
#------------ Type definitions ---------------------------------------------------
Float:
type: number
format: float
MobilityLevel:
type: string
enum:
- STATIONARY
- NOMADIC
- RESTRICTED MOBILITY
- FULLY MOBILITY
SharingLevel:
type: string
enum:
- SHARED
- NON-SHARED
Category:
type: string
enum:
- CHARACTER
- SCALABILITY
Tagging:
type: string
enum:
- PERFORMANCE
- FUNCTION
- OPERATION
Exposure:
type: string
enum:
- API
- KPI
ServAttrCom:
type: object
properties:
category:
$ref: '#/components/schemas/Category'
tagging:
$ref: '#/components/schemas/Tagging'
exposure:
$ref: '#/components/schemas/Exposure'
Support:
type: string
enum:
- NOT SUPPORTED
- SUPPORTED
DelayTolerance:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
support:
$ref: '#/components/schemas/Support'
DeterministicComm:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
availability:
$ref: '#/components/schemas/Support'
periodicityList:
type: string
DLThptPerSlice:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
guaThpt:
$ref: '#/components/schemas/Float'
maxThpt:
$ref: '#/components/schemas/Float'
DLThptPerUE:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
guaThpt:
$ref: '#/components/schemas/Float'
maxThpt:
$ref: '#/components/schemas/Float'
ULThptPerSlice:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
guaThpt:
$ref: '#/components/schemas/Float'
maxThpt:
$ref: '#/components/schemas/Float'
ULThptPerUE:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
guaThpt:
$ref: '#/components/schemas/Float'
maxThpt:
$ref: '#/components/schemas/Float'
MaxPktSize:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
maxsize:
type: integer
MaxNumberofConns:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
nOofConn:
type: integer
KPIMonitoring:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
kPIList:
type: string
SupportedAccessTech:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
accTechList:
type: integer
UserMgmtOpen:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
support:
$ref: '#/components/schemas/Support'
V2XCommModels:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
v2XMode:
$ref: '#/components/schemas/Support'
TermDensity:
type: object
properties:
servAttrCom:
$ref: '#/components/schemas/ServAttrCom'
density:
type: integer
NsInfo:
type: object
properties:
nsInstanceId:
type: string
nsName:
type: string
ServiceProfileList:
type: object
additionalProperties:
type: object
properties:
snssaiList:
$ref: 'nrNrm.yaml#/components/schemas/SnssaiList'
plmnIdList:
$ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
maxNumberofUEs:
type: number
latency:
type: number
uEMobilityLevel:
$ref: '#/components/schemas/MobilityLevel'
sst:
$ref: 'nrNrm.yaml#/components/schemas/Sst'
resourceSharingLevel:
$ref: '#/components/schemas/SharingLevel'
availability:
type: number
delayTolerance:
$ref: '#/components/schemas/DelayTolerance'
deterministicComm:
$ref: '#/components/schemas/DeterministicComm'
dLThptPerSlice:
$ref: '#/components/schemas/DLThptPerSlice'
dLThptPerUE:
$ref: '#/components/schemas/DLThptPerUE'
uLThptPerSlice:
$ref: '#/components/schemas/ULThptPerSlice'
uLThptPerUE:
$ref: '#/components/schemas/ULThptPerUE'
maxPktSize:
$ref: '#/components/schemas/MaxPktSize'
maxNumberofConns:
$ref: '#/components/schemas/MaxNumberofConns'
kPIMonitoring:
$ref: '#/components/schemas/KPIMonitoring'
supportedAccessTech:
$ref: '#/components/schemas/SupportedAccessTech'
userMgmtOpen:
$ref: '#/components/schemas/UserMgmtOpen'
v2XModels:
$ref: '#/components/schemas/V2XCommModels'
coverageArea:
type: string
termDensity:
$ref: '#/components/schemas/TermDensity'
activityFactor:
$ref: '#/components/schemas/Float'
uESpeed:
type: integer
jitter:
type: integer
survivalTime:
type: string
reliability:
type: string
SliceProfileList:
type: object
additionalProperties:
type: object
properties:
snssaiList:
$ref: 'nrNrm.yaml#/components/schemas/SnssaiList'
plmnIdList:
$ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
maxNumberofUEs:
type: number
coverageAreaTAList:
$ref: '5gcNrm.yaml#/components/schemas/TACList'
latency:
type: number
uEMobilityLevel:
$ref: '#/components/schemas/MobilityLevel'
resourceSharingLevel:
$ref: '#/components/schemas/SharingLevel'
#------------ Definition of concrete IOCs ----------------------------------------
NetworkSlice:
allOf:
- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
- type: object
properties:
attributes:
allOf:
- $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
- type: object
properties:
networkSliceSubnetRef:
$ref: 'genericNrm.yaml#/components/schemas/Dn'
operationalState:
$ref: 'genericNrm.yaml#/components/schemas/OperationalState'
administrativeState:
$ref: 'genericNrm.yaml#/components/schemas/AdministrativeState'
serviceProfileList:
$ref: '#/components/schemas/ServiceProfileList'
NetworkSliceSubnet:
allOf:
- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
- type: object
properties:
attributes:
allOf:
- $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
- type: object
properties:
managedFunctionRefList:
$ref: 'genericNrm.yaml#/components/schemas/DnList'
networkSliceSubnetRefList:
$ref: 'genericNrm.yaml#/components/schemas/DnList'
operationalState:
$ref: 'genericNrm.yaml#/components/schemas/OperationalState'
administrativeState:
$ref: 'genericNrm.yaml#/components/schemas/AdministrativeState'
nsInfo:
$ref: '#/components/schemas/NsInfo'
sliceProfileList:
$ref: '#/components/schemas/SliceProfileList'
#------------ Definitions in TS 28.541 for TS 28.532 -----------------------------
resources-sliceNrm:
oneOf:
- $ref: '#/components/schemas/NetworkSlice'
- $ref: '#/components/schemas/NetworkSliceSubnet'
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