Commit 7b4f7d98 authored by bradburyr's avatar bradburyr
Browse files

Added OAuth security and HTTP 401 (Unauthorized) error responses.

parent c791222a

TS26512_Mas_Configuration_ContentHosting.yaml

+34 −3
Original line number Diff line number Diff line
@@ -6,18 +6,26 @@ info: 
    5GMS AS M3 Content Hosting Provisioning API

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

    All rights reserved.



tags:

  - name: Mas_Configuration_ContentHosting

    description: '5G Media Streaming: Application Server Provisioning (M3) APIs: Content Hosting'



externalDocs:

  description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols'

  description: 'TS 26.512 V18.1.0; 5G Media Streaming (5GMS); Protocols'

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



servers:

  - url: '{apiRoot}/3gpp-mas-configuration/v3'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.



security:

  - {}

  - OAuth2ClientCredentials: [] 



paths:

  /content-hosting-configurations:

    summary: "Content Hosting Configuration collection"
@@ -35,6 +43,8 @@ paths: 
                  $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '413': # Payload Too Large: No request body allowed for this operation

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

        '500': # Internal Server Error
@@ -72,9 +82,11 @@ paths: 
              description: 'URL of the newly created Content Hosting Configuration (which may be redirected from the request URL).'

              required: true

              schema:

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

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

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '405': # Method Not Allowed: Content Hosting Configuration resource already exists at the specified path

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

        '409': # Conflict: Resource already exists
@@ -113,6 +125,8 @@ paths: 
          description: 'Content Hosting Configuration Unchanged'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed
@@ -139,6 +153,8 @@ paths: 
          description: 'Content Hosting Configuration Destroyed'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed
@@ -178,6 +194,8 @@ paths: 
          description: 'No Content'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed
@@ -207,6 +225,8 @@ paths: 
                type: boolean     

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed
@@ -253,6 +273,8 @@ paths: 
          description: 'Content Purged'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed
@@ -269,3 +291,12 @@ paths: 
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

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

  

components:

  securitySchemes:

    OAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}

TS26512_Mas_Configuration_ContentPreparationTemplates.yaml

+26 −1
Original line number Diff line number Diff line
@@ -6,18 +6,26 @@ info: 
    5GMS AF M3 Content Preparation Templates Configuration API

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

    All rights reserved.



tags:

  - name: Mas_Configuration_ContentPreparationTemplates

    description: '5G Media Streaming: Application Server Configuration (M3) APIs: Content Preparation Templates'



externalDocs:

  description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols'

  description: 'TS 26.512 V18.1.0; 5G Media Streaming (5GMS); Protocols'

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



servers:

  - url: '{apiRoot}/3gpp-mas-configuration/v3'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.



security:

  - {}

  - OAuth2ClientCredentials: [] 



paths:

  /content-preparation-templates:

    summary: "Content Preparation Templates collection"
@@ -36,6 +44,8 @@ paths: 
                  $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '413': # Payload Too Large: No request body allowed for this operation

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

        '500': # Internal Server Error
@@ -76,6 +86,8 @@ paths: 
                $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '409': # Conflict: Resource already exists

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

        '410': # Gone: This resource has previously been destroyed
@@ -112,6 +124,8 @@ paths: 
          description: 'Content Preparation Template Unchanged'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed
@@ -138,6 +152,8 @@ paths: 
          description: 'Content Preparation Template Destroyed'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '409': # Conflict: This resource is still referenced by a Content Hosting Configuration or Content Publication Configuration
@@ -154,3 +170,12 @@ paths: 
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

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



components:

  securitySchemes:

    OAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}

TS26512_Mas_Configuration_ServerCertificates.yaml

+28 −3
Original line number Diff line number Diff line
@@ -6,18 +6,26 @@ info: 
    5GMS AS M3 Server Certificates Provisioning API

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

    All rights reserved.



tags:

  - name: Mas_Configuration_ServerCertificates

    description: '5G Media Streaming: Application Server Configuration (M3) APIs: Server Certificates'



externalDocs:

  description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols'

  description: 'TS 26.512 V18.1.0; 5G Media Streaming (5GMS); Protocols'

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



servers:

  - url: '{apiRoot}/3gpp-mas-configuration/v3'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.



security:

  - {}

  - OAuth2ClientCredentials: [] 



paths:

  /certificates:

    summary: "Server Certificates collection"
@@ -36,6 +44,8 @@ paths: 
                  $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '500': # Internal Server Error

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

        '503': # Service Unavailable
@@ -75,6 +85,8 @@ paths: 
                $ref: 'TS26510_CommonData.yaml#/components/schemas/Url'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '409': # Conflict: Resource already exists

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

        '410': # Gone: This resource has previously been destroyed
@@ -111,10 +123,10 @@ paths: 
          description: 'Server Certificate Unchanged'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '409': # Conflict: This resource is still referenced by a Content Hosting Configuration or Content Publication Configuration

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

        '410': # Gone: This resource has previously been destroyed

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

        '411': # Length Required
@@ -139,8 +151,12 @@ paths: 
          description: 'Server Certificate Destroyed'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '409': # Conflict: This resource is still referenced by a Content Hosting Configuration or Content Publishing Configuration

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

        '410': # Gone: This resource has previously been destroyed

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

        '413': # Payload Too Large: No request body allowed for this operation
@@ -153,3 +169,12 @@ paths: 
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

        default:

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



components:

  securitySchemes:

    OAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}