Commit cc3b1e78 authored by bradburyr's avatar bradburyr
Browse files

Merge branch 'm5-refactoring' into 'main' 

Refactor Maf_SessionHandling API to consistently make Provisioning Session ID a path parameter

See merge request !4
parents 08d5cae9 34977fe8

TS26510_Maf_SessionHandling_ConsumptionReporting.yaml

+1 −1
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ security: 
  - OAuth2AuthorizationCode: []



paths:

  /consumption-reporting/{provisioningSessionId}:

  /provisioning-sessions/{provisioningSessionId}/consumption-reporting:

    parameters:

      - name: provisioningSessionId

        in: path

TS26510_Maf_SessionHandling_DynamicPolicy.yaml

+18 −3
Original line number Diff line number Diff line
@@ -28,7 +28,14 @@ security: 
  - OAuth2AuthorizationCode: []



paths:

  /dynamic-policies:

  /provisioning-sessions/{provisioningSessionId}/dynamic-policies:

    parameters:

      - name: provisioningSessionId

        description: 'A valid Provisioning Session identifier'

        in: path

        required: true

        schema:

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

    post:

      operationId: createDynamicPolicy

      summary: 'Create (and optionally upload) a new Dynamic Policy resource'
@@ -72,8 +79,14 @@ paths: 
        default:

          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

 

  /dynamic-policies/{dynamicPolicyId}:

  /provisioning-sessions/{provisioningSessionId}/dynamic-policies/{dynamicPolicyId}:

    parameters:

      - name: provisioningSessionId

        description: 'A valid Provisioning Session identifier'

        in: path

        required: true

        schema:

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

      - name: dynamicPolicyId

        description: 'The resource identifier of a Dynamic Policy resource'

        in: path
@@ -255,7 +268,9 @@ components: 
          allOf:

            - $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        provisioningSessionId:

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

          readOnly: true

          allOf:

            - $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        sessionId:

          $ref: 'TS26510_CommonData.yaml#/components/schemas/MediaDeliverySessionId'

        policyTemplateId:

TS26510_Maf_SessionHandling_MetricsReporting.yaml

+1 −1
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ security: 
  - OAuth2AuthorizationCode: []



paths:

  /metrics-reporting/{provisioningSessionId}/{metricsReportingConfigurationId}:

  /provisioning-sessions/{provisioningSessionId}/metrics-reporting/{metricsReportingConfigurationId}:

    parameters:

      - name: provisioningSessionId

        in: path

TS26510_Maf_SessionHandling_NetworkAssistance.yaml

+35 −5
Original line number Diff line number Diff line
@@ -28,7 +28,14 @@ security: 
  - OAuth2AuthorizationCode: []



paths:

  /network-assistance/:

  /provisioning-sessions/{provisioningSessionId}/network-assistance-sessions/:

    parameters:

      - name: provisioningSessionId

        description: 'A valid Provisioning Session identifier'

        in: path

        required: true

        schema:

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

    post:

      operationId: createNetworkAssistanceSession

      summary: 'Create a new Network Assistance Session.'
@@ -72,8 +79,14 @@ paths: 
        default:

          $ref: 'TS29571_CommonData.yaml#/components/responses/default'



  /network-assistance/{naSessionId}:

  /provisioning-sessions/{provisioningSessionId}/network-assistance-sessions/{naSessionId}:

    parameters:

      - name: provisioningSessionId

        description: 'A valid Provisioning Session identifier'

        in: path

        required: true

        schema:

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

      - name: naSessionId

        description: 'The resource identifier of an existing Network Assistance Session resource'

        in: path
@@ -222,7 +235,14 @@ paths: 
        default:

          $ref: 'TS29571_CommonData.yaml#/components/responses/default'



  /network-assistance/{naSessionId}/recommendation:

  /provisioning-sessions/{provisioningSessionId}/network-assistance-sessions/{naSessionId}/recommendation:

    parameters:

      - name: provisioningSessionId

        description: 'A valid Provisioning Session identifier'

        in: path

        required: true

        schema:

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

    get:

      operationId: requestBitRateRecommendation

      summary: 'Obtain a bit rate recommendation for the next recommendation window'
@@ -258,7 +278,15 @@ paths: 
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29571_CommonData.yaml#/components/responses/default' 

  /network-assistance/{naSessionId}/boost-request:



  /provisioning-sessions/{provisioningSessionId}/network-assistance-sessions/{naSessionId}/boost:

    parameters:

      - name: provisioningSessionId

        description: 'A valid Provisioning Session identifier'

        in: path

        required: true

        schema:

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

    post:

      operationId: requestDeliveryBoost

      summary: 'Request a delivery boost'
@@ -329,7 +357,9 @@ components: 
          allOf:

            - $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        provisioningSessionId:

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

          readOnly: true

          allOf:

            - $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        sessionId:

          $ref: 'TS26510_CommonData.yaml#/components/schemas/MediaDeliverySessionId'

        serviceDataFlowDescriptions:

TS26512_Maf_SessionHandling.yaml

+16 −16
Original line number Diff line number Diff line
@@ -49,25 +49,25 @@ paths: 
    $ref: 'TS26510_Maf_SessionHandling_ServiceAccessInformation.yaml#/paths/~1service-access-information~1%7bexternalServiceId%7d'



  # Dynamic Policy API

  /dynamic-policies:

    $ref: 'TS26510_Maf_SessionHandling_DynamicPolicy.yaml#/paths/~1dynamic-policies'

  /dynamic-policies/%7bdynamicPolicyId%7d:

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

  /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

  /network-assistance/:

    $ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/paths/~1network-assistance~1'

  /network-assistance/%7bnaSessionId%7d:

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

  /network-assistance/%7bnaSessionId%7d/recommendation:

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

  /network-assistance/%7bnaSessionId%7d/boost-request:

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

  /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

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

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

  /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

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

    $ref: 'TS26510_Maf_SessionHandling_ConsumptionReporting.yaml#/paths/~1consumption-reporting~1%7bprovisioningSessionId%7d'
 
 No newline at end of file
 
  /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