Closed jawnsy closed 1 year ago
Interestingly, the builds in our private docs repo are working fine:
OpenAPI schema written to
/home/runner/work/docs/docs/prefect_source/docs/api-ref/schema.json
Newest release is 2.10.18. Version being built is unreleased.
Updating previous docs version with unreleased.
15:14:29.645 | WARNING | mkdocs.config - Config value 'plugins': Plugin 'material/social' option 'cards_color': Deprecated, use 'cards_layout_options.background_color' and 'cards_layout_options.color' with 'default' layout
INFO - DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html
File "/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/mike/mkdocs_plugin.py", line 6, in <module>
from pkg_resources import iter_entry_points
File "/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/pkg_resources/__init__.py", line 118, in <module>
warnings.warn(
INFO - DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('google')`.
Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages
File "/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/pkg_resources/__init__.py", line 2871, in activate
declare_namespace(pkg)
File "/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/pkg_resources/__init__.py", line 2339, in declare_namespace
warnings.warn(msg, DeprecationWarning, stacklevel=2)
WARNING - Config value 'plugins': Plugin 'material/social' option 'cards_color': Deprecated, use 'cards_layout_options.background_color' and 'cards_layout_options.color' with 'default' layout
INFO - Cleaning site directory
INFO - Building documentation to directory: /home/runner/work/docs/docs/docs/site
INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration:
- faq.md
- api-ref/prefect/packaging.md
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/artifacts.py:82: Confusing indentation for continuation line 7 in docstring, should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/artifacts.py:83: Confusing indentation for continuation line 8 in docstring, should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/artifacts.py:113: Confusing indentation for continuation line 6 in docstring, should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/artifacts.py:114: Confusing indentation for continuation line 7 in docstring, should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/artifacts.py:142: Confusing indentation for continuation line 6 in docstring, should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/artifacts.py:143: Confusing indentation for continuation line 7 in docstring, should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/context.py:106: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/context.py:468: No type or annotation for parameter 'override_environment_variable'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/context.py:468: Parameter 'override_environment_variable' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/context.py:476: No type or annotation for yielded value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/engine.py:1077: No type or annotation for parameter 'flow_run_id'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/flows.py:309: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/flows.py:681: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/flows.py:682: No type or annotation for returned value 2
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/settings.py:1835: No type or annotation for parameter 'include_keys'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/settings.py:1835: Parameter 'include_keys' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/task_runners.py:144: No type or annotation for parameter 'task_run'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/task_runners.py:144: Parameter 'task_run' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/task_runners.py:145: No type or annotation for parameter 'task_key'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/task_runners.py:145: Parameter 'task_key' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/task_runners.py:148: No type or annotation for parameter 'run_kwargs'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/task_runners.py:148: Parameter 'run_kwargs' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/tasks.py:371: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/tasks.py:1004: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/core.py:775: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/core.py:776: No type or annotation for returned value 2
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/client/orchestration.py:715: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/client/orchestration.py:748: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/client/orchestration.py:927: No type or annotation for parameter '**kwargs'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/client/orchestration.py:1302: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/client/orchestration.py:1340: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/client/orchestration.py:1376: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:254: No type or annotation for parameter 'name'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:254: Parameter 'name' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:255: No type or annotation for parameter 'version'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:255: Parameter 'version' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:256: No type or annotation for parameter 'description'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:256: Parameter 'description' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:258: No type or annotation for parameter 'tags'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:258: Parameter 'tags' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:261: No type or annotation for parameter 'schedule'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:261: Parameter 'schedule' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:262: No type or annotation for parameter 'is_schedule_active'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:262: Parameter 'is_schedule_active' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:263: No type or annotation for parameter 'work_queue_name'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:263: Parameter 'work_queue_name' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:264: No type or annotation for parameter 'flow_name'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:264: Parameter 'flow_name' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:265: No type or annotation for parameter 'parameters'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:265: Parameter 'parameters' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:267: No type or annotation for parameter 'infrastructure'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:267: Parameter 'infrastructure' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:270: No type or annotation for parameter 'infra_overrides'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:270: Parameter 'infra_overrides' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:273: No type or annotation for parameter 'storage'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:273: Parameter 'storage' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:276: No type or annotation for parameter 'path'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:276: Parameter 'path' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:278: No type or annotation for parameter 'entrypoint'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:278: Parameter 'entrypoint' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:280: No type or annotation for parameter 'parameter_openapi_schema'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:280: Parameter 'parameter_openapi_schema' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/deployments.py:777: No type or annotation for parameter '**kwargs'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/deployments/steps/utility.py:191: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/collections.py:390: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/hashing.py:42: No type or annotation for parameter 'hash_algo'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/hashing.py:24: No type or annotation for parameter 'hash_algo'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py:68: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py:198: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py:216: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py:321: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_run_states.py:26: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_run_states.py:44: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_runs.py:49: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_runs.py:157: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_runs.py:272: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flows.py:29: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flows.py:92: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flows.py:107: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flows.py:1[96](https://github.com/PrefectHQ/docs/actions/runs/5424382678/jobs/9863663171#step:10:97): No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flows.py:70: No type or annotation for returned value 'bool'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py:31: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py:71: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py:89: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py:110: No type or annotation for parameter 'limit(int)'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py:110: Parameter 'limit(int)' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py:113: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/task_run_states.py:26: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/task_run_states.py:44: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/task_runs.py:44: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/task_runs.py:130: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/task_runs.py:225: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:86: No type or annotation for parameter 'session'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:86: Parameter 'session' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:87: No type or annotation for parameter 'initial_state'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:87: Parameter 'initial_state' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:88: No type or annotation for parameter 'proposed_state'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:88: Parameter 'proposed_state' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:133: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:207: No type or annotation for parameter 'session'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:207: Parameter 'session' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:208: No type or annotation for parameter 'run'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:208: Parameter 'run' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:209: No type or annotation for parameter 'initial_state'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:209: Parameter 'initial_state' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:210: No type or annotation for parameter 'proposed_state'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:210: Parameter 'proposed_state' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:233: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:311: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:359: No type or annotation for parameter 'session'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:359: Parameter 'session' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:360: No type or annotation for parameter 'run'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:360: Parameter 'run' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:361: No type or annotation for parameter 'initial_state'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:361: Parameter 'initial_state' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:362: No type or annotation for parameter 'proposed_state'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:362: Parameter 'proposed_state' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:385: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:467: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:[97](https://github.com/PrefectHQ/docs/actions/runs/5424382678/jobs/9863663171#step:10:98)4: No type or annotation for parameter 'context'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/orchestration/rules.py:[98](https://github.com/PrefectHQ/docs/actions/runs/5424382678/jobs/9863663171#step:10:99)5: No type or annotation for parameter 'context'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/core.py:915: No type or annotation for parameter 'late_runs'
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/core.py:915: Parameter 'late_runs' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:218: Parameter 'cron' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:219: Parameter 'timezone' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:221: Parameter 'day_or' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:60: Parameter 'interval' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:61: Parameter 'anchor_date' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:63: Parameter 'timezone' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:383: Parameter 'rrule' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py:384: Parameter 'timezone' does not appear in the function signature
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/server.py:45: No type or annotation for returned value 1
WARNING - griffe: /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/server.py:46: No type or annotation for returned value 2
INFO - Downloading external file: https://cdn.amplitude.com/libs/analytics-browser-1.9.1-min.js.gz
WARNING - mkdocs_autorefs.plugin: api-ref/prefect/engine.md: Could not find cross-reference target '[prefect.client.schemas.objects.State]'
WARNING - mkdocs_autorefs.plugin: api-ref/prefect/client/orchestration.md: Could not find cross-reference target '[prefect.client.schemas.objects.Flow]'
WARNING - mkdocs_autorefs.plugin: api-ref/prefect/client/orchestration.md: Could not find cross-reference target '[prefect.client.schemas.objects.Deployment]'
INFO - Documentation built in 39.40 seconds
From a recent build: https://github.com/PrefectHQ/docs/actions/runs/5424382678/jobs/9863663171
Okay, so I was able to reproduce the problem locally. The failure seems to be related to a new FastAPI release.
FastAPI version 0.99.0 causes a failure and reverting to 0.98.0 fixes the doc build. I don’t know if this is related to the introduction of OpenAPI 3.1.0 support in this version.
$ prefect dev build-docs
Traceback (most recent call last):
File "/Users/jawnsy/projects/work/prefect/src/prefect/cli/_utilities.py", line 41, in wrapper
return fn(*args, **kwargs)
File "/Users/jawnsy/projects/work/prefect/src/prefect/cli/dev.py", line 125, in build_docs
schema = create_app(ephemeral=True).openapi()
File "/Users/jawnsy/projects/work/prefect/src/prefect/server/api/server.py", line 592, in openapi
partial_schema = get_openapi(
File "/opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages/fastapi/openapi/utils.py", line 466, in get_openapi
return jsonable_encoder(OpenAPI(**output), by_alias=True, exclude_none=True) # type: ignore
File "pydantic/main.py", line 341, in pydantic.main.BaseModel.__init__
pydantic.error_wrappers.ValidationError: 224 validation errors for OpenAPI
components -> schemas -> ArtifactCollectionFilter -> additionalProperties
value is not a valid dict (type=type_error.dict)
components -> schemas -> ArtifactCollectionFilter -> $ref
field required (type=value_error.missing)
components -> schemas -> ArtifactCollectionFilterFlowRunId -> additionalProperties
$ pip install fastapi==0.98.0
Collecting fastapi==0.98.0
Downloading fastapi-0.98.0-py3-none-any.whl (56 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 57.0/57.0 kB 2.3 MB/s eta 0:00:00
Requirement already satisfied: pydantic!=1.8,!=1.8.1,<2.0.0,>=1.7.4 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from fastapi==0.98.0) (1.10.10)
Requirement already satisfied: starlette<0.28.0,>=0.27.0 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from fastapi==0.98.0) (0.27.0)
Requirement already satisfied: typing-extensions>=4.2.0 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from pydantic!=1.8,!=1.8.1,<2.0.0,>=1.7.4->fastapi==0.98.0) (4.7.0)
Requirement already satisfied: anyio<5,>=3.4.0 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from starlette<0.28.0,>=0.27.0->fastapi==0.98.0) (3.7.0)
Requirement already satisfied: idna>=2.8 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from anyio<5,>=3.4.0->starlette<0.28.0,>=0.27.0->fastapi==0.98.0) (3.4)
Requirement already satisfied: sniffio>=1.1 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from anyio<5,>=3.4.0->starlette<0.28.0,>=0.27.0->fastapi==0.98.0) (1.3.0)
Requirement already satisfied: exceptiongroup in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from anyio<5,>=3.4.0->starlette<0.28.0,>=0.27.0->fastapi==0.98.0) (1.1.1)
Installing collected packages: fastapi
Attempting uninstall: fastapi
Found existing installation: fastapi 0.97.0
Uninstalling fastapi-0.97.0:
Successfully uninstalled fastapi-0.97.0
Successfully installed fastapi-0.98.0
$ prefect dev build-docs
OpenAPI schema written to /Users/jawnsy/projects/work/prefect/docs/api-ref/schema.json
$ pip install fastapi==0.99.0
Collecting fastapi==0.99.0
Using cached fastapi-0.99.0-py3-none-any.whl (58 kB)
Requirement already satisfied: pydantic!=1.8,!=1.8.1,<2.0.0,>=1.7.4 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from fastapi==0.99.0) (1.10.10)
Requirement already satisfied: starlette<0.28.0,>=0.27.0 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from fastapi==0.99.0) (0.27.0)
Requirement already satisfied: typing-extensions>=4.5.0 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from fastapi==0.99.0) (4.7.0)
Requirement already satisfied: anyio<5,>=3.4.0 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from starlette<0.28.0,>=0.27.0->fastapi==0.99.0) (3.7.0)
Requirement already satisfied: idna>=2.8 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from anyio<5,>=3.4.0->starlette<0.28.0,>=0.27.0->fastapi==0.99.0) (3.4)
Requirement already satisfied: sniffio>=1.1 in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from anyio<5,>=3.4.0->starlette<0.28.0,>=0.27.0->fastapi==0.99.0) (1.3.0)
Requirement already satisfied: exceptiongroup in /opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages (from anyio<5,>=3.4.0->starlette<0.28.0,>=0.27.0->fastapi==0.99.0) (1.1.1)
Installing collected packages: fastapi
Attempting uninstall: fastapi
Found existing installation: fastapi 0.98.0
Uninstalling fastapi-0.98.0:
Successfully uninstalled fastapi-0.98.0
Successfully installed fastapi-0.99.0
$ prefect dev build-docs
Traceback (most recent call last):
File "/Users/jawnsy/projects/work/prefect/src/prefect/cli/_utilities.py", line 41, in wrapper
return fn(*args, **kwargs)
File "/Users/jawnsy/projects/work/prefect/src/prefect/cli/dev.py", line 125, in build_docs
schema = create_app(ephemeral=True).openapi()
File "/Users/jawnsy/projects/work/prefect/src/prefect/server/api/server.py", line 592, in openapi
partial_schema = get_openapi(
File "/opt/homebrew/Caskroom/miniconda/base/envs/prefect2-dev/lib/python3.10/site-packages/fastapi/openapi/utils.py", line 466, in get_openapi
return jsonable_encoder(OpenAPI(**output), by_alias=True, exclude_none=True) # type: ignore
File "pydantic/main.py", line 341, in pydantic.main.BaseModel.__init__
pydantic.error_wrappers.ValidationError: 224 validation errors for OpenAPI
components -> schemas -> ArtifactCollectionFilter -> additionalProperties
value is not a valid dict (type=type_error.dict)
components -> schemas -> ArtifactCollectionFilter -> $ref
field required (type=value_error.missing)
components -> schemas -> ArtifactCollectionFilterFlowRunId -> additionalProperties
value is not a valid dict (type=type_error.dict)
components -> schemas -> ArtifactCollectionFilterFlowRunId -> $ref
field required (type=value_error.missing)
Possibly related to:
I created a discussion item with a minimal reproduction example here: OpenAPI validation errors after upgrading from FastAPI 0.98.0 to 0.99.0
It looks like FastAPI resolved the issue.
Thank you for the thorough report! It's greatly appreciated!
I fixed it at https://github.com/tiangolo/fastapi/pull/9781, you can read there for more details if you want to know > what happened.
This fix is available in FastAPI 0.99.1, just released. 🎉
Once we get mkdocs build working, this should be resolved. The latest FastAPI version installed in a dev build on my machine is 0.100.0
Closing as 2.10.20 docs (latest) has all API doc builds working.
First check
Description
Our docs builds started failing after the merge of #10098, but the changes appear unrelated to the breakage. It seems likely that one of the libraries used to generate documentation had a change in behavior that caused this, so we just got unlucky with timing.
The build has the following stack trace:
Impact
Docs will not update until this is resolved
Additional context
No response