← Technical API reference

Frontend module · STATIC DECLARATIONS

Otp Api client API reference · mansoq-hmis-web

2 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Client contract scope

These 2 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/otp/otpApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
default.send POST /api/v1/otp/send/ literal
default.login POST /api/v1/otp/login/ literal

default.send

POST /api/v1/otp/send/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: SendOtpRequest. client-side declaration; not proof of accepted server payload.

SendOtpRequest declared fields:

Field Type Required Description
phone_number string true —

response type: SendOtpResponse. client-side declaration; not proof of accepted server payload.

SendOtpResponse declared fields:

Field Type Required Description
otp string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.login

POST /api/v1/otp/login/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: LoginByOtpRequest. client-side declaration; not proof of accepted server payload.

LoginByOtpRequest declared fields:

Field Type Required Description
phone_number string true —
otp string true —

response type: LoginByOtpResponse. client-side declaration; not proof of accepted server payload.

LoginByOtpResponse declared fields:

Field Type Required Description
access string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.