Skip to content

API docs fail non-minimal linting #1226

@alxndrsn

Description

@alxndrsn

Follow-up to getodk/central-backend#1593.

If minimal linting is disabled:

npx --no @redocly/cli lint docs/api.yaml

fails with:

❌ Validation failed with 314 errors and 123 warnings.

Violations:

$ npx --no @redocly/cli lint --format json --max-problems 10000000000000000000 docs/api.yaml 2>/dev/null | jq -r '.problems.[].ruleId' | sort | uniq -c
      1 info-license
      2 no-ambiguous-paths
     94 no-invalid-media-type-examples
      6 no-unused-components
      1 operation-2xx-response
     14 operation-4xx-response
      4 operation-operationId
    154 operation-operationId-url-safe
      1 path-not-include-query
      1 path-parameters-defined
    158 security-defined
      1 tag-description

Metadata

Metadata

Assignees

Labels

backendRequires a change to the API serverdocumentationAPI docs, readme, developer docs

Type

No type

Projects

Status

✅ done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions