kibana/oas_docs
2024-09-12 07:03:40 -07:00
..
examples [OAS][DOCS] Add overlays for connector config and examples (#191791) 2024-09-05 11:19:52 -05:00
output [DOCS][API] Add /api/fleet to Fleet API paths (#192652) 2024-09-12 07:03:40 -07:00
overlays [DOCS][API] Add TheHive connector config and secrets (#192424) 2024-09-11 16:39:55 -07:00
scripts Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
.spectral.yaml [OAS][DOCS] Adds linting rule for missing property descriptions (#191594) 2024-08-29 09:44:29 +01:00
bundle.json [OAS] Include connector APIs (#191679) 2024-08-29 17:44:29 -05:00
bundle.serverless.json [OAS] Include connector APIs (#191679) 2024-08-29 17:44:29 -05:00
kibana.info.serverless.yaml [OAS][DOCS] Clarify license, version, and source URL (#192145) 2024-09-05 07:06:44 -07:00
kibana.info.yaml [OAS][DOCS] Clarify license, version, and source URL (#192145) 2024-09-05 07:06:44 -07:00
makefile [OAS][DOCS] Add overlays for connector config and examples (#191791) 2024-09-05 11:19:52 -05:00
README.md [OAS][DOCS] Temporarily omit security APIs from docs (#190467) 2024-08-14 11:52:18 -05:00

The bundle.json and bundle.serverless.json files are generated automatically. See node scripts/capture_oas_snapshot --help for more info.

The output/kibana.serverless.yaml and output/kibana.yaml files join some manually-maintained files with the automatically generated files. To add integrate more files into this bundle, edit the appropriate oas_docs/scripts/merge*.js files. To generate the bundled files, run make api-docs (or make api-docs-serverless and make api-docs-stateful). To lint them, run make api-docs-lint (or make api-docs-lint-serverless and make api-lint-stateful).

To apply some overlays that perform some post-processing and append some content, run make api-docs-overlay.