Metadata API

Manage product metadata — maintenance status, criticality, and sensitivity classifications.

These endpoints operate directly on product or field resources and require the corresponding edit or view permission via the @authorize decorator.

Endpoints Overview

Method	Endpoint	Description
PATCH	/products/{product_id}/maintenance-status	Update maintenance status
GET	/products/{product_id}/maintenance-history	Get status change history
PATCH	/products/{product_id}/criticality	Update criticality
PATCH	/products/{product_id}/sensitivity	Update product sensitivity
PATCH	/fields/{field_id}/sensitivity	Update field sensitivity

---

Maintenance Status

Update Status

PATCH /products/{product_id}/maintenance-status

Requires: Product edit permission

Query Parameters

Parameter	Type	Required	Description
new_status	string	✅	Target status
reason	string	—	Optional reason for the change

Valid Statuses

Value	Description
undocumented	No maintenance status assigned
not_actively_maintained	Not under active maintenance
actively_maintained	Under active maintenance
internal_use_only	Restricted to internal use
planned_deprecation	Scheduled for deprecation
deprecated	No longer supported

---

Get History

GET /products/{product_id}/maintenance-history

Requires: Product view permission

Returns a chronological list of maintenance status changes.

Response

[
  {
    "id": "uuid",
    "product_id": "uuid",
    "old_status": "undocumented",
    "new_status": "actively_maintained",
    "changed_by_id": "uuid",
    "reason": "Initial classification",
    "changed_at": "2026-02-10T10:00:00Z"
  }
]

---

Criticality

Update Criticality

PATCH /products/{product_id}/criticality

Requires: Product edit permission

Query Parameters

Parameter	Type	Required	Description
criticality	string	✅	New criticality level (e.g., Critical, High, Medium, Low)

Returns the updated product.

---

Sensitivity

Update Product Sensitivity

PATCH /products/{product_id}/sensitivity

Requires: Product edit permission

Query Parameters

Parameter	Type	Required	Description
sensitivity	string	✅	New sensitivity classification

Returns the updated product.

---

Update Field Sensitivity

PATCH /fields/{field_id}/sensitivity

Requires: Field edit permission

Query Parameters

Parameter	Type	Required	Description
sensitivity	string	✅	New sensitivity classification

Returns the updated field. Returns 404 if the field is not found.