maestro.api.api package

maestro.api.api.dateformat(input: datetime) → str

Show datetime as 2024-05-29 07:29:26

maestro.api.api.now() → str

maestro.api.api.template_filter(func: T) → T

maestro.api.api.template_function(func: T) → T

Subpackages

• maestro.api.api.v1 package
  • Submodules
  • maestro.api.api.v1.api module
    • home()
  • maestro.api.api.v1.cancel module
    • cancel_job_endpoint()
  • maestro.api.api.v1.health module
    • health_check()
  • maestro.api.api.v1.invalidate module
    • get_invalidation_count()
    • invalidate_artefact()
    • invalidate_workflow()
    • invalidate_workflow_step()
    • valid_node_exists()
  • maestro.api.api.v1.reorder module
    • reorder_job_endpoint()
  • maestro.api.api.v1.resume module
    • resume_halted_job_endpoint()

Submodules

maestro.api.api.config module

pydantic settings maestro.api.api.config.Settings

Bases: BaseSettings

Show JSON schema

{
   "title": "Settings",
   "type": "object",
   "properties": {
      "API_STR": {
         "default": "/api/v1",
         "title": "Api Str",
         "type": "string"
      },
      "PROJECT_NAME": {
         "default": "Maestro API",
         "title": "Project Name",
         "type": "string"
      },
      "PROJECT_URI": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "http://localhost/",
         "title": "Project Uri"
      },
      "UI_URI": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "http://localhost/",
         "title": "Ui Uri"
      },
      "CORS_ORIGIN": {
         "default": [
            "a",
            "o",
            "/",
            "h",
            ":",
            "l",
            "c",
            "t",
            "s",
            "p"
         ],
         "items": {
            "type": "string"
         },
         "title": "Cors Origin",
         "type": "array",
         "uniqueItems": true
      }
   },
   "additionalProperties": false
}

Config:

• env_file_encoding: str = utf-8

Fields:

• API_STR (str)

• CORS_ORIGIN (set[str])

• PROJECT_NAME (str)

• PROJECT_URI (pydantic.networks.AnyHttpUrl | None)

• UI_URI (pydantic.networks.AnyHttpUrl | None)

field API_STR: str = '/api/v1'

field CORS_ORIGIN: set[str] = {'/', ':', 'a', 'c', 'h', 'l', 'o', 'p', 's', 't'}

field PROJECT_NAME: str = 'Maestro API'

field PROJECT_URI: AnyHttpUrl | None = AnyHttpUrl('http://localhost/')

field UI_URI: AnyHttpUrl | None = AnyHttpUrl('http://localhost/')

maestro.api.api.config.settings(request: Request) → Settings