Skip to content

APM-6125: Resolve dependabot alerts #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fayez166 merged 4 commits into from
Mar 25, 2025
Merged

APM-6125: Resolve dependabot alerts #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f8289b
APM-6125: resolve dependabot alerts
fayez166 Mar 24, 2025
f7a001c
APM-6125: resolve dependabot alerts
fayez166 Mar 25, 2025
4c1ddb2
APM-6125: resolve dependabot alerts
fayez166 Mar 25, 2025
8512f67
APM-6125: remove speccy references
fayez166 Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ publish: clean
mkdir -p build
npm run publish 2> /dev/null

serve:
npm run serve

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

smoketest:
smoketest: test
# this target is for end to end smoketests this would be run 'post deploy' to verify an environment is working
poetry run pytest -v tests/api_tests.py --junitxml=smoketest-report.xml -s
poetry run pytest -v tests/
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,14 @@ Each API and team is unique. We encourage you to use a `test/` folder in the roo

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

### Speccy
### OpenAPI Generator

> [Speccy](http://speccy.io/) *A handy toolkit for OpenAPI, with a linter to enforce quality rules, documentation rendering, and resolution.*
> [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*

Speccy does the lifting for the following npm scripts:
OpenAPI Generator does the lifting for the following npm scripts:

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

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

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

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

#### Apigee Portal
The Apigee portal will not automatically pull examples from schemas, you must specify them manually.
Expand Down
Loading