TechnoteStatus

pydantic model technote.config.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": {
         "description": "The state of a document, from a controlled vocabulary.",
         "allOf": [
            {
               "$ref": "#/definitions/TechnoteState"
            }
         ]
      },
      "note": {
         "title": "Note",
         "description": "An explanation of the state.",
         "type": "string"
      },
      "supersceding_urls": {
         "title": "Supersceding Urls",
         "description": "URLs to documents/webpages that superscede this technote.",
         "type": "array",
         "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2083,
            "format": "uri"
         }
      }
   },
   "required": [
      "state"
   ],
   "definitions": {
      "TechnoteState": {
         "title": "TechnoteState",
         "description": "Standardized states for a technote.\n\n    .. mermaid::\n\n       flowchart LR\n         planning --> active\n         active --> stable\n         stable --> active\n         stable --> deprecated\n         active --> deprecated\n    ",
         "enum": [
            "planning",
            "active",
            "stable",
            "deprecated",
            "other"
         ],
         "type": "string"
      }
   }
}

Fields:

• note (Optional[str])

• state (technote.config.TechnoteState)

• supersceding_urls (List[pydantic.networks.HttpUrl])

field note: Optional[str] = None

An explanation of the state.

field state: TechnoteState [Required]

The state of a document, from a controlled vocabulary.

field supersceding_urls: List[HttpUrl] [Optional]

URLs to documents/webpages that superscede this technote.