Index#

pydantic model controller.models.index.Index#

Metadata returned by the external root URL of the application.

Notes

As written, this is not very useful. Add additional metadata that will be helpful for a user exploring the application, or replace this model with some other model that makes more sense to return from the application API root.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "Index",
   "description": "Metadata returned by the external root URL of the application.\n\nNotes\n-----\nAs written, this is not very useful. Add additional metadata that will be\nhelpful for a user exploring the application, or replace this model with\nsome other model that makes more sense to return from the application API\nroot.",
   "type": "object",
   "properties": {
      "metadata": {
         "allOf": [
            {
               "$ref": "#/$defs/Metadata"
            }
         ],
         "title": "Package metadata"
      }
   },
   "$defs": {
      "Metadata": {
         "description": "Metadata about a package.",
         "properties": {
            "name": {
               "examples": [
                  "myapp"
               ],
               "title": "Application name",
               "type": "string"
            },
            "version": {
               "examples": [
                  "1.0.0"
               ],
               "title": "Version",
               "type": "string"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "examples": [
                  "Some package description"
               ],
               "title": "Description"
            },
            "repository_url": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "examples": [
                  "https://example.com/"
               ],
               "title": "Repository URL"
            },
            "documentation_url": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "examples": [
                  "https://example.com/"
               ],
               "title": "Documentation URL"
            }
         },
         "required": [
            "name",
            "version"
         ],
         "title": "Metadata",
         "type": "object"
      }
   },
   "required": [
      "metadata"
   ]
}

Fields:
field metadata: Metadata [Required]#