Skip to content

docs(api-reference): regenerate API docs (automated) - #1575

Merged
ppiegaze merged 1 commit into
mainfrom
docsy/api-ref-refresh-auto
Sep 4, 2026
Merged

docs(api-reference): regenerate API docs (automated)#1575
ppiegaze merged 1 commit into
mainfrom
docsy/api-ref-refresh-auto

Conversation

@unionai-docsy-bot

@unionai-docsy-bot unionai-docsy-bot Bot commented Sep 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Automated API-reference regeneration

Regenerated the generated API reference against the latest PyPI releases via the build pipeline (make update-api-docs). No hand-authored content.

Triggered by: repository_dispatch.

Drift detected

  flyte: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-core: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-claude: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-crewai: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-deepagents: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-google: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-hermes: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-langchain: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-langgraph: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-mistral: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-openai: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-agents-pydantic-ai: committed=2.5.18 latest=2.7.0 [OUTDATED]
  flyteplugins-bigquery: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-codegen: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-dask: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-databricks: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-huggingface: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-hydra: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-jsonl: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-mlflow: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-omegaconf: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-papermill: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-polars: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-pytorch: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-ray: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-sglang: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-spark: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-union: committed=0.8.3 latest=0.10.0 [OUTDATED]
  flyteplugins-vllm: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-wandb: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyteplugins-snowflake: committed=2.6.13 latest=2.7.0 [OUTDATED]
  flyte-cli: committed=2.6.13 latest=2.7.0 [OUTDATED]

Produced by docsy's API-docs automation (Option 2 / DOC-1044) — the CI complement to /docsy --refresh-api. Left as a draft for human review (agent proposes; human disposes).

If this PR's checks are not running, the docsy-bot App isn't configured yet — set the DOCSY_BOT_APP_ID + DOCSY_BOT_PRIVATE_KEY repo secrets (PRs opened by GITHUB_TOKEN do not trigger workflows).

API surface delta: material

This regen changes the public API surface, not just version strings. docsy will assess whether narrative docs (user guide, how-tos) that cite these symbols need updating: process-sources picks up the docsy:api-surface-delta label, opens a scoped ticket, and runs assess-docs-impact.

Changed public symbols (seed for the narrative-impact assessment):

add_dependency()
clone_with()
container_args()
container_cmd()
container_command()
dedupe_key()
first_failure()
from_app_name()
from_function()
get_port()
on_event()
on_shutdown()
on_startup()
resolve()
server()
Detection detail 
symbol pages added / removed / renamed:
A	content/api-reference/flyte-sdk/flyte.app/subdomain.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks.testing/_index.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks.testing/providerfactory.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/_index.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/eventtype.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/provider.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/runonceresult.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/signatureerror.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/webhookappenvironment.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/webhookevent.md
A	content/api-reference/flyte-sdk/flyte.extras.webhooks/webhookpluginerror.md

non-version content changed in existing pages

@unionai-docsy-bot unionai-docsy-bot Bot added api-docs-regen docsy:api-surface-delta Regen changed the public API surface; docsy opens a narrative-impact ticket labels Sep 3, 2026
@github-actions

github-actions Bot commented Sep 3, 2026 •
edited
Loading

Copy link
Copy Markdown

GHA build & deploy preview

Built by .github/workflows/build-pr.yml and deployed to the docs CF Pages project by .github/workflows/deploy-pr-preview.yml.
Branch alias https://pr-1575-docsy-api-ref-refres.docs-dog.pages.dev
This commit https://01e9d387.docs-dog.pages.dev
Commit SHA f4d4b96c303e187240256bcadeb3ae9a4a6a59bb

Updated automatically on every push.

@unionai-docsy-bot
unionai-docsy-bot Bot force-pushed the docsy/api-ref-refresh-auto branch from 365d8e8 to d4fa818 Compare September 4, 2026 00:52
@unionai-docsy-bot
docs(api-reference): regenerate API docs (automated)
f4d4b96 
Signed-off-by: unionai-docsy-bot[bot] <295918299+unionai-docsy-bot[bot]@users.noreply.github.com>
@unionai-docsy-bot
unionai-docsy-bot Bot force-pushed the docsy/api-ref-refresh-auto branch from d4fa818 to f4d4b96 Compare September 4, 2026 13:14
@ppiegaze
ppiegaze marked this pull request as ready for review September 4, 2026 14:39
Copilot AI lite review requested due to automatic review settings September 4, 2026 14:39
@ppiegaze
ppiegaze merged commit 7b42009 into main Sep 4, 2026
16 checks passed
@ppiegaze
ppiegaze deleted the docsy/api-ref-refresh-auto branch September 4, 2026 14:40
Copilot AI reviewed Sep 4, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The regenerated webhooks documentation contains inconsistent/incorrect Python/module references (and one invalid snippet) that should be corrected to avoid confusing users.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Automated regeneration of the Flyte/Union API reference content to align the docs site with the latest published SDK/plugin releases, including updated version pins/manifests and newly generated API pages.

Changes:

  • Bump docs “stable” version pin to v2.7.0.0 and adjust the enumerated/retired version lists.
  • Regenerate API reference pages and the Flyte SDK linkmap for Flyte 2.7.0 (including newly documented flyte.extras.webhooks and flyte.app.Subdomain).
  • Update the version manifest and API reference frontmatter versions (e.g. flyteplugins-union to 0.10.0, Flyte CLI to 2.7.0), reflecting the new generated surface.
File summaries
File Description
versions.toml Promotes stable docs pin to v2.7.0.0 and retires an older enumerated pin to manage build/deploy file-count limits.
data/version-manifest.json Updates the published docs/sdk version metadata and variant component SHAs for the regenerated build.
linkmap/flytesdk-linkmap.json Refreshes autolink targets to match the regenerated Flyte SDK API surface (new modules/symbols added).
content/api-reference/union-plugin/_index.md Bumps Union plugin docs version to 0.10.0 to match regenerated plugin API docs.
content/api-reference/flyte-cli.md Regenerates Flyte CLI docs for 2.7.0, including new/updated commands and semantics.
content/api-reference/flyte-sdk/_index.md Updates the Flyte SDK landing/index page to 2.7.0 and includes newly generated module/function entries.
content/api-reference/flyte-sdk/flyte.app/domain.md Regenerated Flyte app domain docs (now referencing Subdomain support in subdomain).
content/api-reference/flyte-sdk/flyte.extras.webhooks/_index.md Newly generated webhooks module documentation and examples.
content/api-reference/flyte-sdk/flyte.extras.webhooks/** Newly generated webhooks API pages (classes, errors, helpers) introduced in Flyte 2.7.0.
content/api-reference/flyte-sdk/flyte.extras.webhooks.testing/** Newly generated conformance harness docs for provider plugins.
content/api-reference/** (other regenerated API pages shown in diff) Bulk version-frontmatter bumps and regenerated API reference content across integrations and SDK modules for 2.7.0.
Review details

Suppressed comments (1)

content/api-reference/flyte-sdk/flyte.app/domain.md:28

  • The parameter type table uses flyte.app._types.Subdomain, which is an internal path. Consider switching it to the public flyte.app.Subdomain alias to match the rest of the docs.
  • Files reviewed: 300/326 changed files
  • Comments generated: 4
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread content/api-reference/flyte-sdk/flyte.app/domain.md
```python
class Domain(
subdomain: typing.Optional[str] = None,
subdomain: typing.Union[str, flyte.app._types.Subdomain, NoneType] = None,
Comment thread content/api-reference/flyte-sdk/flyte.extras.webhooks.testing/_index.md

Conformance harness — enforce the common provider format.

Every `flyteplugins.webhooks.<product>` plugin ships a one-line test:
Comment thread content/api-reference/flyte-sdk/flyte.extras.webhooks.testing/providerfactory.md


```python
protocol ProviderFactory()
Comment thread content/api-reference/flyte-sdk/flyte.extras.webhooks/webhookappenvironment.md

| Parameter | Type | Description |
|-|-|-|
| `event_type` | `str` | The event to match. Prefer the typed constants in `flyteplugins.webhooks.events` — `events.github.PullRequest.OPENED` for one action, `events.github.PullRequest.ANY` for every action on that type. Raw strings still work, which is the escape hatch for events the constants do not cover yet. An empty string matches every event from every configured provider. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@EngHabu EngHabu Awaiting requested review from EngHabu EngHabu is a code owner
@ppiegaze ppiegaze Awaiting requested review from ppiegaze ppiegaze is a code owner
@cosmicBboy cosmicBboy Awaiting requested review from cosmicBboy cosmicBboy is a code owner
@kumare3 kumare3 Awaiting requested review from kumare3 kumare3 is a code owner
@samhita-alla samhita-alla Awaiting requested review from samhita-alla samhita-alla is a code owner

Assignees

No one assigned

Labels

api-docs-regen docsy:api-surface-delta Regen changed the public API surface; docsy opens a narrative-impact ticket

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ppiegaze