Skip to content

Conversation

@vdusek
Copy link
Contributor

@vdusek vdusek commented Jan 20, 2026

Issue

Description

  • Add Redocly and Spectral for OpenAPI lint checks.
    • Maybe using only Redocly is enough? Let me know your opinion.
    • Fixed 62 Spectral validation errors (missing required fields, incorrect types, nullable issues).
    • In Redocly, we have the errors set as warnings, I will resolve them in chore(openapi): Update to Open API v3.1 #2188.
  • Add YAML style lint check.
    • Only for the OpenAPI definitions.
    • Unify and enforce style.
    • Double quotes as in JSON or single quotes as we prefer in Py and AFAIK in JS as well, any opinion? 🙂
  • Remove Go API client generation job, as discussed in chore(openapi): Update to Open API v3.1 #2188.
    • It is replaced with the validate step, where we validate the bundled specification with the Redocly and check its size.
  • The new OpenAPI CI is: lint-check -> build -> validate.

Testing

  • CI passes

Note

Strengthens OpenAPI quality checks and streamlines CI.

  • Adds OpenAPI checks workflow (.github/workflows/openapi-ci.yaml) with Redocly/Spectral/YAML linting, bundle build/upload, and post-build validation (including bundle size check)
  • Removes legacy workflow (.github/workflows/openapi.yaml) and Go client codegen config (codegen/oapi-codegen-go/*), and cleans .gitignore
  • Introduces Spectral config (.spectral.yaml) with rule overrides and adds YAML linting via ESLint (eslint.config.mjs) scoped to apify-api/**, with an exception for openapi/openapi.yaml
  • Normalizes and fixes many OpenAPI YAML files (schemas, paths, components): consistent quoting/arrays, corrected $ref paths, examples, required lists, and descriptions

Written by Cursor Bugbot for commit b09198c. Configure here.

@vdusek vdusek added this to the 132nd sprint - Tooling team milestone Jan 20, 2026
@vdusek vdusek self-assigned this Jan 20, 2026
@vdusek vdusek added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 20, 2026
@apify-service-account
Copy link

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

@vdusek vdusek added the adhoc Ad-hoc unplanned task added during the sprint. label Jan 20, 2026
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

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