Skip to content

docs(openapi): Add missing descriptions to Update Actor endpoint#2731

Merged
szaganek merged 2 commits into
masterfrom
add-desc-to-update-actor-endpoint
Jul 7, 2026
Merged

docs(openapi): Add missing descriptions to Update Actor endpoint#2731
szaganek merged 2 commits into
masterfrom
add-desc-to-update-actor-endpoint

Conversation

@szaganek

@szaganek szaganek commented Jul 3, 2026

Copy link
Copy Markdown
Contributor
  • Adds missing descriptions to Create Actor request body.
  • Cleans up endpoint description.
  • Also fixes the Unknown type error in the preview.

Part of #2684.

@szaganek szaganek requested a review from a team July 3, 2026 12:02
@szaganek szaganek self-assigned this Jul 3, 2026
@szaganek szaganek added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Jul 3, 2026
@apify-service-account

apify-service-account commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@apify-service-account

Copy link
Copy Markdown
Contributor

Important

Action required@szaganek please coordinate this docs PR with the Python API client PR linked below.

Because this PR modifies the OpenAPI specification, the generated models in apify-client-python must be regenerated to stay in sync. This has already been done automatically:

A companion PR has been opened in apify-client-python with the regenerated models: apify/apify-client-python#919

  • Please make sure to review and merge both PRs together to keep the OpenAPI spec and API clients in sync.
  • You can ask for review and help from the Tooling team if needed.

@mixalturek mixalturek left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thanks a lot!

type: [string, "null"]
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$
examples: ["0.0"]
description: The version number of the Actor. Must be a dot-separated sequence of numbers.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Do I understand it correctly? Is it this?

Image
Suggested change
description: The version number of the Actor. Must be a dot-separated sequence of numbers.
description: The version number of the Actor. Must be a dot-separated sequence of two numbers which are the major and minor parts of major.minor.patch semantic versioning.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch, I clarified it in one more place.

@apify-service-account

Copy link
Copy Markdown
Contributor

Important

Action required@szaganek please coordinate this docs PR with the Python API client PR linked below.

Because this PR modifies the OpenAPI specification, the generated models in apify-client-python must be regenerated to stay in sync. This has already been done automatically:

The companion apify-client-python PR has been updated with the latest spec changes: apify/apify-client-python#919

  • Please make sure to review and merge both PRs together to keep the OpenAPI spec and API clients in sync.
  • You can ask for review and help from the Tooling team if needed.

@szaganek szaganek merged commit e3c11c1 into master Jul 7, 2026
16 checks passed
@szaganek szaganek deleted the add-desc-to-update-actor-endpoint branch July 7, 2026 10:08
vdusek pushed a commit to apify/apify-client-python that referenced this pull request Jul 7, 2026
- Updates the auto-generated Pydantic models and TypedDicts based on the
proposed OpenAPI specification changes.
- Based on apify-docs PR
[#2731](apify/apify-docs#2731).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants