Skip to content

feat: Add readmeSummary field to openapi spec #2223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janbuchar merged 3 commits into from
Feb 10, 2026
Merged

feat: Add readmeSummary field to openapi spec #2223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c06f553
feat: Add readmeSummary field to openapi spec
janbuchar Feb 4, 2026
9889e8d
Update apify-api/openapi/components/schemas/actors/ActorDefinition.yaml
janbuchar Feb 5, 2026
b577f71
Remove readmeSummary from ActorDefinition (not necessary)
janbuchar Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions apify-api/openapi/components/schemas/actors/Actor.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,6 @@ properties:
anyOf:
- $ref: ./TaggedBuilds.yaml
- type: "null"
readmeSummary:
type: string
description: A brief, LLM-generated readme summary
Copy link

@cursor cursor bot Feb 10, 2026

Choose a reason for hiding this comment

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

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)

Fix in Cursor Fix in Web

2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actors/ActorDefinition.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ properties:
description: Specifies the maximum amount of memory in megabytes required by the Actor.
usesStandbyMode:
type: boolean
description: Specifies whether the Actor will have Standby mode enabled.
description: Specifies whether Standby mode is enabled for the Actor.
3 changes: 3 additions & 0 deletions apify-api/openapi/components/schemas/store/StoreListActor.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,6 @@ properties:
isWhiteListedForAgenticPayment:
type: [boolean, "null"]
description: Whether the Actor is whitelisted for agentic payment processing.
readmeSummary:
type: string
description: A brief, LLM-generated readme summary