Replace speccy with redocly #810
Conversation
nhsd-david-wass
force-pushed
the
feature/ERSSUP-64283
branch
from
9d232b3
to
d8d95b4
Compare
nhsd-david-wass
force-pushed
the
feature/ERSSUP-64283
branch
2 times, most recently
from
7b46ff3
to
83b2152
Compare
| @@ -14,6 +14,6 @@ content: | |||
| $ref: '../../eRS-ReferralRequest.yaml' | |||
| examples: | |||
| withClinicalInformation: | |||
| summary: `ReferralRequest` with clinical information (2 files) | |||
| summary: "`ReferralRequest` with clinical information (2 files)" | |||
| value: | |||
There was a problem hiding this comment.
Caused error starting the field with "`" - surrounding with " does not affect the rendering in bloomreach
| @@ -11,7 +11,7 @@ content: | |||
| schema: | |||
| $ref: '../../eRS-FetchWorklist-List.yaml' | |||
| examples: | |||
| a&g-requests: | |||
| aAndg-requests: | |||
| summary: Advice and guidance requests | |||
There was a problem hiding this comment.
'&' cause linting error - this field is not displayed - so does not affect output
redocly.yaml
Outdated
| rules: | ||
| no-invalid-media-type-examples: | ||
| severity: off | ||
| info-license-url: off |
There was a problem hiding this comment.
no-invalid-media-type-examples is a linting rule that should check all the examples against the schema specification.
Where we have refs to example response files, the redocly library fails to expand the ref and fails the validation (known issue Redocly/redocly-cli#919)
However, we have our own validation (validate_oas_examples.py) that validates all our examples against the schema
package.json
Outdated
| @@ -3,16 +3,16 @@ | |||
| "version": "0.0.1", | |||
| "description": "OAS (Swagger v3) API Definition for Template API", | |||
| "scripts": { | |||
| "lint-oas": "node_modules/.bin/speccy lint -s openapi-tags -s operation-tags specification/e-referrals-service-api.yaml --skip default-and-example-are-redundant", | |||
| "publish": "mkdir -p build && node_modules/.bin/speccy resolve specification/e-referrals-service-api.yaml -i | poetry run python scripts/yaml2json.py | poetry run python scripts/set_version.py | poetry run python scripts/populate_placeholders.py > build/e-referrals-service-api.json", | |||
There was a problem hiding this comment.
Now that the yaml2json file has been removed from this command I suspect it can now be deleted as I don't think it's used elsewhere.
package.json
Outdated
| "check-licenses": "node_modules/.bin/license-checker --failOn GPL --failOn LGPL" | ||
| }, | ||
| "author": "NHS Digital", | ||
| "license": "MIT", | ||
| "homepage": "https://github.com/NHSDigital/e-referrals-service-api", | ||
| "dependencies": { | ||
| "speccy": "^0.11.0" | ||
| "@redocly/cli": "^1.0.0-beta.124" |
There was a problem hiding this comment.
Seems a bit dangerous to depend on a beta release here (although we were depending on a 0.x version of speccy anyway), is there a non-beta release we could use instead?
There was a problem hiding this comment.
redocly now has a stable 1.0 release. https://github.com/Redocly/redocly-cli/releases/tag/%40redocly%2Fcli%401.2.0
nhsd-david-wass
force-pushed
the
feature/ERSSUP-64283
branch
from
83b2152
to
b3bbcd7
Compare
nhsd-david-wass
force-pushed
the
feature/ERSSUP-64283
branch
from
b3bbcd7
to
1188e27
Compare
nhsd-david-wass
force-pushed
the
feature/ERSSUP-64283
branch
from
45e58b7
to
022f096
Compare
Summary
Add any other relevant notes or explanations here. Remove this line if you have nothing to add.
Reviews Required
Review Checklist
ℹ️ This section is to be filled in by the reviewer.