File size: 42,409 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 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 | openapi: 3.0.3
info:
title: Network Slice Booking
description: |
The Network Slice Booking (NSB) API provides programmable interface for developers to reserve a slice resource of a selected area within a period, and manage device access control as needed.
For specific details, please refer to [Network Slice Booking API Design.md](https://github.com/camaraproject/NetworkSliceBooking/blob/main/documentation/API_documentation/Network_Slice_Booking_API_Design.md).
# Introduction
This API allows the API consumer to book the availability of a network slice, specifying the service time, service area, and quality of service (QoS) profile.
It checks whether the requested QoS profile can be guaranteed for the indicated time and area, and, if so, it reserves the network slice accordingly, and monitors that the slice delivers the QoS profile. The latter process is known as Service Level Agreement (SLA) monitoring.
The API consumer can also retrieve information about an existing slice or delete a slice.
# API functionality
The API provides the following functionality:
- Create a new network slice, specifying the service time, service area, and QoS profile.
- Retrieve information about an existing slice, including the service time, service area, and QoS profile.
- Delete an existing slice.
# Request Parameters Definition:
* **serviceTime**: is defined by a start time and an end time, which indicates the period during which the network slice will be reserved.
* **serviceArea**: can be defined as a circle or a polygon, allowing for flexible geographical coverage.
* **sliceQosProfile**: includes parameters such as maximum number of devices, downstream and upstream rate per device, and packet delay budget.
* **sliceId**: is a unique identifier for the network slice, which is returned when a slice is created and used to retrieve or delete the slice later.
# 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.
Network Slice Booking API does not involve the input and output of user personal data. Therefore, the access to Network Slice Booking API is defined as `Client Credentials - 2-legged`. Please refer to [Identify and Consent Management](https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow.
# 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.
version: wip
x-camara-commonalities: "0.7"
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
externalDocs:
description: Project documentation at CAMARA
url: https://github.com/camaraproject/NetworkSliceBooking
servers:
- url: "{apiRoot}/network-slice-booking/vwip"
variables:
apiRoot:
default: http://localhost:9100
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
tags:
- name: Network Slice Booking
description: Manage Network Slice Booking
paths:
/slices:
post:
tags:
- Network Slice Booking
summary: Creates a new network slice
description: |
Create a new network slice with the expected service time, service area, and QoS profile.
NOTES:
- If newtwork slice creation is successful, the API consumer will receive a response with code `201 - Created` and a slice ID.
- If requested service area is not supported, the API consumer will receive a response with code `422 - NETWORK_SLICE_BOOKING.SERVICEAREA_NOT_SUPPORTED`.
- If the left resources are not sufficient for the requested slice resources, the API consumer will receive a response with code `422 - NETWORK_SLICE_BOOKING.RESOURCES_INSUFFICIENT`.
operationId: createSlice
security:
- openId:
- network-slice-booking:slices:create
parameters:
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: Parameters to create a new network slice
content:
application/json:
schema:
$ref: "#/components/schemas/SliceAttributes"
examples:
LOCATION_CIRCLE:
$ref: "#/components/examples/RETRIEVAL_CIRCLE"
LOCATION_POLYGON:
$ref: "#/components/examples/RETRIEVAL_POLYGON"
required: true
callbacks:
networkSliceBookingSinkCallback:
"{request.body#/sink}":
post:
tags:
- Network Slice Booking Callback
summary: Network slice booking callback
description: Callback for network slice booking events
operationId: postNetworkSliceBookingNotification
requestBody:
description: Network slice booking event notification
content:
application/cloudevents+json:
schema:
$ref: "#/components/schemas/CloudEvent"
examples:
SLICE_CREATED_EVENT_CIRCLE:
$ref: "#/components/examples/SLICE_CREATED_EVENT_CIRCLE"
SLICE_CREATED_EVENT_POLYGON:
$ref: "#/components/examples/SLICE_CREATED_EVENT_POLYGON"
responses:
"204":
description: Successful notification
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"410":
$ref: "#/components/responses/Generic410"
"429":
$ref: "#/components/responses/Generic429"
security:
- {}
- notificationsBearerAuth: []
responses:
"201":
description: Slice created successfully
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/SliceInfo"
examples:
RESPONSE_CIRCLE:
$ref: "#/components/examples/RESPONSE_CIRCLE"
RESPONSE_POLYGON:
$ref: "#/components/examples/RESPONSE_POLYGON"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"422":
$ref: "#/components/responses/NetworkSliceBooking422"
"429":
$ref: "#/components/responses/Generic429"
/slices/{sliceId}:
delete:
tags:
- Network Slice Booking
summary: Delete a network slice
description: |
Release slice resources related to sliceId.
NOTES:
- The deletion operation takes effect immediately, e.g. if the slice is deleted before the end of the service time, the service will end ahead of the scheduled time.
- If the slice is deleted, the API consumer will not be able to retrieve information about the slice.
- The deletion operation is idempotent, meaning that if the slice is already deleted, the API consumer will receive a response with code `204 - No Content`.
operationId: deleteSlice
security:
- openId:
- network-slice-booking:slices:delete
parameters:
- name: sliceId
in: path
description: Slice ID that was obtained from the createSlice operation
required: true
schema:
$ref: "#/components/schemas/SliceId"
- $ref: "#/components/parameters/x-correlator"
responses:
"204":
description: Slice deleted
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
"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:
tags:
- Network Slice Booking
summary: Get network slcie booking information
description: |
Querying for network slcie booking resource information details.
NOTES:
- According to sliceId, the API consumer can retrieve information about an existing slice, including the service time, service area, and QoS profile.
- If the slice is deleted, the API consumer will receive a response with code `404 - Not Found`.
operationId: getSlice
security:
- openId:
- network-slice-booking:slices:get
parameters:
- name: sliceId
in: path
description: Slice ID that was obtained from the createSlice operation
required: true
schema:
$ref: "#/components/schemas/SliceId"
- $ref: "#/components/parameters/x-correlator"
responses:
"200":
description: Contains information about network slice booking
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/SliceInfo"
examples:
RESPONSE_CIRCLE:
$ref: "#/components/examples/RESPONSE_CIRCLE"
RESPONSE_POLYGON:
$ref: "#/components/examples/RESPONSE_POLYGON"
"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:
description: Bearer authentication for notifications
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
notificationsBearerAuth:
description: Bearer authentication for notifications
type: http
scheme: bearer
bearerFormat: "{$request.body#sinkCredential.credentialType}"
parameters:
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
headers:
x-correlator:
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
schemas:
XCorrelator:
description: Value for the x-correlator
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
SliceId:
description: Slice ID in UUID format
type: string
format: uuid
SliceInfo:
description: Slice related information.
allOf:
- $ref: "#/components/schemas/SliceAttributes"
- type: object
properties:
sliceId:
$ref: "#/components/schemas/SliceId"
required:
- sliceId
SliceAttributes:
description: Attributes defining the characteristics of the slice
type: object
properties:
serviceTime:
description: |
serviceTime is a period during which the network slice will be reserved.
It is defined by a start time and an end time.
allOf:
- $ref: "#/components/schemas/TimePeriod"
serviceArea:
description: |
serviceArea is a geographical area where the network slice will be reserved.
It can be defined as a circle or a polygon.
allOf:
- $ref: "#/components/schemas/Area"
sliceQosProfile:
description: |
sliceQosProfile is a set of quality of service parameters that define the requirements for the network slice.
It includes parameters such as maximum number of devices, downlink and uplink throughput per device, and latency requirements.
allOf:
- $ref: "#/components/schemas/SliceQosProfile"
sink:
type: string
format: uri
description: The URL where the API response will be asynchronously delivered, using the HTTP protocol.
example: "https://endpoint.example.com/sink"
sinkCredential:
description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
allOf:
- $ref: "#/components/schemas/SinkCredential"
required:
- serviceTime
- serviceArea
- sliceQosProfile
SliceQosProfile:
description: |
Quality of service for the network slice.
It includes a set of predefined network slice performance characteristics.
type: object
properties:
maxNumOfDevices:
description: |
maxNumOfDevices is a maximum number of devices that can be connected to the slice
allOf:
- $ref: "#/components/schemas/NumberOfDevices"
downStreamRatePerDevice:
description: |
downStreamRatePerDevice is the maximum downstream rate allowed for each device connected to the slice.
It indicates the individual device capability required for the slice.
allOf:
- $ref: "#/components/schemas/Rate"
upStreamRatePerDevice:
description: |
upStreamRatePerDevice is the maximum upstream rate allowed for each device connected to the slice.
It indicates the individual device capability required for the slice.
allOf:
- $ref: "#/components/schemas/Rate"
downStreamDelayBudget:
description: |
downStreamDelayBudget is the maximum allowable downlink packet transmission latency (millisecond).
By limiting the delay, the network can provide an acceptable level of performance for various services, such as voice calls, video streaming, and data.
allOf:
- $ref: "#/components/schemas/Duration"
upStreamDelayBudget:
description: |
upStreamDelayBudget is the maximum allowable uplink packet transmission latency (millisecond).
By limiting the delay, the network can provide an acceptable level of performance for various services, such as voice calls, video streaming, and data.
allOf:
- $ref: "#/components/schemas/Duration"
Duration:
description: Specification of duration. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#appendix-A) for duration.
type: object
properties:
value:
description: Length of duration
type: integer
example: 12
format: int32
minimum: 1
unit:
$ref: "#/components/schemas/TimeUnitEnum"
TimeUnitEnum:
description: Units of time
type: string
enum:
- Days
- Hours
- Minutes
- Seconds
- Milliseconds
- Microseconds
- Nanoseconds
Rate:
description: Specification of rate
type: object
properties:
value:
description: Quantity of rate
type: integer
example: 10
format: int32
minimum: 0
maximum: 1024
unit:
$ref: "#/components/schemas/RateUnitEnum"
RateUnitEnum:
description: Units of rate
type: string
enum:
- bps
- kbps
- Mbps
- Gbps
- Tbps
NumberOfDevices:
type: integer
example: 5
description: Maximum number of devices that is allowed to be connected to the network at any point in time.
format: int32
minimum: 1
maximum: 20
TimePeriod:
properties:
startDate:
type: string
format: date-time
description: An instant of time, starting of the TimePeriod. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: "2024-06-01T12:00:00Z"
endDate:
type: string
format: date-time
description: An instant of time, ending of the TimePeriod. If not included, then the period has no ending date. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: "2024-06-02T12:00:00Z"
required:
- startDate
Area:
description: Base schema for all areas
type: object
properties:
areaType:
$ref: "#/components/schemas/AreaType"
required:
- areaType
discriminator:
propertyName: areaType
mapping:
CIRCLE: "#/components/schemas/Circle"
POLYGON: "#/components/schemas/Polygon"
AreaType:
type: string
description: |
Type of this area.
CIRCLE - The area is defined as a circle.
POLYGON - The area is defined as a polygon.
enum:
- CIRCLE
- POLYGON
Circle:
description: Circular area
allOf:
- $ref: "#/components/schemas/Area"
- type: object
required:
- center
- radius
properties:
center:
$ref: "#/components/schemas/Point"
radius:
type: number
description: Distance from the center in meters
minimum: 1
Polygon:
description: Polygonal area. The Polygon should be a simple polygon, i.e. should not intersect itself.
allOf:
- $ref: "#/components/schemas/Area"
- type: object
required:
- boundary
properties:
boundary:
$ref: "#/components/schemas/PointList"
PointList:
description: List of points defining a polygon
type: array
items:
$ref: "#/components/schemas/Point"
minItems: 3
maxItems: 15
Point:
type: object
description: Coordinates (latitude, longitude) defining a location in a map
required:
- latitude
- longitude
properties:
latitude:
$ref: "#/components/schemas/Latitude"
longitude:
$ref: "#/components/schemas/Longitude"
example:
latitude: 31.22529
longitude: 121.48905
Latitude:
description: Latitude component of a location
type: number
format: double
minimum: -90
maximum: 90
Longitude:
description: Longitude component of location
type: number
format: double
minimum: -180
maximum: 180
ErrorInfo:
description: Common schema for errors
type: object
properties:
status:
type: integer
description: HTTP status code returned along with this error response
code:
type: string
description: Code given to this error
message:
type: string
description: Detailed error description
required:
- status
- code
- message
CloudEvent:
description: The notification callback
required:
- id
- source
- specversion
- type
- time
properties:
id:
type: string
description: identifier of this event, that must be unique in the source context.
minLength: 1
source:
$ref: '#/components/schemas/Source'
type:
type: string
description: The type of the event
enum:
- "org.camaraproject.network-slice-booking.v0.status-changed"
minLength: 25
specversion:
type: string
description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version)
enum:
- "1.0"
datacontenttype:
type: string
description: 'media-type that describes the event payload encoding, must be "application/json" for CAMARA APIs'
enum:
- application/json
data:
type: object
description: Event details payload described in each CAMARA API and referenced by its type
time:
$ref: "#/components/schemas/DateTime"
discriminator:
propertyName: type
mapping:
org.camaraproject.network-slice-booking.v0.status-changed: "#/components/schemas/SliceCreatedEvent"
SliceCreatedEvent:
description: Event to notify a slice creation status change
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
description: Event details depending on the event type
allOf:
- $ref: "#/components/schemas/SliceInfo"
required:
- data
DateTime:
type: string
format: date-time
description: |
Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
WARN: This optional field in CloudEvents specification is required in CAMARA APIs implementation.
example: '2018-04-05T17:31:00Z'
Source:
type: string
format: uri-reference
minLength: 1
description: |
Identifies the context in which an event happened - be a non-empty `URI-reference` like:
- URI with a DNS authority:
* https://github.com/cloudevents
* mailto:cncf-wg-serverless@lists.cncf.io
- Universally-unique URN with a UUID:
* urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66
- Application-specific identifier:
* /cloudevents/spec/pull/123
* 1-555-123-4567
example: "https://notificationSendServer12.example.com"
SinkCredential:
description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
type: object
properties:
credentialType:
type: string
enum:
- PLAIN
- ACCESSTOKEN
- REFRESHTOKEN
description: |
The type of the credential.
Note: Type of the credential - MUST be set to ACCESSTOKEN for now
discriminator:
propertyName: credentialType
mapping:
PLAIN: "#/components/schemas/PlainCredential"
ACCESSTOKEN: "#/components/schemas/AccessTokenCredential"
REFRESHTOKEN: "#/components/schemas/RefreshTokenCredential"
required:
- credentialType
PlainCredential:
type: object
description: A plain credential as a combination of an identifier and a secret.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
required:
- identifier
- secret
properties:
identifier:
description: The identifier might be an account or username.
type: string
secret:
description: The secret might be a password or passphrase.
type: string
AccessTokenCredential:
type: object
description: An access token credential.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accessTokenExpiresUtc:
type: string
format: date-time
description: |
REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: "2023-07-03T12:27:08.312Z"
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
enum:
- bearer
required:
- accessToken
- accessTokenExpiresUtc
- accessTokenType
RefreshTokenCredential:
type: object
description: An access token credential with a refresh token.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accessTokenExpiresUtc:
type: string
format: date-time
description: |
REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: "2023-07-03T12:27:08.312Z"
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
enum:
- bearer
refreshToken:
description: REQUIRED. An refresh token credential used to acquire access tokens.
type: string
refreshTokenEndpoint:
type: string
format: uri
description: REQUIRED. A URL at which the refresh token can be traded for an access token.
required:
- accessToken
- accessTokenExpiresUtc
- accessTokenType
- refreshToken
- refreshTokenEndpoint
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
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.
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
examples:
GENERIC_404_NOT_FOUND:
description: Specified slice resource is not found based on the sliceId
value:
status: 404
code: NOT_FOUND
message: The specified resource is not found.
Generic410:
description: Gone
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 410
code:
enum:
- GONE
examples:
GENERIC_410_GONE:
description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available
value:
status: 410
code: GONE
message: Access to the target resource is no longer available.
NetworkSliceBooking422:
description: Unprocessable Content
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 422
code:
enum:
- NETWORK_SLICE_BOOKING.SERVICEAREA_NOT_SUPPORTED
- NETWORK_SLICE_BOOKING.RESOURCES_INSUFFICIENT
examples:
NETWORK_SLICE_BOOKING_422_SERVICE_AREA_NOT_SUPPORTED:
description: Business logic exception use when the requested service area is not supported
value:
status: 422
code: NETWORK_SLICE_BOOKING.SERVICEAREA_NOT_SUPPORTED
message: The requested service area is not supported.
NETWORK_SLICE_BOOKING_422_RESOURCES_INSUFFICIENT:
description: Business logic exception use when the left resources are not sufficient for the requested slice resources
value:
status: 422
code: NETWORK_SLICE_BOOKING.RESOURCES_INSUFFICIENT
message: The left resources are not sufficient for the requested slice resources.
Generic429:
description: Quota Exceed or 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.
examples:
RETRIEVAL_CIRCLE:
value:
serviceTime:
startDate: "2024-06-01T12:00:00Z"
endDate: "2024-06-02T12:00:00Z"
serviceArea:
areaType: CIRCLE
center:
latitude: 45.754114
longitude: 4.860374
radius: 800
sliceQosProfile:
maxNumOfDevices: 5
downStreamRatePerDevice:
value: 10
unit: bps
upStreamRatePerDevice:
value: 10
unit: bps
downStreamDelayBudget:
value: 12
unit: Milliseconds
upStreamDelayBudget:
value: 12
unit: Milliseconds
RETRIEVAL_POLYGON:
value:
serviceTime:
startDate: "2024-06-01T12:00:00Z"
endDate: "2024-06-02T12:00:00Z"
serviceArea:
areaType: POLYGON
boundary:
- latitude: 45.754114
longitude: 4.860374
- latitude: 45.753845
longitude: 4.863185
- latitude: 45.753916
longitude: 4.866531
- latitude: 45.754116
longitude: 4.876353
sliceQosProfile:
maxNumOfDevices: 5
downStreamRatePerDevice:
value: 10
unit: bps
upStreamRatePerDevice:
value: 10
unit: bps
downStreamDelayBudget:
value: 12
unit: Milliseconds
upStreamDelayBudget:
value: 12
unit: Milliseconds
RESPONSE_CIRCLE:
value:
serviceTime:
startDate: "2024-06-01T12:00:00Z"
endDate: "2024-06-02T12:00:00Z"
serviceArea:
areaType: CIRCLE
center:
latitude: 45.754114
longitude: 4.860374
radius: 800
sliceQosProfile:
maxNumOfDevices: 5
downStreamRatePerDevice:
value: 10
unit: bps
upStreamRatePerDevice:
value: 10
unit: bps
downStreamDelayBudget:
value: 12
unit: Milliseconds
upStreamDelayBudget:
value: 12
unit: Milliseconds
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
RESPONSE_POLYGON:
value:
serviceTime:
startDate: "2024-06-01T12:00:00Z"
endDate: "2024-06-02T12:00:00Z"
serviceArea:
areaType: POLYGON
boundary:
- latitude: 45.754114
longitude: 4.860374
- latitude: 45.753845
longitude: 4.863185
- latitude: 45.753916
longitude: 4.866531
- latitude: 45.754116
longitude: 4.876353
sliceQosProfile:
maxNumOfDevices: 5
downStreamRatePerDevice:
value: 10
unit: bps
upStreamRatePerDevice:
value: 10
unit: bps
downStreamDelayBudget:
value: 12
unit: Milliseconds
upStreamDelayBudget:
value: 12
unit: Milliseconds
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
SLICE_CREATED_EVENT_CIRCLE:
value:
id: "83a0d986-0866-4f38-b8c0-fc65bfcda452"
source: "https://notificationSendServer12.example.com"
specversion: "1.0"
type: "org.camaraproject.network-slice-booking.v0.status-changed"
datacontenttype: "application/json"
time: "2024-06-01T12:00:00Z"
data:
serviceTime:
startDate: "2024-06-01T12:00:00Z"
endDate: "2024-06-02T12:00:00Z"
serviceArea:
areaType: CIRCLE
center:
latitude: 45.754114
longitude: 4.860374
radius: 800
sliceQosProfile:
maxNumOfDevices: 5
downStreamRatePerDevice:
value: 10
unit: bps
upStreamRatePerDevice:
value: 10
unit: bps
downStreamDelayBudget:
value: 12
unit: Milliseconds
upStreamDelayBudget:
value: 12
unit: Milliseconds
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
SLICE_CREATED_EVENT_POLYGON:
value:
id: "83a0d986-0866-4f38-b8c0-fc65bfcda452"
source: "https://notificationSendServer12.example.com"
specversion: "1.0"
type: "org.camaraproject.network-slice-booking.v0.status-changed"
datacontenttype: "application/json"
time: "2024-06-01T12:00:00Z"
data:
serviceTime:
startDate: "2024-06-01T12:00:00Z"
endDate: "2024-06-02T12:00:00Z"
serviceArea:
areaType: POLYGON
boundary:
- latitude: 45.754114
longitude: 4.860374
- latitude: 45.753845
longitude: 4.863185
- latitude: 45.753916
longitude: 4.866531
- latitude: 45.754116
longitude: 4.876353
sliceQosProfile:
maxNumOfDevices: 5
downStreamRatePerDevice:
value: 10
unit: bps
upStreamRatePerDevice:
value: 10
unit: bps
downStreamDelayBudget:
value: 12
unit: Milliseconds
upStreamDelayBudget:
value: 12
unit: Milliseconds
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|