LicenseTable

pydantic model technote.config.LicenseTable

A model for [technote.license] in technote.toml, which describes the content’s license.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "LicenseTable",
   "description": "A model for ``[technote.license]`` in ``technote.toml``, which\ndescribes the content's license.",
   "type": "object",
   "properties": {
      "id": {
         "description": "The SPDX license ID. See https://spdx.org/licenses/.",
         "examples": [
            "CC-BY-SA-4.0"
         ],
         "title": "Id",
         "type": "string"
      }
   },
   "required": [
      "id"
   ]
}

Fields:

• id (str)

Validators:

• validate_spdx_id » id

field id: str [Required]

The SPDX license ID. See https://spdx.org/licenses/.

Validated by:

• validate_spdx_id

validator validate_spdx_id  »  id

Ensure that id is a SPDX license identifier.

Parameters:

v (str) –

Return type:

str