[Dashboards][OAS] Generate API docs for Dashboards API #199215
Conversation
nickpeihl
force-pushed
the
dashboardApi_oasDocs
branch
from
d468969 to
9d80b11
Compare
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --include-path /api/dashboards --update'
This leads to issues with Open API documentation where the uuidv4 function returns unwanted values in the spec. If not provided, the Storage implementation generates random values instead.
This reverts commit 0f3bde4.
This reverts commit 3dff92f.
…s' into dashboardApi_oasDocs
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --include-path /api/dashboards --update'
…s' into dashboardApi_oasDocs
nickpeihl
added
release_note:skip
|
Pinging @elastic/kibana-presentation (Team:Presentation) |
|
Pinging @elastic/kibana-docs (Team:Docs) |
nickpeihl
added
backport:prev-minor
nickpeihl
changed the title
|
I've added the |
| meta: { description: 'The page number to return.' }, | ||
| defaultValue: 1, | ||
| }), | ||
| perPage: schema.maybe( |
There was a problem hiding this comment.
how about including defaults in the description for when value is not provided.
Is there a max perPage value? Lets mention that as well.
There was a problem hiding this comment.
I've added a max perPage value of 1000 which matches the internal RPC default for the Dashboard listing page. abfffa8
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --include-path /api/dashboards --update'
💚 Build Succeeded
Metrics [docs]Public APIs missing exports
History
|
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/12169509403 |
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
kibanamachine
added
the
backport missing
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
1 similar comment
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
#203437) # Backport This will backport the following commits from `main` to `8.x`: - [[Dashboards][OAS] Generate API docs for Dashboards API (#199215)](#199215) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Nick Peihl","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-04T22:33:10Z","message":"[Dashboards][OAS] Generate API docs for Dashboards API (#199215)","sha":"c8866e4ce3425bfb8188320997c75c4c152b2241","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Team:Presentation","release_note:skip","backport missing","v9.0.0","docs","backport:prev-minor"],"number":199215,"url":"https://github.com/elastic/kibana/pull/199215","mergeCommit":{"message":"[Dashboards][OAS] Generate API docs for Dashboards API (#199215)","sha":"c8866e4ce3425bfb8188320997c75c4c152b2241"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199215","number":199215,"mergeCommit":{"message":"[Dashboards][OAS] Generate API docs for Dashboards API (#199215)","sha":"c8866e4ce3425bfb8188320997c75c4c152b2241"}}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
kibanamachine
added
v8.18.0
and removed
backport missing
Fixes #192875
Summary
Add Dashboards API to generated OpenAPI docs
We can generate an ephemeral API documentation webpage on Bump.sh for previewing the changes.
bump-clipackage the first time, e.g.npm install --global bump-cli.cd oas_docsmake api-docsmake api-docs-previewThe third step creates a webpage on Bump with a TTL of 90 minutes.