C.5 OpenAPI representation of data reporting records
26.5123GPP5G Media Streaming (5GMS)ProtocolsRelease 17TS
C.5.1 R4 data reporting records
For the purpose of referencing entities defined in this clause, it shall be assumed that the OpenAPI definitions below are contained in a physical file named "TS26512_R4_DataReporting.yaml".
|
openapi: 3.0.0 info: title: 5GMS Data Reporting data types version: 1.0.0 description: | 5GMS Data Reporting data types © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. tags: – name: 5GMS Data Reporting data types description: ‘5G Media Streaming: Data Reporting data types’ externalDocs: description: ‘TS 26.512 V17.1.0; 5G Media Streaming (5GMS); Protocols’ url: ‘https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/’ paths: {} components: schemas: MediaStreamingAccessRecord: allOf: – $ref: ‘TS26532_Ndcaf_DataReporting.yaml#/components/schemas/BaseRecord’ – type: object required: – mediaStreamHandlerEndpointAddress – applicationServerEndpointAddress – requestMessage – responseMessage – processingLatency properties: mediaStreamHandlerEndpointAddress: $ref: ‘TS26512_CommonData.yaml#/components/schemas/EndpointAddress’ applicationServerEndpointAddress: $ref: ‘TS26512_CommonData.yaml#/components/schemas/EndpointAddress’ sessionIdentifier: type: string requestMessage: type: object required: – method – url – protocolVersion – size – bodySize properties: method: type: string url: $ref: ‘TS26512_CommonData.yaml#/components/schemas/Url’ protocolVersion: type: string range: type: string size: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’ bodySize: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’ contentType: type: string userAgent: type: string userIdentity: type: string referer: $ref: ‘TS26512_CommonData.yaml#/components/schemas/Url’ cacheStatus: $ref: ‘TS26512_CommonData.yaml#/components/schemas/CacheStatus’ responseMessage: type: object required: – responseCode – size – bodySize properties: responseCode: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’ size: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’ bodySize: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’ contentType: type: string processingLatency: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Float’ connectionMetrics: type: object required: – meanNetworkRoundTripTime – networkRoundTripTimeVariation – congestionWindowSize properties: meanNetworkRoundTripTime: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Float’ networkRoundTripTimeVariation: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Float’ congestionWindowSize: $ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’ |
Annex D (informative):
5GMS AF API index
Table D-1: Index of Provisioning (M1) APIs
|
HTTP request path element hierarchy |
Description |
Allowed HTTP methods |
Resource |
OpenAPI |
||||
|
Create |
Retrieve |
Update |
Destroy |
Non-RESTful operation |
structure definition clause |
definition clause |
||
|
provisioning-sessions |
Provisioning Sessions collection |
POST |
7.2.2 |
C.3.1 |
||||
|
{provisioningSessionId} |
Provisioning Session resource |
GET |
DELETE |
|||||
|
certificates |
Server Certificates collection |
POST |
7.3.2 |
C.3.2 |
||||
|
{certificateId} |
Server Certificate resource |
GET |
PUT |
DELETE |
||||
|
content-preparation-templates |
Content Preparation Templates collection |
POST |
7.4.2 |
C.3.3 |
||||
|
{contentPreparationTemplateId} |
Content Preparation Template resource |
GET |
PUT, PATCH |
DELETE |
||||
|
content-protocols-discovery |
Content Protocols resource |
GET |
7.5.2 |
C.3.4 |
||||
|
content-hosting-configuration |
Content Hosting Configuration resource |
POST |
GET |
PUT, PATCH |
DELETE |
7.6.2 |
C.3.5 |
|
|
purge |
Content Hosting cache purge operation |
POST |
||||||
|
consumption-reporting-configuration |
Consumption Reporting Configuration resource |
POST |
GET |
PUT, PATCH |
DELETE |
7.7.2 |
C.3.6 |
|
|
metrics-reporting-configuration |
Metrics Reporting Configuration collection |
POST |
7.8.2 |
C.3.7 |
||||
|
{metricsReportingConfigurationId} |
Metrics Reporting Configuration resource |
GET |
PUT, PATCH |
DELETE |
||||
|
policy-templates |
Policy Templates collection |
POST |
7.9.2 |
C.3.8 |
||||
|
{policyTemplateId} |
Policy Template resource |
GET |
PUT, PATCH |
DELETE |
||||
|
edge-resources-configurations |
Edge Resources Configurations collection |
POST |
7.10.2 |
C.3.9 |
||||
|
{edgeResourcesConfigurationId} |
Edge Resources Configuration resource |
GET |
PUT, PATCH |
DELETE |
||||
|
event-data-processing-configurations |
Event Data Processing Configuration collection |
POST |
7.11.2 |
C.3.10 |
||||
|
{eventDataProcessingConfigurationId} |
Event Data Processing Configuration resource |
GET |
PUT, PATCH |
DELETE |
||||
Table D‑2: Index of Media Session Handling (M5) APIs
|
HTTP request path element hierarchy |
Description |
Allowed HTTP methods |
Resource |
OpenAPI |
||||
|
Create |
Retrieve |
Update |
Destroy |
Non-RESTful operation |
structure definition clause |
definition clause |
||
|
service-access-information |
Service Access Information collection |
11.2.2 |
C.4.1 |
|||||
|
{provisioningSessionId} |
Service Access Information resource |
GET |
||||||
|
consumption-reporting |
Consumption Reporting collection |
11.3.2 |
C.4.2 |
|||||
|
{aspId} |
Consumption Reporting operation |
POST |
||||||
|
metrics-reporting |
Metrics Reporting collection |
11.4.2 |
C.4.3 |
|||||
|
{provisioningSessionId} |
Metrics Reporting Configurations collection |
|||||||
|
{metricsReportingConfgurationId} |
Metrics Reporting operation |
POST |
||||||
|
dynamic-policies |
Dynamic Policies collection |
POST |
11.5.2 |
C.4.4 |
||||
|
{dynamicPolicyId} |
Dynamic Policy resource |
GET |
PUT, PATCH |
DELETE |
||||
|
network-assistance |
Network Assistance Sessions collection |
POST |
11.6.2 |
C.4.5 |
||||
|
{naSessionId} |
Network Assistance Session resource |
GET |
PUT, PATCH |
DELETE |
||||
|
recommendation |
Bit rate recommendation request operation |
GET |
||||||
|
boostRequest |
Delivery boost request operation |
POST |
||||||
Annex E (normative):
Controlled vocabularies of 5G Media Streaming UE data parameters