feat: Add readmeSummary field to openapi spec#2223
Conversation
janbuchar
added
the
t-tooling
|
Preview for this PR was built for commit |
apify-api/openapi/components/schemas/actors/ActorDefinition.yaml
Outdated
Show resolved
Hide resolved
Co-authored-by: Jiří Spilka <jiri.spilka@apify.com>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
janbuchar
force-pushed
the
add-readme-summary-field
branch
from
8029b24 to
b577f71
Compare
|
Preview for this PR was built for commit |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This PR is being reviewed by Cursor Bugbot
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
Comment @cursor review or bugbot run to trigger another review on this PR
| - type: "null" | ||
| readmeSummary: | ||
| type: string | ||
| description: A brief, LLM-generated readme summary |
There was a problem hiding this comment.
readmeSummary likely needs nullable type definition
Medium Severity
The readmeSummary field is defined as type: string (non-nullable), but similar optional text fields in the same schemas (description, title) use type: [string, "null"]. Since readmeSummary is LLM-generated and not in the required list, the API will likely return null for actors that haven't had a summary generated yet, causing schema validation failures for API consumers.
Additional Locations (1)
4 participants
Note
Low Risk
Spec-only changes that add an optional response field and adjust documentation text; primary risk is downstream client/codegen expectations around the new property.
Overview
Adds a new
readmeSummarystring field (described as an LLM-generated README summary) to the OpenAPI schemas forActorandStoreListActorso the field can be returned in API responses.Also tweaks the
ActorDefinition.usesStandbyModedescription wording to be clearer (no structural schema change).Written by Cursor Bugbot for commit b577f71. Configure here.