Skip to content

QoS B: update of request parameter for serviceArea #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Masa8106 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

QoS B: update of request parameter for serviceArea #87

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55ee817
Add AreaID schema
Masa8106 Apr 16, 2026
37f66fb
Linting error correction
Masa8106 Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions code/API_definitions/qos-booking.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,7 @@ components:
mapping:
CIRCLE: "#/components/schemas/Circle"
POLYGON: "#/components/schemas/Polygon"
AREAID: "#/components/schemas/AreaId"
AREANAME: "#/components/schemas/AreaName"

AreaType:
Expand All @@ -750,10 +751,12 @@ components:
Type of this area.
CIRCLE - The area is defined as a circle.
POLYGON - The area is defined as a polygon.
AREAID - The area is defined as an area ID.

@jlurien jlurien Apr 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently AREANAME already supports any kind of string values and it it is not limited to human friendly names. What is the benefit of having a separated AREAID for areas identified by UUIDs?

I would wait to have a more clear understanding of the Area discovery mechanisms and the possibility to have a transversal common Area APIs, and if that is the case we may refer explicitly to the equivalence of these fields in the other API.

@Masa8106 Masa8106 Apr 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. In my understanding, the benefit of a AREAID is to guarantee uniqueness from technical perspective.
I think it is better to keep discussion on it also with those who proposed the common Area API.

@jlurien jlurien Jul 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this one to draft until we have a clear understanding of the new Area API, wdyt?

@Masa8106 Masa8106 Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is not for Sync26. So it is ok for me to move it to draft.

AREANAME - The area is defined as an area name.
enum:
- CIRCLE
- POLYGON
- AREAID
- AREANAME

Circle:
Expand Down Expand Up @@ -782,6 +785,17 @@ components:
properties:
boundary:
$ref: "#/components/schemas/PointList"
AreaId:
description: The area is defined as an area ID.
allOf:
- $ref: "#/components/schemas/Area"
- type: object
required:
- areaId
properties:
areaId:
type: string
format: uuid

AreaName:
description: The value of "AreaName" might be predefined and only regional or even an operator-specific in this API version. As a prerequisite, the API Provider may offer API Consumer the "AreaName" values, which API consumer can request, in a preparation phase. And then API Consumers can select from the "AreaNames" as Service Areas.
Expand Down
Loading