Switch to a supported OpenAPI validator. #430
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When updating the linter to something more recent, supported and more strict, we uncovered the following errors: ``` Message : $ref must not be placed next to any other properties Rule : no-$ref-siblings Path : components.schemas.itemBase.properties.properties.readOnly Line : 1097 Message : $ref must not be placed next to any other properties Rule : no-$ref-siblings Path : components.schemas.itemBase.properties.stac_version.readOnly Line : 1100 ``` The no-$ref-siblings rule is documented in https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules#no-ref-siblings We resolve this by moving the `readOnly` attribute into the component. This was already done for `stac_version`. For `properties` we verified it is only used in one place so it should be safe.
When updating the linter to something more recent, supported and stricter, we uncovered the following error: ``` Message : Schema of type string should use one of the following formats: binary, byte, crn, date, date-time, email, identifier, password, url, uuid Rule : ibm-schema-type-format Path : components.schemas.sha256 Line : 665 ``` The ibm-schema-type-format rule is documented in https://github.com/IBM/openapi-validator/blob/main/docs/ibm-cloud-rules.md#ibm-schema-type-format We resolve this by changing the format from `digest` to `binary`. Additionnally, we set `minLength` and `maxLength` to 64 as that's the lenght of a SHA-256 hash expressed as hexadecimal.
We currently use IBM's OpenAPI validator 0.54.0 (released circa February 2022) from an old unsupported Docker image. With this change we update to version 1.19.2 (released June 2024) based on a Docker image shipped by IBM itself. There were many changes in the validator since. In particular, the ruleset has stricter checks about naming conventions that are specific to IBM guidelines and which we don't follow. Rather than updating our specs to comply with IBM guidelines, we disable these specific checks. We also remove the old .validaterc configuration file which the newer validator is not able to parse anyway.
adk-swisstopo
force-pushed
the
fix-PB-687-lint-spec
branch
from
09a775c
to
1254bb7
Compare
boecklic
approved these changes
Jul 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This requires some changes to the spec and I still disabled some checks that would be too disruptive. See commits for details.