Documented new externalServiceId property. (5c856d40) · Commits · SA4 / AMD_PRO-MED

TS26512_Mas_Configuration_ContentHosting.yaml

+1 −0

Original line number	Diff line number	Diff line
		@@ -360,6 +360,7 @@ components:
		type: string
		externalServiceId:
		type: string
		description: 'External service identifier of the parent Provisioning Session for use in retrieving Service Access Information at reference point M3.'
		ingestConfiguration:
		$ref: 'TS26510_Maf_Provisioning_ContentHosting.yaml#/components/schemas/IngestConfiguration'
		distributionConfigurations:

TS26512_Mas_Configuration_ContentHosting.yaml.bak

0 → 100755

+369 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: Mas_Configuration_ContentHosting
		version: 1.1.0
		description: \|
		5GMS AS Configuration API: Content Hosting
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		tags:
		- name: Mas_Configuration_ContentHosting
		description: '5G Media Streaming: Application Server Configuration (M3) APIs: Content Hosting'

		externalDocs:
		description: 'TS 26.512 V19.0.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 26.512 clause 6.1.2.

		security:
		- {}
		- OAuth2: []

		paths:
		/content-hosting-configurations:
		summary: "Content Hosting Configuration collection"
		get:
		operationId: enumerateContentHostingConfigurations
		summary: "Retrieve a list of Content Hosting Configuration resource identifiers currently registered with the 5GMS AS"
		security:
		- OAuth2:
		- content-hosting-configuration_enumerate
		responses:
		'200': # OK
		description: "Success"
		content:
		application/json:
		schema:
		type: array
		items:
		$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
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		/content-hosting-configurations/{afResourceId}:
		summary: "Operations to manipulate a single Content Hosting Configuration resource"
		description: "Individual resources in the collection are addressed using an afResourceId nominated by the 5GMS AF which is unique in this collection at a given 5GMS AS instance."
		parameters:
		- name: afResourceId
		in: path
		required: true
		schema:
		$ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'
		description: 'The resource identifier of an existing Provisioning Session.'
		post:
		operationId: createContentHostingConfiguration
		summary: 'Create and upload the Content Hosting Configuration for the specified Provisioning Session'
		security:
		- OAuth2:
		- content-hosting-configuration_create
		requestBody:
		description: 'A JSON representation of a Content Hosting Configuration'
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ApplicationServerContentHostingConfiguration'
		responses:
		'201': # Created
		description: 'Content Hosting Configuration Created'
		headers:
		Location:
		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/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
		$ref: 'TS29571_CommonData.yaml#/components/responses/410'
		'411': # Length Required
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413': # Payload Too Large
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'414': # URI Too Long
		$ref: 'TS29571_CommonData.yaml#/components/responses/414'
		'415': # Unsupported Media Type
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'500': # Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'
		# get (Retrieval of individual Content Hosting Configuration resources is not permitted at reference point M3.)
		put:
		operationId: replaceContentHostingConfiguration
		summary: 'Replace an existing Content Hosting Configuration for the specified Provisioning Session'
		security:
		- OAuth2:
		- content-hosting-configuration_replace
		requestBody:
		description: 'A JSON representation of a Content Hosting Configuration'
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ApplicationServerContentHostingConfiguration'
		responses:
		'200': # OK
		description: 'Content Hosting Configuration Replaced'
		'204': # No Content
		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
		$ref: 'TS29571_CommonData.yaml#/components/responses/410'
		'411': # Length Required
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413': # Payload Too Large
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'414': # URI Too long
		$ref: 'TS29571_CommonData.yaml#/components/responses/414'
		'415': # Unsupported Media Type
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'500': # Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'
		delete:
		operationId: destroyContentHostingConfiguration
		summary: 'Destroy the specified Content Hosting Configuration'
		security:
		- OAuth2:
		- content-hosting-configuration_destroy
		responses:
		'204': # No Content
		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
		$ref: 'TS29571_CommonData.yaml#/components/responses/410'
		'413': # Payload Too Large: No request body allowed for this operation
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'414': # URI too long
		$ref: 'TS29571_CommonData.yaml#/components/responses/414'
		'500': # Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		/content-hosting-configurations/{afResourceId}/active:
		parameters:
		- name: afResourceId
		in: path
		required: true
		schema:
		$ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'
		description: 'Individual resources in the collection are addressed using an afResourceId nominated by the 5GMS AF which is unique in this collection at a given 5GMS AS instance.'
		post:
		operationId: modifyContentHostingConfigurationState
		summary: 'Activate or deactivate the specified Content Hosting Configuration'
		security:
		- OAuth2:
		- content-hosting-configuration_modify-state
		requestBody:
		description: 'The desired state of the target Content Hosting Configuration'
		required: true
		content:
		application/json:
		schema:
		description: 'The desired state of the target Content Hosting Configuration: true for active; false for inactive.'
		type: boolean
		responses:
		'204': # No Content
		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
		$ref: 'TS29571_CommonData.yaml#/components/responses/410'
		'413': # Payload too large
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415': # Unsupported Media Type
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'414': # URI too long
		$ref: 'TS29571_CommonData.yaml#/components/responses/414'
		'500': # Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'
		get:
		operationId: interrogateContentHostingConfigurationState
		summary: 'Interrogate the current state of the specified Content Hosting Configuration'
		security:
		- OAuth2:
		- content-hosting-configuration_interrogate-state
		responses:
		'200': # OK
		description: 'Success'
		content:
		application/json:
		schema:
		description: 'The current state of the target Content Hosting Configuration: true for active; false for inactive.'
		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
		$ref: 'TS29571_CommonData.yaml#/components/responses/410'
		'413': # Payload Too Large: No request body allowed for this operation
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415': # Unsupported Media Type
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'414': # URI too long
		$ref: 'TS29571_CommonData.yaml#/components/responses/414'
		'500': # Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		/content-hosting-configurations/{afResourceId}/purge:
		parameters:
		- name: afResourceId
		in: path
		required: true
		schema:
		$ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'
		description: 'Individual resources in the collection are addressed using an afResourceId nominated by the 5GMS AF which is unique in this collection at a given 5GMS AS instance.'
		post:
		operationId: purgeContentHostingCache
		summary: 'Purge the content of the cache for the specified Content Hosting Configuration'
		security:
		- OAuth2:
		- content-hosting-configuration_purge-cache
		requestBody:
		description: 'The regular expression pattern for resources to purge from the cache'
		required: true
		content:
		application/x-www-form-urlencoded:
		schema:
		properties:
		pattern:
		description: 'Keyword'
		type: string
		value:
		description: 'The regular expression'
		type: string
		responses:
		'204': # No Content
		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
		$ref: 'TS29571_CommonData.yaml#/components/responses/410'
		'411': # Length Required
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413': # Payload too large
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'414': # URI too long
		$ref: 'TS29571_CommonData.yaml#/components/responses/414'
		'415': # Unsupported Media Type
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'500': # Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503': # Service Unavailable
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		components:
		securitySchemes:
		OAuth2:
		type: oauth2
		flows:
		clientCredentials:
		tokenUrl: '{tokenUrl}'
		scopes:
		content-hosting-configuration_enumerate: Enumerate the current set of Content Hosting Configuration resources
		content-hosting-configuration_create: Create a Content Hosting Configuration resource
		content-hosting-configuration_replace: Replace a Content Hosting Configuration resource
		content-hosting-configuration_destroy: Destroy a Content Hosting Configuration resource
		content-hosting-configuration_modify-state: Modify the state of a Content Hosting Configuration resource
		content-hosting-configuration_interrogate-state: Interrogate the state of a Content Hosting Configuration resource
		content-hosting-configuration_purge-cache: Purge the cache associated with a Content Hosting Configuration resource

		schemas:
		ApplicationServerDistributionConfiguration:
		description: 'A content distribution configuration used to configure a Media AS.'
		allOf:
		- $ref: 'TS26510_Maf_Provisioning_ContentHosting.yaml#/components/schemas/BaseDistributionConfiguration'
		- type: object
		required:
		- canonicalDomainName
		- baseURL
		properties:
		canonicalDomainName:
		type: string
		description: 'Default Fully-Qualified Domain Name assigned by the Media AF for use at reference point M4.'
		baseURL:
		allOf:
		- $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'

		# Schema for the resource itself
		ApplicationServerContentHostingConfiguration:
		type: object
		description: "A representation of a Content Hosting Configuration resource used to configure a Media AS."
		required:
		- name
		- externalServiceId
		- ingestConfiguration
		- distributionConfigurations
		properties:
		name:
		type: string
		externalServiceId:
		type: string
		ingestConfiguration:
		$ref: 'TS26510_Maf_Provisioning_ContentHosting.yaml#/components/schemas/IngestConfiguration'
		distributionConfigurations:
		type: array
		items:
		$ref: '#/components/schemas/ApplicationServerDistributionConfiguration'
		minItems: 1

TS26512_Mas_Configuration_ContentPublishing.yaml

+1 −0

Original line number	Diff line number	Diff line
		@@ -360,6 +360,7 @@ components:
		type: string
		externalServiceId:
		type: string
		description: 'External service identifier of the parent Provisioning Session for use in retrieving Service Access Information at reference point M3.'
		contributionConfigurations:
		type: array
		items:

TS26512_Mas_Configuration_ContentPublishing.yaml.bak

0 → 100755

+369 −0

File added.

Preview size limit exceeded, changes collapsed.