Skip to content

Commit 80b2482

Browse files
authored
Merge pull request #121 from NHSDigital/APM-6125-dependency-alerts
APM-6125: Resolve dependabot alerts
2 parents 0b5ad0d + 8512f67 commit 80b2482

File tree

4 files changed

+4026
-7514
lines changed

4 files changed

+4026
-7514
lines changed

Makefile

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ publish: clean
2424
mkdir -p build
2525
npm run publish 2> /dev/null
2626

27-
serve:
28-
npm run serve
2927

3028
check-licenses:
3129
npm run check-licenses
@@ -54,6 +52,6 @@ test:
5452
# this target should be used for local unit tests .. runs as part of the build pipeline
5553
make --no-print-directory -C sandbox test
5654

57-
smoketest:
55+
smoketest: test
5856
# this target is for end to end smoketests this would be run 'post deploy' to verify an environment is working
59-
poetry run pytest -v tests/api_tests.py --junitxml=smoketest-report.xml -s
57+
poetry run pytest -v tests/

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,14 @@ Each API and team is unique. We encourage you to use a `test/` folder in the roo
6464

6565
* [**openapi-yaml-mode**](https://github.com/esc-emacs/openapi-yaml-mode) provides syntax highlighting, completion, and path help
6666

67-
### Speccy
67+
### OpenAPI Generator
6868

69-
> [Speccy](http://speccy.io/) *A handy toolkit for OpenAPI, with a linter to enforce quality rules, documentation rendering, and resolution.*
69+
> [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator-cli) *OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec*
7070
71-
Speccy does the lifting for the following npm scripts:
71+
OpenAPI Generator does the lifting for the following npm scripts:
7272

7373
* `test` -- Lints the definition
7474
* `publish` -- Outputs the specification as a **single file** into the `build/` directory
75-
* `serve` -- Serves a preview of the specification in human-readable format
7675

7776
(Workflow detailed in a [post](https://developerjack.com/blog/2018/maintaining-large-design-first-api-specs/) on the *developerjack* blog.)
7877

@@ -81,7 +80,7 @@ Speccy does the lifting for the following npm scripts:
8180
### Caveats
8281

8382
#### Swagger UI
84-
Swagger UI unfortunately doesn't correctly render `$ref`s in examples, so use `speccy serve` instead.
83+
Swagger UI unfortunately doesn't correctly render `$ref`s in examples, so use `openapi publish` instead.
8584

8685
#### Apigee Portal
8786
The Apigee portal will not automatically pull examples from schemas, you must specify them manually.

0 commit comments

Comments
 (0)