kibana

mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00

History

Lisa Cawley 4a3fa7ea22 [OAS] Include connector APIs (#191679 )		2024-08-29 17:44:29 -05:00
..
examples	[OAS][DOCS] Use automated alerting rule API documentation (#190205 )	2024-08-15 17:07:56 -05:00
output	[Docs] Add details to SO APIs landing page (#191693 )	2024-08-29 15:04:00 -05:00
overlays	[Docs] Add details to SO APIs landing page (#191693 )	2024-08-29 15:04:00 -05:00
scripts	[OAS] Include connector APIs (#191679 )	2024-08-29 17:44:29 -05: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	[DOCS][OAS] Update API documentation license (#191563 )	2024-08-28 12:10:00 -05:00
kibana.info.yaml	[DOCS][OAS] Update API documentation license (#191563 )	2024-08-28 12:10:00 -05:00
makefile	[OAS][DOCS] Adds linting rule for missing property descriptions (#191594 )	2024-08-29 09:44:29 +01:00
README.md	[OAS][DOCS] Temporarily omit security APIs from docs (#190467 )	2024-08-14 11:52:18 -05:00

README.md

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.