Frontend module · STATIC DECLARATIONS

Product Knowledge Api client API reference · mansoq-hmis-web

7 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 7 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/inventory/productKnowledge/productKnowledgeApi.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.listProductKnowledge	GET	`/api/v1/product_knowledge/`	literal
default.retrieveProductKnowledge	GET	`/api/v1/product_knowledge/{slug}/`	literal
default.createProductKnowledge	POST	`/api/v1/product_knowledge/`	literal
default.updateProductKnowledge	PUT	`/api/v1/product_knowledge/{slug}/`	literal
default.addFavorite	POST	`/api/v1/product_knowledge/{slug}/add_favorite/`	literal
default.removeFavorite	POST	`/api/v1/product_knowledge/{slug}/remove_favorite/`	literal
default.listFavorites	GET	`/api/v1/product_knowledge/`	literal

default.listProductKnowledge

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

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

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

PaginatedResponse declared fields:

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

ProductKnowledgeBase declared fields:

Field	Type	Required	Description
id	string	true	—
slug	string	true	—
alternate_identifier	string	false	—
product_type	ProductKnowledgeType	true	—
status	ProductKnowledgeStatus	true	—
code	Code	false	—
name	string	true	—
names	ProductName[]	true	—
storage_guidelines	StorageGuideline[]	true	—
definitional	ProductDefinition	false	—
base_unit	Code	true	—
category	ResourceCategoryRead	true	—
slug_config	SlugConfig	true	—
is_instance_level	boolean	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.retrieveProductKnowledge

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

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

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

default.createProductKnowledge

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

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

ProductKnowledgeCreate declared fields:

Field	Type	Required	Description
slug_value	string	true	—
facility	string	true	—
category	string	true	—

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

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

default.updateProductKnowledge

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

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

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

ProductKnowledgeUpdate declared fields:

Field	Type	Required	Description
slug_value	string	true	—
facility	string	true	—
category	string	true	—

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

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

default.addFavorite

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

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

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

default.removeFavorite

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

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

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

default.listFavorites

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

response type: ProductKnowledgeBase[]. client-side declaration; not proof of accepted server payload.

Pinned source evidence

Links require access to the private source repository.