1Background
Context the reader needs before the substance. Reference related documents by number — for example TSANET-2026-001 — and link them directly, since every document in this library is a page rather than a file.
Related
Use this block for pointers out: the API guidance, a connector page, or another document. Cross-linking is what stops the library becoming a pile of PDFs with numbers on them.
2Specification
The normative content. Use callouts for the constraints implementers actually miss, rather than for emphasis in general — a page where everything is highlighted highlights nothing.
Note
Neutral context worth pulling out of the flow: a convention, a default, something easy to overlook but not dangerous.
Constraint
Something that will bite. State the behaviour, then the consequence: save the
token from case creation — it is the primary key for every later operation, and an integration that loses it has orphaned the case.
2.1 Example request
POST /v1/collaboration-requests
Authorization: Bearer {token}
Accept: application/json, application/problem+json
Content-Type: application/json
{
"testSubmission": true,
"priority": "MEDIUM",
"problemSummary": "Example collaboration request"
}
2.2 Parameter reference
| Field | Required | Notes |
|---|---|---|
testSubmission | No | Use true in development; suppresses SLA timers and partner notifications. Note you write testSubmission and read testCase. |
priority | Yes | LOW, MEDIUM or HIGH. Members running four-level severity scales need a mapping in both directions. |
3Diagrams
Inline SVG, using the shared primitives from hub.css — .bx and .bx-ext and .bx-acc and .bx-grn for boxes, .ln and .lnA for edges, .tt and .ts and .tl for text. Using the classes rather than literal colours keeps every figure on the hub consistent, and means a brand change lands everywhere at once.
4Revision history
| Version | Date | Change |
|---|---|---|
| 0.1 | 2026-08-15 | Initial draft from template. |