From 526074e409a038a51a4ccebf6a5cbe1d74ac0e89 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Fri, 22 Nov 2024 14:22:09 -0500 Subject: [PATCH] settings and docs updates bc docstring changes precommit --- docs/v3/api-ref/rest-api/server/schema.json | 345 +++++++++++------- docs/v3/develop/settings-ref.mdx | 2 +- schemas/settings.schema.json | 2 +- .../prefect_azure/blob_storage.py | 1 + .../prefect_gcp/workers/cloud_run_v2.py | 2 +- .../prefect_kubernetes/utilities.py | 2 +- src/prefect/cache_policies.py | 1 + src/prefect/server/events/actions.py | 5 +- src/prefect/settings/models/tasks.py | 2 +- src/prefect/testing/utilities.py | 9 +- 10 files changed, 230 insertions(+), 141 deletions(-) diff --git a/docs/v3/api-ref/rest-api/server/schema.json b/docs/v3/api-ref/rest-api/server/schema.json index 13571d0144d9..103e2ee4328d 100644 --- a/docs/v3/api-ref/rest-api/server/schema.json +++ b/docs/v3/api-ref/rest-api/server/schema.json @@ -9049,9 +9049,6 @@ "additionalProperties": { "type": "integer" }, - "propertyNames": { - "format": "uuid" - }, "title": "Response Count Deployments By Flow Ui Flows Count Deployments Post" } } @@ -9117,9 +9114,6 @@ } ] }, - "propertyNames": { - "format": "uuid" - }, "title": "Response Next Runs By Flow Ui Flows Next Runs Post" } } @@ -9234,9 +9228,6 @@ "additionalProperties": { "type": "integer" }, - "propertyNames": { - "format": "uuid" - }, "title": "Response Count Task Runs By Flow Run Ui Flow Runs Count Task Runs Post" } } @@ -9813,7 +9804,7 @@ "type": "null" } ], - "title": "Metadata", + "title": "Metadata ", "description": "User-defined artifact metadata. Content must be string key and value pairs." }, "flow_run_id": { @@ -9937,7 +9928,7 @@ "type": "null" } ], - "title": "Metadata", + "title": "Metadata ", "description": "User-defined artifact metadata. Content must be string key and value pairs." }, "flow_run_id": { @@ -10057,7 +10048,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run IDs to include" } }, @@ -10080,7 +10071,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of artifact keys to include" }, "like_": { @@ -10092,7 +10083,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.", "examples": [ "my-artifact-%" @@ -10107,7 +10098,7 @@ "type": "null" } ], - "title": "Exists", + "title": "Exists ", "description": "If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key. Should return all rows in the ArtifactCollection table if specified." } }, @@ -10131,7 +10122,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of artifact ids to include" } }, @@ -10155,7 +10146,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run IDs to include" } }, @@ -10178,7 +10169,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of artifact types to include" }, "not_any_": { @@ -10193,7 +10184,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of artifact types to exclude" } }, @@ -10277,7 +10268,7 @@ "type": "null" } ], - "title": "Metadata", + "title": "Metadata ", "description": "User-defined artifact metadata. Content must be string key and value pairs." }, "flow_run_id": { @@ -10395,7 +10386,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run IDs to include" } }, @@ -10419,7 +10410,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of artifact ids to include" } }, @@ -10442,7 +10433,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of artifact keys to include" }, "like_": { @@ -10454,7 +10445,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.", "examples": [ "my-artifact-%" @@ -10469,7 +10460,7 @@ "type": "null" } ], - "title": "Exists", + "title": "Exists ", "description": "If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key." } }, @@ -10493,7 +10484,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run IDs to include" } }, @@ -10516,7 +10507,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of artifact types to include" }, "not_any_": { @@ -10531,7 +10522,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of artifact types to exclude" } }, @@ -10589,7 +10580,7 @@ "type": "null" } ], - "title": "Metadata" + "title": "Metadata " } }, "additionalProperties": false, @@ -11113,7 +11104,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include automations created before this datetime" } }, @@ -11136,7 +11127,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "Only include automations with names that match any of these strings" } }, @@ -11624,7 +11615,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of block type ids to include" } }, @@ -11648,7 +11639,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of block ids to include" } }, @@ -11668,7 +11659,7 @@ "type": "null" } ], - "title": "Eq", + "title": "Eq ", "description": "Filter block documents for only those that are or are not anonymous." } }, @@ -11691,7 +11682,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of block names to include" }, "like_": { @@ -11703,7 +11694,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A string to match block names against. This can include SQL wildcard characters like `%` and `_`.", "examples": [ "my-block%" @@ -11952,7 +11943,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of block type ids to include" } }, @@ -11975,7 +11966,7 @@ "type": "null" } ], - "title": "All", + "title": "All ", "description": "A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.", "examples": [ [ @@ -12005,7 +11996,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of IDs to include" } }, @@ -12028,7 +12019,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of block schema versions.", "examples": [ [ @@ -12260,7 +12251,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": [ "marvin" @@ -12286,7 +12277,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of slugs to match" } }, @@ -14298,6 +14289,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "call-webhook" + ], "const": "call-webhook", "title": "Type", "default": "call-webhook" @@ -14326,6 +14320,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "cancel-flow-run" + ], "const": "cancel-flow-run", "title": "Type", "default": "cancel-flow-run" @@ -14339,6 +14336,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "change-flow-run-state" + ], "const": "change-flow-run-state", "title": "Type", "default": "change-flow-run-state" @@ -14383,6 +14383,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "compound" + ], "const": "compound", "title": "Type", "default": "compound" @@ -14450,6 +14453,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "compound" + ], "const": "compound", "title": "Type", "default": "compound" @@ -14831,6 +14837,9 @@ "properties": { "input_type": { "type": "string", + "enum": [ + "constant" + ], "const": "constant", "title": "Input Type", "default": "constant" @@ -15501,7 +15510,7 @@ "type": "null" } ], - "title": "Ge", + "title": "Ge ", "description": "Only include deployments with a concurrency limit greater than or equal to this value" }, "le_": { @@ -15513,7 +15522,7 @@ "type": "null" } ], - "title": "Le", + "title": "Le ", "description": "Only include deployments with a concurrency limit less than or equal to this value" }, "is_null_": { @@ -15525,7 +15534,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include deployments without a concurrency limit" } }, @@ -15549,7 +15558,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of deployment ids to include" } }, @@ -15572,7 +15581,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of deployment names to include", "examples": [ [ @@ -15590,7 +15599,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": [ "marvin" @@ -15613,7 +15622,7 @@ "type": "null" } ], - "title": "Eq", + "title": "Eq ", "description": "Only returns where deployment is/is not paused" } }, @@ -15641,7 +15650,7 @@ "type": "null" } ], - "title": "All", + "title": "All ", "description": "A list of tags. Deployments will be returned only if their tags are a superset of the list", "examples": [ [ @@ -15659,7 +15668,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include deployments without tags" } }, @@ -15682,7 +15691,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work queue names to include", "examples": [ [ @@ -15831,7 +15840,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names." } }, @@ -16597,6 +16606,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "do-nothing" + ], "const": "do-nothing", "title": "Type", "default": "do-nothing" @@ -16968,7 +16980,9 @@ "next_page": { "anyOf": [ { - "type": "string" + "type": "string", + "minLength": 1, + "format": "uri" }, { "type": "null" @@ -17118,6 +17132,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "event" + ], "const": "event", "title": "Type", "default": "event" @@ -17429,7 +17446,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include flows without deployments" } }, @@ -17453,7 +17470,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow ids to include" } }, @@ -17476,7 +17493,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow names to include", "examples": [ [ @@ -17494,7 +17511,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": [ "marvin" @@ -17525,7 +17542,7 @@ "type": "null" } ], - "title": "All", + "title": "All ", "description": "A list of tags. Flows will be returned only if their tags are a superset of the list", "examples": [ [ @@ -17543,7 +17560,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include flows without tags" } }, @@ -18323,7 +18340,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run deployment ids to include" }, "is_null_": { @@ -18335,7 +18352,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include flow runs without deployment ids" } }, @@ -18356,7 +18373,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include flow runs ending at or before this time" }, "after_": { @@ -18369,7 +18386,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include flow runs ending at or after this time" }, "is_null_": { @@ -18381,7 +18398,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only return flow runs without an end time" } }, @@ -18402,7 +18419,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include flow runs scheduled to start at or before this time" }, "after_": { @@ -18415,7 +18432,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include flow runs scheduled to start at or after this time" } }, @@ -18438,7 +18455,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run flow_versions to include" } }, @@ -18462,7 +18479,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run ids to include" }, "not_any_": { @@ -18478,7 +18495,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of flow run ids to exclude" } }, @@ -18501,7 +18518,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run idempotency keys to include" }, "not_any_": { @@ -18516,7 +18533,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of flow run idempotency keys to exclude" } }, @@ -18539,7 +18556,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run names to include", "examples": [ [ @@ -18557,7 +18574,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": [ "marvin" @@ -18581,7 +18598,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include flow runs with a next_scheduled_start_time or before this time" }, "after_": { @@ -18594,7 +18611,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include flow runs with a next_scheduled_start_time at or after this time" } }, @@ -18623,7 +18640,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of parent flow run ids to include" } }, @@ -18652,7 +18669,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run parent_task_run_ids to include" }, "is_null_": { @@ -18664,7 +18681,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include flow runs without parent_task_run_id" } }, @@ -18685,7 +18702,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include flow runs starting at or before this time" }, "after_": { @@ -18698,7 +18715,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include flow runs starting at or after this time" }, "is_null_": { @@ -18710,7 +18727,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only return flow runs without a start time" } }, @@ -18768,7 +18785,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run state names to include" }, "not_any_": { @@ -18783,7 +18800,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of flow run state names to exclude" } }, @@ -18806,7 +18823,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run state types to include" }, "not_any_": { @@ -18821,7 +18838,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of flow run state types to exclude" } }, @@ -18849,7 +18866,7 @@ "type": "null" } ], - "title": "All", + "title": "All ", "description": "A list of tags. Flow runs will be returned only if their tags are a superset of the list", "examples": [ [ @@ -18870,7 +18887,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of tags to include", "examples": [ [ @@ -18888,7 +18905,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include flow runs without tags" } }, @@ -18916,7 +18933,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work queue names to include", "examples": [ [ @@ -18934,7 +18951,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include flow runs without work queue names" } }, @@ -19184,7 +19201,7 @@ "type": "null" } ], - "title": "Eq", + "title": "Eq ", "description": "Filter notification policies for only those that are or are not active." } }, @@ -20471,7 +20488,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of flow run IDs to include" } }, @@ -20491,7 +20508,7 @@ "type": "null" } ], - "title": "Ge", + "title": "Ge ", "description": "Include logs with a level greater than or equal to this level", "examples": [ 20 @@ -20506,7 +20523,7 @@ "type": "null" } ], - "title": "Le", + "title": "Le ", "description": "Include logs with a level less than or equal to this level", "examples": [ 50 @@ -20533,7 +20550,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run IDs to include" }, "is_null_": { @@ -20545,7 +20562,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include logs without a task run id" } }, @@ -20566,7 +20583,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include logs with a timestamp at or before this time" }, "after_": { @@ -20579,7 +20596,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include logs with a timestamp at or after this time" } }, @@ -20759,6 +20776,9 @@ "properties": { "input_type": { "type": "string", + "enum": [ + "parameter" + ], "const": "parameter", "title": "Input Type", "default": "parameter" @@ -20779,6 +20799,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "pause-automation" + ], "const": "pause-automation", "title": "Type", "default": "pause-automation" @@ -20815,6 +20838,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "pause-deployment" + ], "const": "pause-deployment", "title": "Type", "default": "pause-deployment" @@ -20851,6 +20877,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "pause-work-pool" + ], "const": "pause-work-pool", "title": "Type", "default": "pause-work-pool" @@ -20887,6 +20916,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "pause-work-queue" + ], "const": "pause-work-queue", "title": "Type", "default": "pause-work-queue" @@ -21092,6 +21124,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "resume-automation" + ], "const": "resume-automation", "title": "Type", "default": "resume-automation" @@ -21128,6 +21163,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "resume-deployment" + ], "const": "resume-deployment", "title": "Type", "default": "resume-deployment" @@ -21164,6 +21202,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "resume-flow-run" + ], "const": "resume-flow-run", "title": "Type", "default": "resume-flow-run" @@ -21171,12 +21212,15 @@ }, "type": "object", "title": "ResumeFlowRun", - "description": "Resumes a paused or suspended flow run associated with the trigger" + "description": "Resumes a paused or suspended flow run associated with the trigger.\nAdded in version 3.0.2." }, "ResumeWorkPool": { "properties": { "type": { "type": "string", + "enum": [ + "resume-work-pool" + ], "const": "resume-work-pool", "title": "Type", "default": "resume-work-pool" @@ -21213,6 +21257,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "resume-work-queue" + ], "const": "resume-work-queue", "title": "Type", "default": "resume-work-queue" @@ -21249,6 +21296,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "run-deployment" + ], "const": "run-deployment", "title": "Type", "default": "run-deployment" @@ -21423,6 +21473,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "send-notification" + ], "const": "send-notification", "title": "Type", "default": "send-notification" @@ -21456,6 +21509,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "sequence" + ], "const": "sequence", "title": "Type", "default": "sequence" @@ -21507,6 +21563,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "sequence" + ], "const": "sequence", "title": "Type", "default": "sequence" @@ -21565,7 +21624,10 @@ "title": "SetStateStatus", "description": "Enumerates return statuses for setting run states." }, - "Settings": {}, + "Settings": { + "title": "Settings", + "description": "Settings for Prefect using Pydantic settings.\n\nSee https://docs.pydantic.dev/latest/concepts/pydantic_settings" + }, "SimpleFlowRun": { "properties": { "id": { @@ -21716,6 +21778,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "abort_details" + ], "const": "abort_details", "title": "Type", "description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.", @@ -21742,6 +21807,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "accept_details" + ], "const": "accept_details", "title": "Type", "description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.", @@ -21991,6 +22059,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "reject_details" + ], "const": "reject_details", "title": "Type", "description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.", @@ -22033,6 +22104,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "wait_details" + ], "const": "wait_details", "title": "Type", "description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.", @@ -22067,6 +22141,9 @@ "properties": { "type": { "type": "string", + "enum": [ + "suspend-flow-run" + ], "const": "suspend-flow-run", "title": "Type", "default": "suspend-flow-run" @@ -22385,7 +22462,8 @@ "description": "An ORM representation of task run data." }, "TaskRunCount": { - "type": "object" + "type": "object", + "title": "TaskRunCount" }, "TaskRunCreate": { "properties": { @@ -22675,7 +22753,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include task runs expected to start at or before this time" }, "after_": { @@ -22688,7 +22766,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include task runs expected to start at or after this time" } }, @@ -22717,7 +22795,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run flow run ids to include" }, "is_null_": { @@ -22729,7 +22807,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "Filter for task runs with None as their flow run id", "default": false } @@ -22754,7 +22832,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run ids to include" } }, @@ -22777,7 +22855,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run names to include", "examples": [ [ @@ -22795,7 +22873,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": [ "marvin" @@ -22819,7 +22897,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include task runs starting at or before this time" }, "after_": { @@ -22832,7 +22910,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include task runs starting at or after this time" }, "is_null_": { @@ -22844,7 +22922,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only return task runs without a start time" } }, @@ -22902,7 +22980,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run state names to include" } }, @@ -22925,7 +23003,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of task run state types to include" } }, @@ -22945,7 +23023,7 @@ "type": "null" } ], - "title": "Exists", + "title": "Exists ", "description": "If true, only include task runs that are subflow run parents; if false, exclude parent task runs" } }, @@ -22973,7 +23051,7 @@ "type": "null" } ], - "title": "All", + "title": "All ", "description": "A list of tags. Task runs will be returned only if their tags are a superset of the list", "examples": [ [ @@ -22991,7 +23069,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include task runs without tags" } }, @@ -23067,6 +23145,9 @@ "properties": { "input_type": { "type": "string", + "enum": [ + "task_run" + ], "const": "task_run", "title": "Input Type", "default": "task_run" @@ -23463,7 +23544,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of variable ids to include" } }, @@ -23486,7 +23567,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of variables names to include" }, "like_": { @@ -23498,7 +23579,7 @@ "type": "null" } ], - "title": "Like", + "title": "Like ", "description": "A string to match variable names against. This can include SQL wildcard characters like `%` and `_`.", "examples": [ "my_variable_%" @@ -23529,7 +23610,7 @@ "type": "null" } ], - "title": "All", + "title": "All ", "description": "A list of tags. Variables will be returned only if their tags are a superset of the list", "examples": [ [ @@ -23547,7 +23628,7 @@ "type": "null" } ], - "title": "Is Null", + "title": "Is Null ", "description": "If true, only include Variables without tags" } }, @@ -23874,7 +23955,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work pool ids to include" } }, @@ -23897,7 +23978,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work pool names to include" } }, @@ -23920,7 +24001,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work pool types to include" } }, @@ -24238,7 +24319,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work queue ids to include" } }, @@ -24261,7 +24342,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of work queue names to include", "examples": [ [ @@ -24282,7 +24363,7 @@ "type": "null" } ], - "title": "Startswith", + "title": "Startswith ", "description": "A list of case-insensitive starts-with matches. For example, passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.", "examples": [ [ @@ -24652,7 +24733,7 @@ "type": "null" } ], - "title": "Before", + "title": "Before ", "description": "Only include processes whose last heartbeat was at or before this time" }, "after_": { @@ -24665,7 +24746,7 @@ "type": "null" } ], - "title": "After", + "title": "After ", "description": "Only include processes whose last heartbeat was at or after this time" } }, @@ -24688,7 +24769,7 @@ "type": "null" } ], - "title": "Any", + "title": "Any ", "description": "A list of worker statuses to include" }, "not_any_": { @@ -24703,7 +24784,7 @@ "type": "null" } ], - "title": "Not Any", + "title": "Not Any ", "description": "A list of worker statuses to exclude" } }, diff --git a/docs/v3/develop/settings-ref.mdx b/docs/v3/develop/settings-ref.mdx index 40f29b21b662..78541abff9c3 100644 --- a/docs/v3/develop/settings-ref.mdx +++ b/docs/v3/develop/settings-ref.mdx @@ -2138,7 +2138,7 @@ The directory to serve static files from. This should be used when running into --- ## TasksRunnerSettings ### `thread_pool_max_workers` -The maximum number of workers for ThreadPoolTaskRunner. +The maximum number of workers for ThreadPoolTaskRunner. Added in version 3.0.11. **Type**: `integer | None` diff --git a/schemas/settings.schema.json b/schemas/settings.schema.json index 46ab12535ef7..8a2747cd073b 100644 --- a/schemas/settings.schema.json +++ b/schemas/settings.schema.json @@ -1882,7 +1882,7 @@ } ], "default": null, - "description": "The maximum number of workers for ThreadPoolTaskRunner.", + "description": "The maximum number of workers for ThreadPoolTaskRunner. Added in version 3.0.11.", "supported_environment_variables": [ "PREFECT_TASKS_RUNNER_THREAD_POOL_MAX_WORKERS", "PREFECT_TASK_RUNNER_THREAD_POOL_MAX_WORKERS" diff --git a/src/integrations/prefect-azure/prefect_azure/blob_storage.py b/src/integrations/prefect-azure/prefect_azure/blob_storage.py index 6f3c348762d1..4476666b0adc 100644 --- a/src/integrations/prefect-azure/prefect_azure/blob_storage.py +++ b/src/integrations/prefect-azure/prefect_azure/blob_storage.py @@ -718,6 +718,7 @@ async def write_path(self, path: str, content: bytes) -> None: async def list_blobs(self) -> List[str]: """ Lists blobs available within the specified Azure container. + Added in version 0.4.1. Used to introspect your containers. diff --git a/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py b/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py index 0d3b6989378a..e2258c6dbb81 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py +++ b/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py @@ -215,7 +215,7 @@ def _populate_env(self): def _configure_cloudsql_volumes(self): """ - Populates volumes and volume mounts for cloudsql instances + Populates volumes and volume mounts for cloudsql instances. Added in version 0.6.2. """ if not self.cloudsql_instances: diff --git a/src/integrations/prefect-kubernetes/prefect_kubernetes/utilities.py b/src/integrations/prefect-kubernetes/prefect_kubernetes/utilities.py index 3d936de50587..c478301ccb46 100644 --- a/src/integrations/prefect-kubernetes/prefect_kubernetes/utilities.py +++ b/src/integrations/prefect-kubernetes/prefect_kubernetes/utilities.py @@ -20,7 +20,7 @@ class KeepAliveClientRequest(ClientRequest): """ aiohttp only directly implements socket keepalive for incoming connections in its RequestHandler. For client connections, we need to set the keepalive - ourselves. + ourselves. Added in version 0.5.1. Refer to https://github.com/aio-libs/aiohttp/issues/3904#issuecomment-759205696 """ diff --git a/src/prefect/cache_policies.py b/src/prefect/cache_policies.py index 50717e5ceaea..2c1096eebe01 100644 --- a/src/prefect/cache_policies.py +++ b/src/prefect/cache_policies.py @@ -49,6 +49,7 @@ def configure( ) -> Self: """ Configure the cache policy with the given key storage, lock manager, and isolation level. + Added in version 3.0.3. Args: key_storage: The storage to use for cache keys. If not provided, diff --git a/src/prefect/server/events/actions.py b/src/prefect/server/events/actions.py index 1c28df35577e..32518d6a32a4 100644 --- a/src/prefect/server/events/actions.py +++ b/src/prefect/server/events/actions.py @@ -1088,7 +1088,10 @@ async def new_state(self, triggered_action: "TriggeredAction") -> StateCreate: class ResumeFlowRun(FlowRunAction): - """Resumes a paused or suspended flow run associated with the trigger""" + """ + Resumes a paused or suspended flow run associated with the trigger. + Added in version 3.0.2. + """ type: Literal["resume-flow-run"] = "resume-flow-run" diff --git a/src/prefect/settings/models/tasks.py b/src/prefect/settings/models/tasks.py index 86b8e20e08ba..1d1822b0ebcd 100644 --- a/src/prefect/settings/models/tasks.py +++ b/src/prefect/settings/models/tasks.py @@ -11,7 +11,7 @@ class TasksRunnerSettings(PrefectBaseSettings): thread_pool_max_workers: Optional[int] = Field( default=None, gt=0, - description="The maximum number of workers for ThreadPoolTaskRunner.", + description="The maximum number of workers for ThreadPoolTaskRunner. Added in version 3.0.11.", validation_alias=AliasChoices( AliasPath("thread_pool_max_workers"), "prefect_tasks_runner_thread_pool_max_workers", diff --git a/src/prefect/testing/utilities.py b/src/prefect/testing/utilities.py index d73cb66f0adf..5412f984e1f6 100644 --- a/src/prefect/testing/utilities.py +++ b/src/prefect/testing/utilities.py @@ -116,6 +116,7 @@ def prefect_test_harness(server_startup_timeout: Optional[int] = 30): server_startup_timeout: The maximum time to wait for the server to start. Defaults to 30 seconds. If set to `None`, the value of `PREFECT_SERVER_EPHEMERAL_STARTUP_TIMEOUT_SECONDS` will be used. + Added in version 3.0.2. Examples: >>> from prefect import flow @@ -155,9 +156,11 @@ def cleanup_temp_dir(temp_dir): # start a subprocess server to test against test_server = SubprocessASGIServer() test_server.start( - timeout=server_startup_timeout - if server_startup_timeout is not None - else prefect.settings.PREFECT_SERVER_EPHEMERAL_STARTUP_TIMEOUT_SECONDS.value() + timeout=( + server_startup_timeout + if server_startup_timeout is not None + else prefect.settings.PREFECT_SERVER_EPHEMERAL_STARTUP_TIMEOUT_SECONDS.value() + ) ) stack.enter_context( prefect.settings.temporary_settings(