File size: 23,289 Bytes
ab74ec2 | 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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 | openapi: 3.0.3
info:
title: Connectivity Insights - Application Profiles
x-camara-commonalities: 0.6
version: wip
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
description: |
Application profiles allow developers to specify all relevant information about their application for both network and compute resource
requirements,supporting CAMARA APIs and network decision making.
This API enables defining, reading, and managing application requirements,including:
- Network quality thresholds (latency, jitter, loss, throughput)
- Compute resource thresholds (CPU, GPU, memory, storage)
The information captured as part of application profiles can be used in different usecases for decision making. Please refer connectivity insights and session insights for more details as a reference to see how the information in application profiles is used for decision making.
The scope will expand as new requirements from CAMARA APIs emerge.
## Errors
If the authentication token is not valid, a `401 UNAUTHENTICATED` error is
returned.
Any more general service failures will result in an error in the `5xx`range
with an explanation.
### Additional CAMARA error responses
The list of error codes in this API specification is not exhaustive.
Therefore the API specification may not document some non-mandatory error
statuses as indicated in `CAMARA API Design Guide`.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release
associated to this API version for a complete list of error responses.
The applicable Commonalities Release can be identified in the `API
Readiness Checklist` document associated to this API version.
As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible
error response if it is explicitly documented in the API.
# Authorization and authentication
The "Camara Security and Interoperability Profile" provides details of how
an API consumer requests an access token. Please refer to Identity and
Consent Management
(https://github.com/camaraproject/IdentityAndConsentManagement/) for the
released version of the profile.
The specific authorization flows to be used will be agreed upon during the
onboarding process, happening between the API consumer and the API provider,
taking into account the declared purpose for accessing the API, whilst also
being subject to the prevailing legal framework dictated by local
legislation.
In cases where personal data is processed by the API and users can exercise
their rights through mechanisms such as opt-in and/or opt-out, the use of
three-legged access tokens is mandatory. This ensures that the API remains
in compliance with privacy regulations, upholding the principles of
transparency and user-centric privacy-by-design.
contact:
email: sp-edc@lists.camaraproject.org
externalDocs:
description: Project documentation at Camara
url: https://github.com/camaraproject/ApplicationProfiles
servers:
- url: "{apiRoot}/application-profiles/vwip"
variables:
apiRoot:
default: https://localhost:9091
description: |
API root, defined by service provider, e.g.
`api.example.com` or `api.example.com/somepath`
tags:
- name: Application Profiles
description: |
Operations to define, read and manage an application's thresholds
for network quality (latency, jitter, loss, throughput)
paths:
/application-profiles:
post:
security:
- openId:
- application-profiles:create
tags:
- Application Profiles
summary: Create an Application Profile
description: |
Define network monitoring intents for optimal end user application
experience.
operationId: createApplicationProfile
parameters:
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: List of user-defined network quality thresholds
content:
application/json:
schema:
$ref: "#/components/schemas/ApplicationProfileRequest"
required: true
responses:
"201":
description: Created
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ApplicationProfile"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"429":
$ref: "#/components/responses/Generic429"
/application-profiles/{applicationProfileId}:
patch:
security:
- openId:
- application-profiles:update
tags:
- Application Profiles
summary: Update an Application Profile
description: |
Update the complete set of network quality thresholds for an
application with the new set of thresholds to ensure good
end user experience
operationId: updateApplicationProfile
parameters:
- name: applicationProfileId
in: path
description: Identifier for the Application Profile
required: true
style: simple
explode: false
schema:
type: string
format: uuid
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: |
network monitoring intents for optimal end user application
experience.
content:
application/json:
schema:
$ref: "#/components/schemas/ApplicationProfile"
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ApplicationProfile"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"
get:
security:
- openId:
- application-profiles:read
tags:
- Application Profiles
summary: Get an Application Profile
description: Read an Application Profile
operationId: readApplicationProfile
parameters:
- name: applicationProfileId
in: path
description: Identifier for the Application Profile
required: true
style: simple
explode: false
schema:
type: string
format: uuid
- $ref: "#/components/parameters/x-correlator"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ApplicationProfile"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"
delete:
security:
- openId:
- application-profiles:delete
tags:
- Application Profiles
summary: Delete an Application Profile
description: Delete an application profile
operationId: deleteApplicationProfile
parameters:
- name: applicationProfileId
in: path
description: Identifier for the Application Profile
required: true
style: simple
explode: false
schema:
type: string
format: uuid
- $ref: "#/components/parameters/x-correlator"
responses:
"204":
description: Application profile has been deleted successfully.
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"
components:
securitySchemes:
openId:
type: openIdConnect
description: Common security scheme for all CAMARA APIs
openIdConnectUrl: https://example.com/.well-known/openid-configuration
headers:
x-correlator:
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
parameters:
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
schemas:
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
Duration:
type: object
properties:
value:
type: integer
example: 12
format: int32
minimum: 1
unit:
allOf:
- $ref: "#/components/schemas/TimeUnitEnum"
- example: Minutes
TimeUnitEnum:
type: string
enum:
- Days
- Hours
- Minutes
- Seconds
- Milliseconds
- Microseconds
- Nanoseconds
Rate:
type: object
properties:
value:
type: integer
example: 10
format: int32
minimum: 0
maximum: 1024
unit:
$ref: "#/components/schemas/RateUnitEnum"
RateUnitEnum:
type: string
enum:
- Bps
- Kbps
- Mbps
- Gbps
- Tbps
Compute:
type: object
properties:
value:
type: integer
example: 10
format: int32
minimum: 0
maximum: 1024
unit:
$ref: "#/components/schemas/ComputeUnitEnum"
ComputeUnitEnum:
type: string
enum:
- Kb
- Mb
- Gb
- Tb
PacketDelayBudget:
description: |
The packet delay budget is the maximum allowable one-way latency
between the customer's device and the gateway from the operator's
network to other networks. By limiting the delay, the network
can provide an acceptable level of performance for various services,
such as voice calls, video streaming, and data. The end-to-end or
round trip latency will be about two times this value plus the latency
not controlled by the operator
allOf:
- $ref: "#/components/schemas/Duration"
PacketErrorLossRate:
type: integer
description:
The exponential power of the allowable error loss rate 10^(-N).
For instance 3 would be an error loss rate of 10 to the power of -3
(0.001)
For 5G network the 3GPP specification TS 23.203 defines the packet
error loss rate QCI attribute. It describes the Quality of Service
(QoS) Class Identifier (QCI) parameters used to differentiate traffic
classes in mobile networks, ensuring appropriate resource
allocation and performance for various services.
The packet error loss rate is one of the QCI attributes, providing
information on the acceptable packet loss rate for a specific traffic
class. This attribute helps maintain the desired performance level for
services like voice calls, video streaming, or data transfers within
the 3GPP mobile network.
format: int32
minimum: 1
maximum: 10
example: 3
Jitter:
description:
The jitter requirement aims to limit the maximum variation in
round-trip packet delay for the 99th percentile of traffic, following
ITU Y.1540 standards. It considers only acknowledged packets in a
session, which are packets that receive a confirmation of receipt from
the recipient (e.g., using TCP). This requirement helps maintain
consistent latency, essential for real-time applications such as VoIP,
video calls, and gaming.
allOf:
- $ref: "#/components/schemas/Duration"
TargetMinDownstreamRate:
description: |
This is the target minimum downstream rate.
allOf:
- $ref: "#/components/schemas/Rate"
TargetMinUpstreamRate:
description: |
This is the target minimum upstream rate.
allOf:
- $ref: "#/components/schemas/Rate"
targetMinCPU:
type: number
description:
Number of vCPUs required for the application. Fractional values are allowed (e.g., 0.5 = half a vCPU). The value represents the minimum amount of CPU resources to be allocated to the application instance.
example: 0.5
targetMinGPU:
description: |
This is the target minimun GPUs required by the application
format: integer
example: 1
gpuVendorType:
type: string
enum:
- Nvidia
- AMD
description: GPU vendor name e.g. NVIDIA, AMD etc.
example: Nvidia
gpuModelName:
type: string
description: Model name corresponding to vendorType may include info e.g. for NVIDIA, model name could be “Tesla M60”, “Tesla V100” etc.
targetMinMemory:
description: |
This is the target minimum memory required by the application
allOf:
- $ref: "#/components/schemas/Compute"
targetMinEphemeralStorage:
description: |
This is the target minimum ephemeral storage required by the application
allOf:
- $ref: "#/components/schemas/Compute"
targetMinPersistentStorage:
description: |
This is the target minimum persistent storage required by the
application
allOf:
- $ref: "#/components/schemas/Compute"
ApplicationProfile:
type: object
required:
- applicationProfileId
properties:
applicationProfileId:
type: string
format: uuid
networkQualityThresholds:
$ref: "#/components/schemas/NetworkQualityThresholds"
computeResources:
$ref: "#/components/schemas/ComputeResourcesThresholds"
anyOf:
- required: [networkQualityThresholds]
- required: [computeResources]
ApplicationProfileRequest:
type: object
anyOf:
- required: [networkQualityThresholds]
- required: [computeResources]
properties:
networkQualityThresholds:
$ref: "#/components/schemas/NetworkQualityThresholds"
computeResources:
$ref: "#/components/schemas/ComputeResourcesThresholds"
NetworkQualityThresholds:
type: object
properties:
packetDelayBudget:
$ref: "#/components/schemas/PacketDelayBudget"
targetMinDownstreamRate:
$ref: "#/components/schemas/TargetMinDownstreamRate"
targetMinUpstreamRate:
$ref: "#/components/schemas/TargetMinUpstreamRate"
packetLossErrorRate:
$ref: "#/components/schemas/PacketErrorLossRate"
jitter:
$ref: "#/components/schemas/Jitter"
minProperties: 1
ComputeResourcesThresholds:
type: object
properties:
targetMinCPU:
$ref: "#/components/schemas/targetMinCPU"
targetMinMemory:
$ref: "#/components/schemas/targetMinMemory"
gpuVendorType:
$ref: "#/components/schemas/gpuVendorType"
gpuModelName:
$ref: "#/components/schemas/gpuModelName"
targetMinGPU:
$ref: "#/components/schemas/targetMinGPU"
targetMinGPUMemory:
$ref: "#/components/schemas/targetMinMemory"
targetMinEphemeralStorage:
$ref: "#/components/schemas/targetMinEphemeralStorage"
targetMinPersistentStorage:
$ref: "#/components/schemas/targetMinPersistentStorage"
description: Compute resources of a Application Profile
minProperties: 1
ErrorInfo:
type: object
required:
- status
- code
- message
properties:
status:
type: integer
description: HTTP response status code
code:
type: string
description: A human-readable code to describe the error
message:
type: string
description: A human-readable description of what the event represents
responses:
Generic400:
description: Bad Request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
- OUT_OF_RANGE
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body
or query param.
GENERIC_400_OUT_OF_RANGE:
description: Out of Range. Specific Syntax Exception used when
a given field has a pre-defined range or a invalid filter
criteria combination is requested
value:
status: 400
code: OUT_OF_RANGE
message: Client specified an invalid range.
Generic401:
description: Unauthorized
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 401
code:
enum:
- UNAUTHENTICATED
examples:
GENERIC_401_UNAUTHENTICATED:
description: Request cannot be authenticated and a new
authentication is required
value:
status: 401
code: UNAUTHENTICATED
message: Request not authenticated due to missing, invalid,
or expired credentials. A new authentication is required.
Generic403:
description: Forbidden
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 403
code:
enum:
- PERMISSION_DENIED
- INVALID_TOKEN_CONTEXT
examples:
GENERIC_403_PERMISSION_DENIED:
description: Permission denied. OAuth2 token access does not
have the required scope or when the user fails operational
security
value:
status: 403
code: PERMISSION_DENIED
message: Client does not have sufficient permissions to
perform this action.
GENERIC_403_INVALID_TOKEN_CONTEXT:
description: Reflect some inconsistency between information in
some field of the API and the related OAuth2 Token
value:
status: 403
code: INVALID_TOKEN_CONTEXT
message: "{{field}} is not consistent with access token."
Generic404:
description: Not found
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 404
code:
enum:
- NOT_FOUND
- IDENTIFIER_NOT_FOUND
examples:
GENERIC_404_NOT_FOUND:
description: Resource is not found
value:
status: 404
code: NOT_FOUND
message: The specified resource is not found.
GENERIC_404_IDENTIFIER_NOT_FOUND:
description: Some identifier cannot be matched to a device
value:
status: 404
code: IDENTIFIER_NOT_FOUND
message: Device identifier not found.
Generic429:
description: Too Many Requests
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 429
code:
enum:
- QUOTA_EXCEEDED
- TOO_MANY_REQUESTS
examples:
GENERIC_429_QUOTA_EXCEEDED:
description: Request is rejected due to exceeding a business
quota limit
value:
status: 429
code: QUOTA_EXCEEDED
message: Out of resource quota.
GENERIC_429_TOO_MANY_REQUESTS:
description: Access to the API has been temporarily blocked due
to rate or spike arrest limits being reached
value:
status: 429
code: TOO_MANY_REQUESTS
message: Rate limit reached.
|