Initial API proposal for QoD Booking API #379
Conversation
Create qod-booking.yaml
Masa8106
requested review from
hdamker,
eric-murray,
RandyLevensalor and
jlurien
as code owners
There was a problem hiding this comment.
Some initial comments for basic aspects. We have to decide if this would be a new API withing the current repo or it is moved to a new one.
Going into other details we will have to define relevant errors for this API, for example to control limits in startTime, duration, area, etc
| - $ref: "#/components/schemas/BaseBookingInfo" | ||
| - type: object | ||
| properties: | ||
| statrTime: |
There was a problem hiding this comment.
| statrTime: | |
| startTime: |
| format: date-time | ||
| example: "2024-06-01T12:00:00Z" | ||
| duration: | ||
| description: |
There was a problem hiding this comment.
For a CreateBooking request, duration is just what the client is requesting, regardless the qosStatus. -We should adapt this description
| description: Attributes to request a new QoD Booking | ||
| allOf: | ||
| - $ref: "#/components/schemas/BaseBookingInfo" | ||
| - type: object |
There was a problem hiding this comment.
To create a booking, at least startTime must be required, probably also duration (unless we set a default but I think it makes more sense to eb required). area may be optional but we should define the expectancy when it is not provided
| example: 3600 | ||
| serviceArea: | ||
| $ref: "#/components/schemas/Area" | ||
| BookingId: |
There was a problem hiding this comment.
| BookingId: | |
| bookingId: |
| statusInfo: | ||
| $ref: "#/components/schemas/StatusInfo" | ||
| required: | ||
| - BookingId |
There was a problem hiding this comment.
| - BookingId | |
| - bookingId |
| $ref: "#/components/schemas/Status" | ||
| statusInfo: | ||
| $ref: "#/components/schemas/StatusInfo" | ||
| required: |
There was a problem hiding this comment.
In the response, other properties must be required: startTime, duration . startedAt has no sense in the response to CreateBooking but it is relevant for GET.
|
@jlurien, Thank you for the initial comments. |
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
This is the initial proposal from KDDI for the QoD Booking API
Which issue(s) this PR fixes:
Fixes #337
Special notes for reviewers:
None
Changelog input
Additional documentation
None