DocLink

pydantic model phalanx.models.applications.DocLink

A documentation link for an application.

This represents an individual array item in the phalanx.lsst.io/docs Helm chart annotation in Chart.yaml.

Parameters:

• url (str)

• title (str)

• id (str | None, default: None)

Show JSON schema

{
   "title": "DocLink",
   "description": "A documentation link for an application.\n\nThis represents an individual array item in the ``phalanx.lsst.io/docs``\nHelm chart annotation in :file:`Chart.yaml`.",
   "type": "object",
   "properties": {
      "url": {
         "title": "Url",
         "type": "string"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      }
   },
   "required": [
      "url",
      "title"
   ]
}

Fields:

• id (str | None)

• title (str)

• url (str)

field id: str | None = None

Identifier of the document.

field title: str [Required]

Title of the document.

field url: str [Required]

URL to the document.

to_rst()

Format as a reStructuredText link.

Return type:

str