Skip to content

Align with Commonalities r4.4 - #55

Open
maheshc01 wants to merge 3 commits into
mainfrom
fix/align-commonalities-r4.4
Open

Align with Commonalities r4.4#55
maheshc01 wants to merge 3 commits into
mainfrom
fix/align-commonalities-r4.4

Conversation

@maheshc01

@maheshc01 maheshc01 commented Oct 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • correction
  • documentation
  • tests

What this PR does / why we need it:

Aligns the API with Commonalities r4.4 for the r2.2 release candidate.

  • 400, 401, 403 and 404 now reference the r4.4 catalogue responses, so the API no longer inherits codes it can't return (OUT_OF_RANGE, INVALID_TOKEN_CONTEXT, IDENTIFIER_NOT_FOUND)
  • 429 is defined locally with QUOTA_EXCEEDED and TOO_MANY_REQUESTS, same as Application Endpoint Discovery
  • Added an Errors section describing when each error is returned
  • Rewrote the Introduction to explain how registered endpoints are used with Application Endpoint Discovery
  • Port and ipv6Address now use the common schemas
  • Updated the mandatory info.description sections from the r4.4 templates
  • Removed the "Further info and support" section, which was copied from Sim Swap and doesn't apply to this API
  • Fixed externalDocs description and operationId casing in the description
  • Test definitions extended to cover all five operations and every documented error code (8 to 22 scenarios)

Which issue(s) this PR fixes:

Fixes #46
Fixes #47

Special notes for reviewers:

Next step after merge is the r2.2 snapshot.

Changelog input

 release-note
Aligned with Commonalities r4.4 error responses and templates; documented error conditions and use cases; extended test definitions

Additional documentation

docs

@maheshc01
Align with Commonalities r4.4
cdb7a8a 
- Use r4.4 catalogue responses for 400/401/403/404, local 429
- Document error conditions and use cases (#46, #47)
- Use common Port and SingleIpv6Address
- Update mandatory description text from r4.4 templates
- Remove unrelated Mobile Connect section, fix externalDocs text
- Extend test definitions to cover all operations and error codes
@camara-validation

camara-validation Bot commented Oct 4, 2026 •
edited
Loading

Copy link
Copy Markdown

CAMARA Validation — PASS

0 errors, 0 warnings, 0 hints | Profile: standard

View full results

This was referenced Oct 4, 2026
Open
Open
Kevsy
Kevsy approved these changes Oct 5, 2026
View reviewed changes

@Kevsy Kevsy 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.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Kevsy Kevsy Kevsy approved these changes
@gunjald gunjald Awaiting requested review from gunjald gunjald is a code owner
@FabrizioMoggio FabrizioMoggio Awaiting requested review from FabrizioMoggio FabrizioMoggio is a code owner
@seralogar seralogar Awaiting requested review from seralogar seralogar is a code owner
@JoseMConde JoseMConde Awaiting requested review from JoseMConde JoseMConde is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve use case documentation Review and fix documented error response codes

2 participants

@maheshc01 @Kevsy