Commit 224ca3c2 authored by lengyelb's avatar lengyelb
Browse files

del readme from openapi

parent defc7c0f
Loading
Loading
Loading
Loading

OpenAPI/README.md

deleted100644 → 0
+0 −73
Original line number Diff line number Diff line
# 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.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/genericNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/genericNrm.yaml))

* Common NRM definitions (TS 28.623)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/comDefs.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/comDefs.yaml))

* NR NRM (TS 28.541)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/nrNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/nrNrm.yaml))

* 5GC NRM (TS 28.541)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/5gcNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/5gcNrm.yaml))

* Slice NRM (TS 28.541)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/sliceNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/sliceNrm.yaml))

* Communication Service Assurance NRM (TS 28.536)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/coslaNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/coslaNrm.yaml))

## Management Services (MnS)

* Provisioning MnS (TS 28.532)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/provMnS.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/provMnS.yaml))

* Fault Supervision MnS (TS 28.532)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/faultMnS.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/faultMnS.yaml))

* Performance Measurement Job Control MnS (28.550)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerMeasJobCtlMnS.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerMeasJobCtlMnS.yaml))

* Performance Data File Reporting MnS (TS 28.532)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerDataFileReportMnS.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerDataFileReportMnS.yaml))

* Performance Threshold Monitoring MnS (TS 28.532)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerThresMonMnS.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerThresMonMnS.yaml))

* Heartbeat Notifications(TS 28.532)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/heartbeatNtf.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/heartbeatNtf.yaml))

* Streaming Data Reporting MnS (TS 28.532)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/streamingDataMnS.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/streamingDataMnS.yaml))

## Tools

* [Frontend](https://forge.3gpp.org/swagger/tools/GitlabOpenAPIFrontend.htm) 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
* [API Parser/Linter](https://forge.3gpp.org/swagger/tools/parser.html) to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of [lint](https://en.wikipedia.org/wiki/Lint_\(software\)) rules to improve API quality
* [Data Type Finder](https://forge.3gpp.org/swagger/tools/types.html) to find the impacted APIs due to a change on a given data type
* [API Versions Overview](https://forge.3gpp.org/swagger/tools/versions.html) to show a comprehensive report of the versions of all APIs in the repository

## Other 3GPP API definitions

* [CT4](https://forge.3gpp.org/rep/3GPP/5G_APIs) specifications.