Commit 25170427 authored by bradburyr's avatar bradburyr
Browse files

[iRTCW] [S4-241348] Added top-level provisioning and media session handling APIs for RTC.

parent cb72e298

README.md

+13 −0
Original line number Diff line number Diff line
@@ -74,6 +74,19 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26510_Maf_SessionHandling_ConsumptionReporting.yaml))





# Real-Time media Communication (RTC) TS 26.113



## RTC AF Provisioning

* Top-level Provisioning API for Real-Time media Communication (M1)

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

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



## RTC AF Session Handling

* Top-level Media Session Handling API for Real-Time media Communication (M3, M5)

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

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





# 5G Media Streaming (5GMS) TS 26.512

* Common Data Types

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

TS26113_Maf_Provisioning.yaml

0 → 100755
+64 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: Maf_Provisioning (Real-Time media Communication)

  version: 1.0.0

  description: |

    RTC AF Provisioning API

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

    All rights reserved.



tags:

  - name: Maf_Provisioning

    description: 'Real-Time media Communication: AF Provisioning APIs'



externalDocs:

  description: 'TS 26.113 V18.0.0; Real-Time Media Communication; Protocols and APIs'

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



servers:

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

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.510 clause 8.



paths:

  # Provisioning Sessions API

  /provisioning-sessions:

    $ref: 'TS26510_Maf_Provisioning_ProvisioningSessions.yaml#/paths/~1provisioning-sessions'

  /provisioning-sessions/%7bprovisioningSessionId%7d:

    $ref: 'TS26510_Maf_Provisioning_ProvisioningSessions.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d'



  # Server Certificates provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/certificates:

    $ref: 'TS26510_Maf_Provisioning_ServerCertificates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1certificates'

  /provisioning-sessions/%7bprovisioningSessionId%7d/certificates/%7bcertificateId%7d:

    $ref: 'TS26510_Maf_Provisioning_ServerCertificates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1certificates~1%7bcertificateId%7d'



  # Policy Templates provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/policy-templates:

    $ref: 'TS26510_Maf_Provisioning_PolicyTemplates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1policy-templates'

  /provisioning-sessions/%7bprovisioningSessionId%7d/policy-templates/%7bpolicyTemplateId%7d:

    $ref: 'TS26510_Maf_Provisioning_PolicyTemplates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1policy-templates~1%7bpolicyTemplateId%7d'



  # Edge Resources provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/edge-resources-configurations:

    $ref: 'TS26510_Maf_Provisioning_EdgeResources.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1edge-resources-configurations'

  /provisioning-sessions/%7bprovisioningSessionId%7d/edge-resources-configurations/%7bedgeResourcesConfigurationId%7d:

    $ref: 'TS26510_Maf_Provisioning_EdgeResources.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1edge-resources-configurations~1%7bedgeResourcesConfigurationId%7d'



  # Real-Time media Communication provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/rtc-configuration:

    $ref: 'TS26510_Maf_Provisioning_RealTimeCommunication.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1rtc-configuration'

  /provisioning-sessions/%7bprovisioningSessionId%7d/rtc-configuration/purge:

    $ref: 'TS26510_Maf_Provisioning_RealTimeCommunication.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1rtc-configuration~1purge'



  # Metrics Reporting provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/metrics-reporting-configurations:

    $ref: 'TS26510_Maf_Provisioning_MetricsReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1metrics-reporting-configurations'

  /provisioning-sessions/%7bprovisioningSessionId%7d/metrics-reporting-configurations/%7bmetricsReportingConfigurationId%7d:

    $ref: 'TS26510_Maf_Provisioning_MetricsReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1metrics-reporting-configurations~1%7bmetricsReportingConfigurationId%7d'



  # Consumption Reporting provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/consumption-reporting-configuration:

    $ref: 'TS26510_Maf_Provisioning_ConsumptionReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1consumption-reporting-configuration'

TS26113_Maf_SessionHandling.yaml

0 → 100755
+53 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: Maf_SessionHandling (Real-Time media Communication)

  version: 1.0.0

  description: |

    RTC AF Provisioning API

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

    All rights reserved.



tags:

  - name: Maf_SessionHandling

    description: 'Real-Time media Communication: Media Session Handling APIs'



externalDocs:

  description: 'TS 26.113 V18.0.0; Real-Time Media Communication; Protocols and APIs'

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



servers:

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

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.510 clause 9.





paths:

  # Service Access Information API

  /service-access-information/%7bexternalServiceId%7d:

    $ref: 'TS26510_Maf_SessionHandling_ServiceAccessInformation.yaml#/paths/~1service-access-information~1%7bexternalServiceId%7d'



  # Dynamic Policy API

  /provisioning-sessions/%7bprovisioningSessionId%7d/dynamic-policies:

    $ref: 'TS26510_Maf_SessionHandling_DynamicPolicy.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1dynamic-policies'

  /provisioning-sessions/%7bprovisioningSessionId%7d/dynamic-policies/%7bdynamicPolicyId%7d:

    $ref: 'TS26510_Maf_SessionHandling_DynamicPolicy.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1dynamic-policies~1%7bdynamicPolicyId%7d'



  # Network Assistance API

  /provisioning-sessions/%7bprovisioningSessionId%7d/network-assistance-sessions/:

    $ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1network-assistance-sessions~1'

  /provisioning-sessions/%7bprovisioningSessionId%7d/network-assistance-sessions/%7bnaSessionId%7d:

    $ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1network-assistance-sessions~1%7bnaSessionId%7d'

  /provisioning-sessions/%7bprovisioningSessionId%7d/network-assistance-sessions/%7bnaSessionId%7d/recommendation:

    $ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1network-assistance-sessions~1%7bnaSessionId%7d~1recommendation'

  /provisioning-sessions/%7bprovisioningSessionId%7d/network-assistance-sessions/%7bnaSessionId%7d/boost:

    $ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1network-assistance-sessions~1%7bnaSessionId%7d~1boost'



  # Metrics Reporting API

  /provisioning-sessions/%7bprovisioningSessionId%7d/metrics-reporting/%7bmetricsReportingConfigurationId%7d:

    $ref: 'TS26510_Maf_SessionHandling_MetricsReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1metrics-reporting~1%7bmetricsReportingConfigurationId%7d'



  # Consumption Reporting API

  /provisioning-sessions/%7bprovisioningSessionId%7d/consumption-reporting:

    $ref: 'TS26510_Maf_SessionHandling_ConsumptionReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1consumption-reporting'
 
 No newline at end of file