Create Term

Register a new technical term in the glossary.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Usage

Create a term

curl -X POST https://tech-terms-api-production.up.railway.app/terms \
  -H "Content-Type: application/json" \
  -d '{
    "id": 42,
    "term": "Tree Shaking",
    "definition": "The elimination of dead code from a JavaScript bundle at build time.",
    "category": "frontend",
    "see_also": [101]
  }'

Response (201 Created):

{
  "id": 42,
  "term": "Tree Shaking",
  "definition": "The elimination of dead code from a JavaScript bundle at build time.",
  "category": "frontend",
  "see_also": [101]
}

Field Reference

FieldTypeRequiredDescription
idintegerYesA unique numeric identifier you supply. See note below.
termstringYesThe canonical name of the technical concept.
definitionstringYesA concise, technical explanation of the term.
categorystringYesOne of: frontend, backend, devops, docs-as-code
see_alsointeger[]NoIDs of related glossary entries. Relationships are one-way.

Note on id: IDs are client-supplied. The API does not auto-increment or enforce uniqueness — submitting a duplicate ID will create a duplicate entry. Auto-increment IDs are planned for a future release.

Note on persistence: Created terms are saved to a terms.json file on the server and survive restarts. However, the production server runs on Railway, which uses an ephemeral filesystem — terms will be lost if the server is redeployed.

Error Response (422 Unprocessable Entity)

Returned when the request body is missing required fields or contains invalid values:

{
  "detail": [
    {
      "loc": ["body", "category"],
      "msg": "value is not a valid enumeration member; permitted: 'frontend', 'backend', 'devops', 'docs-as-code'",
      "type": "type_error.enum",
      "input": "cloud"
    }
  ]
}
Body Params
integer
required
string
required

The canonical name of the technical concept.

string
required

A concise, technical explanation of the term.

string
enum
required
Allowed:
array | null

IDs of related glossary entries.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json