TechnoteStatus

pydantic model technote.sources.tomlsettings.TechnoteStatus

A model for the technote’s status.

Status is intended to describe whether a document is in planning, active writing, stable, or deprecated/supersceded stages of its lifecycle. It’s not intended for fine-grained status, such as describing a work ticket that’s in progress or in review.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "TechnoteStatus",
   "description": "A model for the technote's status.\n\nStatus is intended to describe whether a document is in planning,\nactive writing, stable, or deprecated/supersceded stages of its lifecycle.\nIt's not intended for fine-grained status, such as describing a work ticket\nthat's in progress or in review.",
   "type": "object",
   "properties": {
      "state": {
         "allOf": [
            {
               "$ref": "#/$defs/TechnoteState"
            }
         ],
         "description": "The state of a document, from a controlled vocabulary."
      },
      "note": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "An explanation of the state.",
         "title": "Note"
      },
      "supersceding_urls": {
         "description": "URLs to documents/webpages that superscede this technote.",
         "items": {
            "$ref": "#/$defs/Link"
         },
         "title": "Supersceding Urls",
         "type": "array"
      }
   },
   "$defs": {
      "Link": {
         "description": "A model for a web link.",
         "properties": {
            "url": {
               "description": "The URL of the link.",
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "title": "Url",
               "type": "string"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The title of the link, if available.",
               "title": "Title"
            }
         },
         "required": [
            "url"
         ],
         "title": "Link",
         "type": "object"
      },
      "TechnoteState": {
         "description": "Standardized states for a technote.\n\n.. mermaid::\n\n   flowchart LR\n     draft --> stable\n     stable --> draft\n     stable --> deprecated\n     draft --> deprecated",
         "enum": [
            "draft",
            "stable",
            "deprecated",
            "other"
         ],
         "title": "TechnoteState",
         "type": "string"
      }
   },
   "required": [
      "state"
   ]
}

Fields:

• note (str | None)

• state (technote.metadata.model.TechnoteState)

• supersceding_urls (list[technote.sources.tomlsettings.Link])

field note: str | None = None

An explanation of the state.

field state: TechnoteState [Required]

The state of a document, from a controlled vocabulary.

field supersceding_urls: list[Link] [Optional]

URLs to documents/webpages that superscede this technote.