Skip to content

fix(openapi): Fix all OpenAPI linting errors and add stricter validation rules#2194

Merged
vdusek merged 6 commits intomasterfrom
lint-more-strictly
Jan 21, 2026
Merged

fix(openapi): Fix all OpenAPI linting errors and add stricter validation rules#2194
vdusek merged 6 commits intomasterfrom
lint-more-strictly

Conversation

@vdusek
Copy link
Contributor

@vdusek vdusek commented Jan 21, 2026

Issue

Description

  • Enable info-license: error
    • Add Apache 2.0 license to openapi.yaml
  • Enable tag-description: error
    • Add descriptions to Storage and Webhooks tags
  • Enable no-invalid-schema-examples: error
    • Fix all examples in schema/ dir
  • Enable no-invalid-media-type-examples: error
    • Fix all examples in paths/ dir
  • Enable operation-4xx-response: error
    • Add error response components based on the common ErrorResponse
  • A few more minor fixes
    • finishedAt type is nullable
    • reference to CreateOrUpdateVersionRequest
    • ...

Tests

  • CI passes

Note

Strengthens OpenAPI quality and consistency and resolves all lint errors.

  • Stricter validation: Updates redocly.yaml to enforce info-license, tag-description, no-invalid-*-examples, and operation-4xx-response rules; adds Apache 2.0 license to openapi.yaml.
  • Standardized errors: Introduces reusable 400 (BadRequest) plus Unauthorized and NotFound response components; wires 400 across numerous paths/* endpoints.
  • Schema/example fixes: Corrects invalid examples and types (e.g., JSON strings, arrays vs objects, URLs without extra quotes), makes finishedAt nullable in Run, updates KeyValueStore/Webhook* examples, adjusts refs (e.g., CreateOrUpdateVersionRequest), and refines sample fields (e.g., pricing, computeUnits, generalAccess).
  • Docs metadata: Adds tag descriptions (e.g., Storage, Webhooks) and minor descriptive cleanups.

Written by Cursor Bugbot for commit 7304793. Configure here.

@github-actions github-actions bot added this to the 132nd sprint - Tooling team milestone Jan 21, 2026
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 21, 2026
@vdusek vdusek added the adhoc Ad-hoc unplanned task added during the sprint. label Jan 21, 2026
@apify-service-account
Copy link

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

@vdusek vdusek force-pushed the lint-more-strictly branch from 7304793 to 6b1daf2 Compare January 21, 2026 14:58
@apify-service-account
Copy link

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

@vdusek vdusek merged commit 26791b1 into master Jan 21, 2026
12 checks passed
@vdusek vdusek deleted the lint-more-strictly branch January 21, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants