Frontend module · STATIC DECLARATIONS

File Api client API reference · mansoq-hmis-web

6 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 6 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/files/fileApi.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.create	POST	`/api/v1/files/`	literal
default.list	GET	`/api/v1/files/`	literal
default.get	GET	`/api/v1/files/{fileId}/`	literal
default.update	PUT	`/api/v1/files/{fileId}/`	literal
default.markUploadCompleted	POST	`/api/v1/files/{fileId}/mark_upload_completed/`	literal
default.archive	POST	`/api/v1/files/{fileId}/archive/`	literal

default.create

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

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

FileCreate declared fields:

Field	Type	Required	Description
original_name	string	true	—

Composed/inherited schema references: FileBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

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

FileRead declared fields:

Field	Type	Required	Description
signed_url	string	true	—
read_signed_url	string	true	—
internal_name	string	true	—

Composed/inherited schema references: FileReadMinimal. Exact generic composition is retained in the structured reference and requires server-side confirmation.

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.list

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

Declared default query fields: ordering (string). These are defaults observed at this route object, not an exhaustive query allowlist.

response type: PaginatedResponse<FileReadMinimal>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field	Type	Required	Description
count	number	true	—
results	TItem[]	true	—

FileReadMinimal declared fields:

Field	Type	Required	Description
id	string	true	—
archived_by	UserReadMinimal	true	—
archived_datetime	string	true	—
upload_completed	boolean	true	—
is_archived	boolean	false	—
archive_reason	string	false	—
created_date	string	true	—
uploaded_by	UserReadMinimal	true	—
extension	string	true	—

Composed/inherited schema references: FileBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

default.get

GET /api/v1/files/{fileId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: fileId. Transport strings are declared here; semantic identifier types require the server contract.

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

default.update

PUT /api/v1/files/{fileId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: fileId. Transport strings are declared here; semantic identifier types require the server contract.

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

FileUpdate declared fields:

Field	Type	Required	Description
id	string	true	—
name	string	true	—

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

default.markUploadCompleted

POST /api/v1/files/{fileId}/mark_upload_completed/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: fileId. Transport strings are declared here; semantic identifier types require the server contract.

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

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

default.archive

POST /api/v1/files/{fileId}/archive/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: fileId. Transport strings are declared here; semantic identifier types require the server contract.

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

default.archive.request declared fields:

Field	Type	Required	Description
archive_reason	string	true	—

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

Pinned source evidence

Links require access to the private source repository.