Commit f3a529fe authored by bradburyr's avatar bradburyr
Browse files

Initial commit.

parent 49f43267

README.md

100644 → 100755
+116 −91
Original line number Diff line number Diff line 
# 5gms Pro Ph2

# {-[DRAFT]-} OpenAPI Specification Files for 3GPP 5G Core Network (Release 18)



© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.



API version: **March 2024 (draft)**  

Release status: **{+ Open +}**  



#### Tools

* <a href="https://forge.3gpp.org/swagger/tools/parser.html">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.3gpp.org/swagger/tools/types.html">Data Type Finder</a> to find the impacted APIs due to a change on a given data type

* <a href="https://forge.3gpp.org/swagger/tools/versions.html">API Versions Overview</a> to show a comprehensive report of the versions of all APIs in the repository



The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML file of each Network Function (NF) API:



<!-- APIs -->

<!-- SWAGGER_EDITOR_VERSION = 3.18.0 -->



# Media Delivery TS 26.510



* Common Data Types

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_CommonData.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_CommonData.yaml))



## Maf_Provisioning (M1) APIs

* Content Protocols API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_Provisioning_ContentProtocols.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_Provisioning_ContentProtocols.yaml))

* Provisioning Sessions API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_Provisioning_ProvisioningSessions.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_Provisioning_ProvisioningSessions.yaml))

* Policy Templates Provisioning

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_Provisioning_PolicyTemplates.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_Provisioning_PolicyTemplates.yaml))

* Edge Resources Provisioning

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_Provisioning_EdgeResources.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_Provisioning_EdgeResources.yaml))

* Metrics Reporting Provisioning

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_Provisioning_MetricsReporting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_Provisioning_MetricsReporting.yaml))



## Maf_SessionHandling (M5) APIs

* Service Access Information

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_SessionHandling_ServiceAccessInformation.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_SessionHandling_ServiceAccessInformation.yaml))

* Dynamic Policies

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_SessionHandling_DynamicPolicy.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_SessionHandling_DynamicPolicy.yaml))

* Network Assistance

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_SessionHandling_NetworkAssistance.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_SessionHandling_NetworkAssistance.yaml))

* Metrics Reporting

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_Maf_SessionHandling_MetricsReporting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_SessionHandling_MetricsReporting.yaml))





# 5G Media Streaming (5GMS) TS 26.512

>**Note:**

The APIs at reference points M1 and M5 are exposed by the 5GMS AF.



* Common Data Types

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_CommonData.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_CommonData.yaml))



## Maf_Provisioning (M1) APIs

* To-level Provisioning API for 5G Media Streaming

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning.yaml))



Individual APIs specified in TS 26.512:

* Server Certificates Provisioning API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning_ServerCertificates.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning_ServerCertificates.yaml))

* Content Preparation Templates Provisioning API`

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning_ContentPreparationTemplates.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning_ContentPreparationTemplates.yaml))

* Content Hosting Provisioning API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning_ContentHosting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning_ContentHosting.yaml))

* Consumption Reporting Provisioning API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning_ConsumptionReporting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning_ConsumptionReporting.yaml))

* Event Data Processing Provisioning API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning_EventDataProcessing.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning_EventDataProcessing.yaml))



## Maf_SessionHandling (M5) APIs

* Top-level Media Session Handling API for 5G Media Streaming

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_Provisioning.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_Provisioning.yaml))



Individual APIs specified in TS 26.512:

* Consumption Reporting API

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_Maf_SessionHandling_ConsumptionReporting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_Maf_SessionHandling_ConsumptionReporting.yaml))



APIs specified in TS 26.512 that are deprecated in this release:

* Dynamic Policies

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_M5_DynamicPolicies.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_M5_DynamicPolicies.yaml))

* Network Assistance

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_M5_NetworkAssistance.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_M5_NetworkAssistance.yaml))





## Data Reporting (R2, R4) APIs

* 5GMS Client (R2)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_R2_DataReporting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_R2_DataReporting.yaml))

* 5GMS AS (R4)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_R4_DataReporting.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_R4_DataReporting.yaml))



## Event Exposure (R5, R6) API

* Data Collection AF (R5, R6)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26512_EventExposure.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_EventExposure.yaml))





## Getting started



To make it easy for you to get started with GitLab, here's a list of recommended next steps.



Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!



## Add your files



- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files

- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:



```

cd existing_repo

git remote add origin https://forge.3gpp.org/rep/bradburyr/5gms_pro_ph2.git

git branch -M main

git push -uf origin main

```



## Integrate with your tools



- [ ] [Set up project integrations](https://forge.3gpp.org/rep/bradburyr/5gms_pro_ph2/-/settings/integrations)



## Collaborate with your team



- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)

- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)

- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)

- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)

- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)



## Test and Deploy



Use the built-in continuous integration in GitLab.



- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)

- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)

- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)

- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)

- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)



***



# Editing this README



When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.



## Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.



## Name

Choose a self-explaining name for your project.



## Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.



## Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.



## Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.



## Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.



## Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.



## Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.



## Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.



## Contributing

State if you are open to contributions and what your requirements are for accepting them.



For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.



You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.



## Authors and acknowledgment

Show your appreciation to those who have contributed to the project.



## License

For open source projects, say how it is licensed.



## Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

TS26510_Maf_Provisioning_ContentProtocols.yaml

0 → 100644
+70 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: Maf_Provisioning_ContentProtocols

  version: 2.0.0

  description: |

    Media Delivery: Content Protocols Discovery API

    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

tags:

  - name: M1_ContentDiscovery

    description: 'Media Delivery: Content Protocols Discovery API'

externalDocs:

  description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'

servers:

  - url: '{apiRoot}/3gpp-maf-provisioning/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.510 clause 7.1.

paths:

  /provisioning-sessions/{provisioningSessionId}/protocols:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

    get:

      operationId: retrieveContentProtocols

      summary: 'Retrieve the set of Content Protocols supported by the specified Provisioning Session'

      responses:

        '200':

          description: 'Success'

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/ContentProtocols'

components:

  schemas:

    ContentProtocolDescriptor:

      type: object

      description: "A descriptor describing a content protocol."

      required:

        - termIdentifier

      properties:

        termIdentifier:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'

        descriptionLocator:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/Url'

    ContentProtocols:

      type: object

      description: "A representation of the Content Protocols resource."

      properties:

        downlinkIngestProtocols:

          type: array

          items:

            $ref: '#/components/schemas/ContentProtocolDescriptor'

          minItems: 1

        uplinkEgestProtocols:

          type: array

          items:

            $ref: '#/components/schemas/ContentProtocolDescriptor'

          minItems: 1

        geoFencingLocatorTypes:

          type: array

          items:

            $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'

          minItems: 1

TS26510_Maf_Provisioning_EdgeResources.yaml

0 → 100644
+199 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: Maf_Provisioning_EdgeResources

  version: 2.1.2

  description: |

    Media Delivery: Edge Resources Provisioning API

    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

tags:

  - name: M1_EdgeResourcesProvisioning

    description: 'Media Delivery: Edge Resources Provisioning API'

externalDocs:

  description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'

servers:

  - url: '{apiRoot}/3gpp-maf-provisioning/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.510 clause 7.1.

paths:

  /provisioning-sessions/{provisioningSessionId}/edge-resources-configurations:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

    post:

      operationId: createEdgeResourcesConfiguration

      summary: 'Create an Edge Resources Configuration within the scope of the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of an Edge Resources Configuration'

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/EdgeResourcesConfiguration'

      responses:

        '201':

          description: 'Edge Resources Configuration Created'

          headers:

            Location:

              description: 'URL of the newly created Edge Resources Configuration.'

              required: true

              schema:

                $ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl'

  /provisioning-sessions/{provisioningSessionId}/edge-resources-configurations/{edgeResourcesConfigurationId}:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

      - name: edgeResourcesConfigurationId

        in: path

        required: true

        schema:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Edge Resources Configuration.'

    get:

      operationId: retrieveEdgeResourcesConfiguration

      summary: 'Retrieve the Edge Resources Configuration of the specified Provisioning Session'

      responses:

        '200':

          description: 'Success'

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/EdgeResourcesConfiguration'

    put:

      operationId: updateEdgeResourcesConfiguration

      summary: 'Update an Edge Resources Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of an Edge Resources Configuration'

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/EdgeResourcesConfiguration'

      responses:

        '204':

          description: 'Updated Edge Resources Configuration'

        '404':

          description: 'Not Found'

    patch:

      operationId: patchEdgeResourcesConfiguration

      summary: 'Patch the Edge Resources Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Edge Resources Configuration'

        required: true

        content:

          application/merge-patch+json:

            schema:

              $ref: '#/components/schemas/EdgeResourcesConfiguration'

          application/json-patch+json:

            schema:

              $ref: '#/components/schemas/EdgeResourcesConfiguration'

      responses:

        '200':

          description: 'Patched Edge Resources Configuration'

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/EdgeResourcesConfiguration'

        '404':

          description: 'Not Found'

    delete: 

      operationId: destroyEdgeResourcesConfiguration

      responses:

        '204':

          description: 'Destroyed Edge Resources Configuration'

        '404':

          description: 'Not Found'



components:

  schemas:    

    EdgeResourcesConfiguration:

      type: object

      description: 'A representation of an Edge Resources Configuration resource.'

      required:

        - edgeResourcesConfigurationId

        - edgeManagementMode

        - easRequirements

      properties:

        edgeResourcesConfigurationId:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        edgeManagementMode:

          $ref: '#/components/schemas/EdgeManagementMode'

        eligibilityCriteria:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/EdgeProcessingEligibilityCriteria'

        easRequirements:

          $ref: '#/components/schemas/EASRequirements'

        easRelocationRequirements:

          $ref: '#/components/schemas/M1EASRelocationRequirements'



    M1EASRelocationRequirements:

      type: object

      description: 'Relocation requirements of an EAS.'

      required:

        - tolerance

      properties:

        tolerance:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/EASRelocationTolerance'

        maxInterruptionDuration:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'

        maxResponseTimeDifference:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'



    EASRequirements:

        type: object

        description: 'Requirements of an EAS.'

        properties:

          easProviderIds:

            type: array

            items:

              type: string

            minItems: 1

          easId:

            type: string

          easType:

            type: string

          easFeatures:

            type: array

            items:

              type: string

            minItems: 1

          serviceKpi:

            $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASServiceKPI'

          serviceArea:

            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/GeographicalServiceArea'

          serviceAvailabilitySchedule:

            type: array

            items:

              $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime'

            minItems: 1

          serviceContinuityScenarios:

            type: array

            items:

              $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'

            minItems: 1

          serviceContinuitySupport:

            type: array

            items:

              $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'

            minItems: 1



    EdgeManagementMode:

      description: 'The management mode of an EAS.'

      anyOf:

        - type: string

          enum: [EM_AF_DRIVEN, EM_APP_DRIVEN]

        - 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.

TS26510_Maf_Provisioning_MetricsReporting.yaml

0 → 100644
+148 −0

File added.

Preview size limit exceeded, changes collapsed.

TS26510_Maf_Provisioning_PolicyTemplates.yaml

0 → 100644
+161 −0

File added.

Preview size limit exceeded, changes collapsed.