You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR updates the guidance around the use of the capture_oas_snapshot command, since omitting `include-path` yields different results than what we're publishing.
Copy file name to clipboardExpand all lines: contribute-docs/api-docs/kibana-api-docs-quickstart.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,7 +202,7 @@ responses:
202
202
:sync: code-generated
203
203
204
204
:::{note}
205
-
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues. See [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh) for the full list of paths captured in CI.
205
+
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues.
206
206
:::
207
207
208
208
This step captures the OpenAPI specification that {{kib}} generates at runtime from your route definitions. It spins up a local {{es}} and {{kib}} cluster with your code changes. This generates the following output files in the `oas_docs` directory:
@@ -214,13 +214,27 @@ This step captures the OpenAPI specification that {{kib}} generates at runtime f
214
214
- [Docker](https://docs.docker.com/get-docker/) must be running
215
215
- If you're an Elastician, ensure you're logged into Docker with your Elastic account
216
216
217
-
**Capture all API paths** (recommended):
217
+
To capture all the documented API paths, copy the command from [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh). For example:
218
218
219
219
```bash
220
-
node scripts/capture_oas_snapshot --update
220
+
node scripts/capture_oas_snapshot \
221
+
--include-path /api/status \
222
+
--include-path /api/alerting/rule/ \
223
+
--include-path /api/alerting/rules \
224
+
--include-path /api/actions \
225
+
--include-path /api/security/role \
226
+
--include-path /api/spaces \
227
+
--include-path /api/streams \
228
+
--include-path /api/fleet \
229
+
--include-path /api/saved_objects/_import \
230
+
--include-path /api/saved_objects/_export \
231
+
--include-path /api/maintenance_window \
232
+
--include-path /api/agent_builder
233
+
--update
221
234
```
222
235
223
-
**For faster iteration**, capture the specific paths you're working on:
236
+
For faster iteration**, you can capture the specific paths you're working on, though this minimized output should not be included in your pull request.
0 commit comments