-
Notifications
You must be signed in to change notification settings - Fork 255
/
TS26512_M1_MetricsReportingProvisioning.yaml
153 lines (153 loc) · 5.79 KB
/
TS26512_M1_MetricsReportingProvisioning.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
openapi: 3.0.0
info:
title: M1_MetricsReportingProvisioning
version: 2.1.1
description: |
5GMS AF M1 Metrics Reporting Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
- name: M1_MetricsReportingProvisioning
description: '5G Media Streaming: Provisioning (M1) APIs: Metrics Reporting Provisioning'
externalDocs:
description: 'TS 26.512 V17.8.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
- url: '{apiRoot}/3gpp-m1/v2'
variables:
apiRoot:
default: https://example.com
description: See 3GPP TS 29.512 clause 6.1.
paths:
/provisioning-sessions/{provisioningSessionId}/metrics-reporting-configurations:
parameters:
- name: provisioningSessionId
in: path
required: true
schema:
$ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'
description: 'The resource identifier of an existing Provisioning Session.'
post:
operationId: activateMetricsReporting
summary: 'Activate the Metrics reporting procedure for the specified Provisioning Session by providing the Metrics Reporting Configuration'
requestBody:
description: 'A JSON representation of a Metrics Reporting Configuration'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsReportingConfiguration'
responses:
'201':
description: 'Metrics Reporting Configuration Created'
headers:
Location:
description: 'URL of the newly created Metrics Reporting Configuration (same as request URL).'
required: true
schema:
$ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl'
/provisioning-sessions/{provisioningSessionId}/metrics-reporting-configurations/{metricsReportingConfigurationId}:
parameters:
- name: provisioningSessionId
in: path
required: true
schema:
$ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'
description: 'The resource identifier of an existing Provisioning Session.'
- name: metricsReportingConfigurationId
in: path
required: true
schema:
$ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'
description: 'The resource identifier of a Metrics Reporting Configuration.'
get:
operationId: retrieveMetricsReportingConfiguration
summary: 'Retrieve the specified Metrics Reporting Configuration of the specified Provisioning Session'
responses:
'200':
description: 'Success'
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsReportingConfiguration'
put:
operationId: updateMetricsReportingConfiguration
summary: 'Update the specified Metrics Reporting Configuration for the specified Provisioning Session'
requestBody:
description: 'A JSON representation of a Metrics Reporting Configuration'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsReportingConfiguration'
responses:
'204':
description: 'Updated Metrics Reporting Configuration'
'404':
description: 'Not Found'
patch:
operationId: patchMetricsReportingConfiguration
summary: 'Patch the specified Metrics Reporting Configuration for the specified Provisioning Session'
requestBody:
description: 'A JSON representation of a Metrics Reporting Configuration'
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/MetricsReportingConfiguration'
application/json-patch+json:
schema:
$ref: '#/components/schemas/MetricsReportingConfiguration'
responses:
'200':
description: 'Patched Metrics Reporting Configuration'
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsReportingConfiguration'
'404':
description: 'Not Found'
delete:
operationId: destroyMetricsReportingConfiguration
summary: 'Destroy the specified Metrics Reporting Configuration of the specified Provisioning Session'
responses:
'204':
description: 'Destroyed Metrics Reporting Configuration'
'404':
description: 'Not Found'
components:
schemas:
MetricsReportingConfiguration:
type: object
description: "A representation of a Metrics Reporting Configuration resource."
required:
- metricsReportingConfigurationId
- samplingPeriod
properties:
metricsReportingConfigurationId:
$ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'
sliceScope:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
scheme:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
dataNetworkName:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
reportingInterval:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
samplePercentage:
$ref: 'TS26512_CommonData.yaml#/components/schemas/Percentage'
urlFilters:
type: array
items:
type: string
minItems: 1
samplingPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
metrics:
type: array
items:
type: string
minItems: 1