Skip to content

docs(openapi): Add missing descriptions to Get Actor endpoint - #2841

Merged
szaganek merged 4 commits into
masterfrom
api-docs-get-actor
Aug 3, 2026
Merged

docs(openapi): Add missing descriptions to Get Actor endpoint#2841
szaganek merged 4 commits into
masterfrom
api-docs-get-actor

Conversation

@szaganek

@szaganek szaganek commented Aug 3, 2026

Copy link
Copy Markdown
Contributor
  • Adds missing descriptions.
  • Cleans up the intro topic.

Part of #2684.

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

apify-service-account commented Aug 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@apify-service-account

apify-service-account commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Python client model regeneration failed. See workflow run.

@apify-service-account

apify-service-account commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Python client model regeneration failed. See workflow run.

mixalturek
mixalturek approved these changes Aug 3, 2026
View reviewed changes

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

Thanks a lot!

Comment thread apify-api/openapi/components/schemas/actors/Actor.yaml Outdated
Comment thread apify-api/openapi/components/schemas/actors/Actor.yaml
isCritical:
type: boolean
examples: [false]
description: Whether the Actor is maintained by Apify.

@mixalturek mixalturek Aug 3, 2026

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.

Nitpick: Is this correct? The description doesn't match the field name for me. Critical for what? ;-)

@szaganek szaganek Aug 3, 2026

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.

Yeah, the name threw me off as well 😅 But the explanation stands (for example, helpText)

@apify-service-account apify-service-account mentioned this pull request Aug 3, 2026
Merged
@apify-service-account

apify-service-account commented Aug 3, 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#989

  • 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 commented Aug 3, 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:

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

  • 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 c980051 into master Aug 3, 2026
16 checks passed
@szaganek
szaganek deleted the api-docs-get-actor branch August 3, 2026 11:12
vdusek pushed a commit to apify/apify-client-python that referenced this pull request Aug 3, 2026
@apify-service-account
docs: Add field descriptions to Actor models (#989)
7a5ed88 
- Updates the auto-generated Pydantic models and TypedDicts based on the
proposed OpenAPI specification changes.
- Based on apify-docs PR
[#2841](apify/apify-docs#2841).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mixalturek mixalturek mixalturek approved these changes
@janbuchar janbuchar Awaiting requested review from janbuchar janbuchar is a code owner
@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.

3 participants

@szaganek @apify-service-account @mixalturek