github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/packages/kbn-capture-oas-snapshot-cli
History
Jean-Louis Leysens 975eeed255
[HTTP/OAS] Commit OAS snapshot (#183338) 
Close https://github.com/elastic/kibana/issues/181992

## Summary

First iteration of a CLI to capture an OAS snapshot.

## How to test

Run `node ./scripts/capture_oas_snapshot.js --update --include-path
/api/status` and see result in `oas_docs/bundle.json`.

If you have the [bump CLI](https://www.npmjs.com/package/bump-cli)
installed you can preview the hosted output with `bump preview
./oas_docs/bundle.json`

## Notes
* Added ability to filter by `version`, `access` (public/internal) and
excluding paths explicitly to the OAS generation lib
* Follows the same general pattern as our other "capture" CLIs like
`packages/kbn-check-mappings-update-cli`
* Result includes only `/api/status` for now, waiting for other paths to
add missing parts

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-05-30 06:02:19 -07:00
..
src [HTTP/OAS] Commit OAS snapshot (#183338) 2024-05-30 06:02:19 -07:00
jest.config.js [HTTP/OAS] Commit OAS snapshot (#183338) 2024-05-30 06:02:19 -07:00
kibana.jsonc [HTTP/OAS] Commit OAS snapshot (#183338) 2024-05-30 06:02:19 -07:00
package.json [HTTP/OAS] Commit OAS snapshot (#183338) 2024-05-30 06:02:19 -07:00
README.md [HTTP/OAS] Commit OAS snapshot (#183338) 2024-05-30 06:02:19 -07:00
tsconfig.json [HTTP/OAS] Commit OAS snapshot (#183338) 2024-05-30 06:02:19 -07:00

README.md

@kbn/capture-oas-snapshot-cli

A CLI to capture OpenAPI spec snapshots from the /api/oas API.

See node scripts/capture_oas_snapshot --help for more info.