Skip to content

docs(openapi): Add missing descriptions to Actor object#2685

Merged
szaganek merged 6 commits into
masterfrom
docs-create-actor-endpoint
Jun 24, 2026
Merged

docs(openapi): Add missing descriptions to Actor object#2685
szaganek merged 6 commits into
masterfrom
docs-create-actor-endpoint

Conversation

@szaganek

@szaganek szaganek commented Jun 24, 2026

Copy link
Copy Markdown
Contributor
  • Adds missing description to the Actor object. (pricingInfos will follow as a separate PR)
  • Cleans up the Create Actor endpoint description.

Part of #2684.

@szaganek szaganek requested a review from a team June 24, 2026 07:28
@szaganek szaganek self-assigned this Jun 24, 2026
@szaganek szaganek added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Jun 24, 2026
@apify-service-account

apify-service-account commented Jun 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@apify-service-account apify-service-account mentioned this pull request Jun 24, 2026
Closed
@apify-service-account

apify-service-account commented Jun 24, 2026

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#884

  • 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 approved these changes Jun 24, 2026
View reviewed changes

@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.

👍

Comment thread apify-api/openapi/components/schemas/actors/SourceCodeFolder.yaml
folder:
type: boolean
description: Always `true` for folders. Used to distinguish folders from files.
description: Whether it's a folder. Distinguishes folders from files.

@mixalturek mixalturek Jun 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nitpick: Having "is folder" boolean in a "folder" object looks strange. But it's off-topic for this PR :-)

mvolfik
mvolfik reviewed Jun 24, 2026
View reviewed changes
Comment thread apify-api/openapi/components/schemas/actors/ActorStandby.yaml Outdated
mvolfik
mvolfik reviewed Jun 24, 2026
View reviewed changes
Comment thread apify-api/openapi/components/schemas/actors/Version.yaml Outdated
mvolfik
mvolfik reviewed Jun 24, 2026
View reviewed changes
Comment thread apify-api/openapi/components/schemas/actors/CreateActorRequest.yaml Outdated
@mvolfik

mvolfik commented Jun 24, 2026

Copy link
Copy Markdown
Member

Thank you for filling these things that we never did! Looks good, just two small description fixes pls :)

@apify-service-account apify-service-account mentioned this pull request Jun 24, 2026
Closed
@apify-service-account

apify-service-account commented Jun 24, 2026

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#885

  • 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.

@apify-service-account apify-service-account mentioned this pull request Jun 24, 2026
Merged
@apify-service-account

apify-service-account commented Jun 24, 2026

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#886

  • 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 0fcb1de into master Jun 24, 2026
16 checks passed
@szaganek szaganek deleted the docs-create-actor-endpoint branch June 24, 2026 10:53
vdusek pushed a commit to apify/apify-client-python that referenced this pull request Jun 24, 2026
@apify-service-account
docs: add field descriptions to Actor models (#886)
e678d32 
This PR updates the auto-generated Pydantic models and TypedDicts based
on OpenAPI specification changes in [apify-docs PR
#2685](apify/apify-docs#2685).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mvolfik mvolfik mvolfik approved these changes
@janbuchar janbuchar janbuchar approved these changes
@mixalturek mixalturek mixalturek approved these changes
@fnesveda fnesveda Awaiting requested review from fnesveda fnesveda is a code owner

Assignees

@szaganek szaganek

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@szaganek @apify-service-account @mvolfik @janbuchar @mixalturek