Skip to content

Conversation

@karen-hedges
Copy link
Contributor

JIRA link (if applicable)

https://tools.hmcts.net/jira/browse/DMP-5276

Change description

Added open API validation

Does this PR introduce a breaking change? (check one with "x")

[ ] Yes
[x] No

To enable OpenAPI validation, the following properties are set in the application configuration:
```bash
lint-openapi "src/main/resources/openapi/**/*.yaml"
Copy link
Contributor

Choose a reason for hiding this comment

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

this is doing linting similar to spectral rather than any validation against requests/responses, we need to decide whether to use lint-openapi or spectral for linting (we need spectral anyway)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

lint-openapi uses spectral

Copy link
Contributor

@DavidTMann DavidTMann Oct 28, 2025

Choose a reason for hiding this comment

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

is using lint-openapi giving any benefit over just using spectral? e.g. spectral lint --verbose "src/main/resources/openapi/**/*.{yml,yaml}"

It seems duplicated in their purpose. Both are mentioned in the readme, but both are doing the same thing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OpenAPI validator is better than spectral and can use the spectral ruleset

Added open apid validation
Added open apid validation
Added open apid validation
Added open api validation
Added open apid validation
Added open api validation
Added open api validation
Added open api validation
@karen-hedges karen-hedges force-pushed the DMP-5276-OpenapiValidator branch from a2a1964 to 7348afb Compare October 30, 2025 17:00
@hmcts-jenkins-cnp hmcts-jenkins-cnp bot requested a deployment to preview October 30, 2025 17:24 Abandoned
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants