co-cddo / api-standards-linting Goto Github PK

We should add rules that mirror any of the rules that can be codified as part of https://www.gov.uk/guidance/gds-api-technical-and-data-standards

I.e. in a PUT/POST, it's recommended that there's a maximum length, for security purposes.

Similar to those in https://github.com/openapi-contrib/style-guides/blob/master/fhir.yml, we should look at adding FHIR API linting too, as these would be usable across a number of NHS (and beyond) APIs that are FHIR compliant.

This would also be usable wider by other folks who are producing/consuming FHIR APIs.

When we want to have consumers of this, we'll need a level of documentation available for it, so it's consumable.

To ensure that we're telling consumers what is expected, but may not be added by developers, as it's framework/API Gateway

(Already planned)

https://http.cat/406
https://http.cat/415

Also add:

https://http.cat/429

Maybe also

https://http.cat/404

Next quarter we're planning on building out a set of API standards, which we should look to codify these standards too

This repo's project board can be found at https://github.com/orgs/co-cddo/projects/2/views/1

As per federated-api-model

https://gds-way.cloudapps.digital/standards/source-code.html#using-github-actions-and-workflows

https://github.com/italia/api-oas-checker

Right now, at least semver doesn't specify that it should be an error as well as the i.e. message

As per co-cddo/federated-api-model#20