Skip to content

OTP_SMS_API.md documentation out of sync with API definition #152

Description

@hdamker

Problem description

documentation/API_documentation/OTP_SMS_API.md has not been updated alongside the API definition and now contradicts it in several places:

  • the endpoint tables and curl snippets use the base path /one-time-password-sms/v0/, while the API definition uses v2rc1 (v2 at public release)
  • section 4.1 "API Version" states 0.1.0, while the API version is 2.0.0-rc.1
  • section 4.3 lists 404 NOT_FOUND, which no longer exists — sendCode returns 404 IDENTIFIER_NOT_FOUND and validateCode has its own scoped 404 response
  • section 4.3 lists 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 415 UNSUPPORTED_MEDIA_TYPE, 500 INTERNAL, 503 UNAVAILABLE and 504 TIMEOUT as API errors, none of which the API definition documents
  • section 4.3 does not list the 400 error codes added for request body strictness

Expected action

Update the document on main so that base path, API version and error codes match code/API_definitions/one-time-password-sms.yaml. Alternatively, consider reducing it to the parts that add value beyond info.description and the OpenAPI file, since the API Readiness Checklist treats info.description as the primary API documentation.

Additional context

Found during the Release Management review of the r4.1 rc release PR #150. The drift predates r4.1 — the document already stated v0 while the released API was v1 — so it is not a regression from this release cycle, but it should be corrected before the public release of one-time-password-sms 2.0.0.

Activity

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions