docs(openapi): Document 404 related errors on acts and actor-builds endpoints#2308
docs(openapi): Document 404 related errors on acts and actor-builds endpoints#2308
acts and actor-builds endpoints#2308Conversation
github-actions
bot
added
the
t-tooling
|
Preview for this PR was built for commit |
Pijukatel
force-pushed
the
improve-errors-on-actors-actor-runs
branch
from
2931bf4 to
e43a091
Compare
|
Preview for this PR was built for commit |
Pijukatel
changed the title
acts endpointsacts and actor-builds endpoints
Pijukatel
force-pushed
the
improve-errors-on-actors-actor-runs
branch
from
a74a75f to
1cf995a
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml
Outdated
Show resolved
Hide resolved
|
Preview for this PR was built for commit |
janbuchar
left a comment
janbuchar
left a comment
There was a problem hiding this comment.
One nit, one potential point for discussions. Nothing worth stalling this, so please accept my approval.
| content: | ||
| application/json: | ||
| schema: | ||
| oneOf: |
There was a problem hiding this comment.
This also seems redundant and the other files have it too 🙂
There was a problem hiding this comment.
Removed, where redundant
| enum: [actor-not-found] | ||
| message: | ||
| type: string | ||
| enum: [Actor was not found] |
There was a problem hiding this comment.
Although I like it, I'm not sure if this level of detail is necessary (declaring the exact text of every error response) 😁
There was a problem hiding this comment.
Agreed. Plus the exact definition might be too strict sometimes.
There was a problem hiding this comment.
- I kept the constraint on
error.type. - I relaxed the
error.messageconstraint and instead put the text to example (It will render the same, and it will not be so strict.
fnesveda
left a comment
fnesveda
left a comment
There was a problem hiding this comment.
Looks good, just one issue with the "build with tag not found" error.
| enum: [actor-not-found] | ||
| message: | ||
| type: string | ||
| enum: [Actor was not found] |
There was a problem hiding this comment.
Agreed. Plus the exact definition might be too strict sometimes.
apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml
Outdated
Show resolved
Hide resolved
Relax the error message constraints
|
Preview for this PR was built for commit |
4 participants
Summary
(Done only for
actsandactor-buildsendpoints to limit the scope of the change. It should be done to all endpoints in follow-up PRs)Motivation
Example of granular 404s for an endpoint that relies on multiple resources:
Issues
Partially implements: #2286
Note
Cursor Bugbot is generating a summary for commit f16d5e5. Configure here.