Skip to content

[DOCS] Add cases open API output to appendix#141684

Closed
lcawl wants to merge 9 commits intoelastic:mainfrom
lcawl:case-v3-api-out
Closed

[DOCS] Add cases open API output to appendix#141684
lcawl wants to merge 9 commits intoelastic:mainfrom
lcawl:case-v3-api-out

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 23, 2022

Summary

Relates to #137240

This PR uses the open API v3 specification (from #138779 with some additional changes underway). It takes output from the open-api generator, in particular the HTML generator, applies a custom template and uses that output in a passthrough block in an appendix in the Kibana Guide.

Subsequent improvements to this process and to the stylesheet are expected.

NOTE:
Due to the volume of APIs and dependencies, I've split the first four into a separate PR: #142173

@github-actions
Copy link
Contributor

Documentation preview:

@kibana-ci
Copy link

kibana-ci commented Sep 28, 2022

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #20 / apis uptime uptime REST endpoints uptime CRUD routes AddProjectMonitors project monitors - deletes monitors when keep stale is false
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing displays the analytics job in the map view
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing displays the analytics job in the map view
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing edits the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing edits the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing navigates through the wizard and sets all needed fields
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing navigates through the wizard and sets all needed fields
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing runs the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics classification creation bank marketing runs the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics outlier detection creation iowa house prices edits the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics outlier detection creation iowa house prices edits the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics regression creation electrical grid stability edits the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics regression creation electrical grid stability edits the analytics job and displays it correctly in the job list
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics regression creation electrical grid stability navigates through the wizard and sets all needed fields
  • [job] [logs] FTR Configs #13 / machine learning - data frame analytics regression creation electrical grid stability navigates through the wizard and sets all needed fields

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl
Copy link
Contributor Author

lcawl commented Oct 5, 2022

Due to the volume of APIs and dependencies, I'll split this work into smaller PRs.

@lcawl lcawl closed this Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants