Skip to content

Fix152&165 - #166

Merged
bigludo7 merged 5 commits into
mainfrom
Fix152&165
Oct 1, 2026
Merged

bigludo7 merged 5 commits into
mainfrom
Fix152&165

Conversation

@bigludo7

@bigludo7 bigludo7 commented Sep 26, 2026 •

Copy link
Copy Markdown
Collaborator

What type of PR is this?

Add one of the following kinds:

  • cleanup

What this PR does / why we need it:

  • Remove redundant documentation/API_documentation/OTP_SMS_API.md document
  • rename 429 class to avoid 'generic' use

Which issue(s) this PR fixes:

Fixes #152, fixes #165

Special notes for reviewers:

Changelog input

 release-note
- Remove redundant documentation in the md document
- rename 429 class to avoid 'generic' use

Additional documentation

This section can be blank.

docs

Updated version and commonalities in the API definition. Adjusted server URL and refined response references.
Updated API version from v0 to v2 and modified endpoint descriptions. Moved authentication & documentation  details to YAML file.
@camara-validation

camara-validation Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

CAMARA Validation — PASS

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

View full results

@bigludo7
bigludo7 requested a review from hdamker September 26, 2026 15:49
@hdamker

hdamker commented Sep 26, 2026

Copy link
Copy Markdown
Contributor

There is not much left of documentation/API_documentation/OTP_SMS_API.md ... any reason to keep these few lines? Or would it be enough to mention in CHANGELOG that the obsolete file was removed, and the documentation is now in the YAML?

@hdamker

hdamker commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Additional comments after a closer look:

  • Local 429 examples: per the r4.4 Design Guide response template, the examples of OneTimePasswordSMS429 can reference the shared ones (../common/CAMARA_common.yaml#/components/examples/GENERIC_429_QUOTA_EXCEEDED and GENERIC_429_TOO_MANY_REQUESTS) instead of inline copies. Not blocking.
  • OTP_SMS_API.md: the endpoint list now hardcodes /v2/ while main is vwip, the same kind of drift reported in OTP_SMS_API.md documentation out of sync with API definition #152. If the file is kept, dropping the versioned endpoint list avoids this. I would still recommend to drop the file completely.
  • Issue linking: Fixes #152 #165 only links the first issue. Please use Fixes #152, fixes #165 so both close on merge. In general it would be better to do the fixes in two PRs with concrete PR titles, which makes the CHANGELOG generation easier.

@bigludo7

Copy link
Copy Markdown
Collaborator Author

@hdamker Yes I was also thinking that this documentation/API_documentation/OTP_SMS_API.md is useless. I remove it !

Replaced inline examples with references to common examples in CAMARA_common.yaml.
@bigludo7

Copy link
Copy Markdown
Collaborator Author

@hdamker all fixed :)

@fernandopradocabrillo fernandopradocabrillo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM
Thanks @bigludo7

@bigludo7
bigludo7 merged commit da68f85 into main Oct 1, 2026
3 checks passed
@bigludo7
bigludo7 deleted the Fix152&165 branch October 1, 2026 16:48
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.

Incomplete r4.4 realignment: Generic429 response retained OTP_SMS_API.md documentation out of sync with API definition

3 participants