Skip to content

Fix/use common schemas#123

Merged
tlohmar merged 2 commits into
camaraproject:mainfrom
jimfengjinhua:fix/use-common-schemas
Jun 22, 2026
Merged

Fix/use common schemas#123
tlohmar merged 2 commits into
camaraproject:mainfrom
jimfengjinhua:fix/use-common-schemas

Conversation

@jimfengjinhua

@jimfengjinhua jimfengjinhua commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature
  • cleanup

What this PR does / why we need it:

To replace local common data type definitions with direct $ref to CAMARA_common.yaml. Remove all local definitions of XCorrelator, ErrorInfo, Device, Area, Point, and x-correlator header/parameter that duplicate CAMARA_common.yaml schemas. All references point directly to ../common/CAMARA_common.yaml.

Note: The dedicated-network-areas.yaml is now using the common data type Area, which consequently introduced an API contract change for Circle.radius:

Type Maximum
Original (local) integer 200000
New (common Area) number none

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

Changelog input

Replacing local common data type definitions with direct $ref to CAMARA_common.yaml. Remove all unused local definitions.
In dedicated-network-areas.yaml, Circle.radius has been changed from type integer (with maximum as 200000) to type number (without max limitation).

Additional documentation:


@jimfengjinhua jimfengjinhua force-pushed the fix/use-common-schemas branch from 70a67e6 to 8a442d9 Compare June 15, 2026 09:03
@hdamker hdamker requested review from hdamker and removed request for a team June 15, 2026 10:30
@hdamker

hdamker commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

@jimfengjinhua I removed @camaraproject/release-management_reviewers from the reviewer list as this is not a Release Review PR and volunteered myself to review.

@hdamker

hdamker commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

The changes are looking good, one point which need an explicit documentation within the PR description (and later in CHANGELOG):

dedicated-network-areas.yaml:181 now points service-area request/response shapes at common Area, but the removed local Circle.radius contract was integer with maximum: 200000; common Circle.radius is number with no max. That is a real API contract change for an RC API, not just de-duplication.

@jimfengjinhua

Copy link
Copy Markdown
Contributor Author

The changes are looking good, one point which need an explicit documentation within the PR description (and later in CHANGELOG):

dedicated-network-areas.yaml:181 now points service-area request/response shapes at common Area, but the removed local Circle.radius contract was integer with maximum: 200000; common Circle.radius is number with no max. That is a real API contract change for an RC API, not just de-duplication.

@hdamker thanks for your prompt review and comment. I have updated PR with the API contract change explicitly described, as well as in 'Changelog input' accordingly

…AMARA_common.yaml

Remove all local definitions of XCorrelator, ErrorInfo, Device, Area, Point,
and x-correlator header/parameter that duplicate CAMARA_common.yaml schemas.
All references now point directly to ../common/CAMARA_common.yaml.
@jimfengjinhua jimfengjinhua force-pushed the fix/use-common-schemas branch from 8a442d9 to fe9e233 Compare June 17, 2026 12:22
tlohmar
tlohmar previously approved these changes Jun 22, 2026

@tlohmar tlohmar left a comment

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.

Looks good.

Removing X-Total-Count and Content-Last-Key headers, which should not be added.

@tlohmar tlohmar left a comment

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.

Looks now ok

@tlohmar tlohmar merged commit 8ee3289 into camaraproject:main Jun 22, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants