Skip to content

docs(openapi): Align 404 to use generic error and specific example#2422

Merged
Pijukatel merged 3 commits intomasterfrom
use-generic-404
Apr 13, 2026
Merged

docs(openapi): Align 404 to use generic error and specific example#2422
Pijukatel merged 3 commits intomasterfrom
use-generic-404

Conversation

@Pijukatel
Copy link
Copy Markdown
Contributor

@Pijukatel Pijukatel commented Apr 13, 2026 •
edited
Loading

  • Add missing, but possible errors to the ErrorResponse.yaml
  • Simplify 404s to refer to a generic error and give generic missing resource text

Motivation:

  • Simplify code generation by reducing the number of error objects.
  • Simplify upcoming documentation of redispatch endpoints (This will allow complete reuse of the response section. Using granular 404s would not allow it due to, for example, last run endpoints always having actor/run not found errors even when referring to the default dataset, while getting the dataset directly through id will never return such 404 variant )

Follow up for: #2398

Partially implements: #2286

@Pijukatel
Align 404 to use generic error and specific example
3aab47b 
Add missing, but possible errors to the ErrorResponse.yaml
@Pijukatel Pijukatel requested a review from vdusek April 13, 2026 09:46
@github-actions github-actions bot added this to the 138th sprint - Tooling team milestone Apr 13, 2026
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Apr 13, 2026
@apify-service-account
Copy link
Copy Markdown

apify-service-account commented Apr 13, 2026

Preview for this PR was built for commit 3aab47b and is ready at https://pr-2422.preview.docs.apify.com!

@apify-service-account apify-service-account mentioned this pull request Apr 13, 2026
Merged
@apify-service-account
Copy link
Copy Markdown

apify-service-account commented Apr 13, 2026

A PR to update the Python client models has been created: apify/apify-client-python#719

This was automatically triggered by OpenAPI specification changes in this PR.

@Pijukatel Pijukatel marked this pull request as ready for review April 13, 2026 09:58
vdusek
vdusek requested changes Apr 13, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@vdusek vdusek left a comment

Choose a reason for hiding this comment

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

please see what it generated in apify/apify-client-python#719 - ErrorType, Type1

@apify-service-account
Copy link
Copy Markdown

apify-service-account commented Apr 13, 2026

Preview for this PR was built for commit 9830c7d1 and is ready at https://pr-2422.preview.docs.apify.com!

@apify-service-account
Copy link
Copy Markdown

apify-service-account commented Apr 13, 2026

Preview for this PR was built for commit ae3efa9f and is ready at https://pr-2422.preview.docs.apify.com!

@apify-service-account
Copy link
Copy Markdown

apify-service-account commented Apr 13, 2026

Preview for this PR was built for commit 58d95669 and is ready at https://pr-2422.preview.docs.apify.com!

@apify-service-account
Copy link
Copy Markdown

apify-service-account commented Apr 13, 2026

The Python client model PR has been updated with the latest OpenAPI spec changes: apify/apify-client-python#719

vdusek
vdusek approved these changes Apr 13, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@vdusek vdusek left a comment

Choose a reason for hiding this comment

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

LGTM

@Pijukatel Pijukatel merged commit 24a78eb into master Apr 13, 2026
15 checks passed
@Pijukatel Pijukatel deleted the use-generic-404 branch April 13, 2026 11:56
Pijukatel pushed a commit to apify/apify-client-python that referenced this pull request Apr 13, 2026
@apify-service-account
chore: update generated models from apify-docs PR #2422 (#719)
b6c2f22 
This PR updates the auto-generated Pydantic models based on OpenAPI
specification changes in [apify-docs PR
#2422](apify/apify-docs#2422).

---------

Co-authored-by: apify-service-account <apify-service-account@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fnesveda fnesveda fnesveda approved these changes

@vdusek vdusek vdusek approved these changes

@janbuchar janbuchar Awaiting requested review from janbuchar janbuchar is a code owner

Assignees

@Pijukatel Pijukatel

Labels

t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Milestone

138th sprint - Tooling team

Development

Successfully merging this pull request may close these issues.

4 participants

@Pijukatel @apify-service-account @fnesveda @vdusek