Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lcawl wants to merge 9 commits into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fd28286
[DOCS] Add cases open API output to appendix
lcawl Sep 23, 2022
7287de5
Merge branch 'main' into case-v3-api-out
lcawl Sep 26, 2022
f036f41
Merge branch 'main' into case-v3-api-out
lcawl Sep 27, 2022
f8234f5
Add push case output
lcawl Sep 27, 2022
d088de9
Improve spec for output
lcawl Sep 28, 2022
20c4817
Add discriminators for oneOf in add case comment
lcawl Sep 28, 2022
9f33966
More work on update case comment properties
lcawl Sep 28, 2022
0e11bff
Remove charset content
lcawl Sep 28, 2022
cb5a459
Comment out allOf due to known problem
lcawl Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,714 changes: 2,714 additions & 0 deletions docs/api-generated/cases/case-apis-passthru.asciidoc
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions docs/api-generated/cases/case-apis.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[[case-apis]]
== Case APIs

preview::[]

////
This file includes content that has been generated from https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/docs/openapi. Any modifications required must be done in that open API specification.
////

include::case-apis-passthru.asciidoc[]
4 changes: 3 additions & 1 deletion docs/apis.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ version of the specification is 3.0. For more information, go to https://openapi

--

include::api-generated/machine-learning/ml-apis.asciidoc[]
include::api-generated/cases/case-apis.asciidoc[]
include::api-generated/machine-learning/ml-apis.asciidoc[]

14 changes: 10 additions & 4 deletions x-pack/plugins/cases/docs/openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,14 @@ command in the `x-pack/plugins/cases/docs/openapi/` folder:

Then you can generate the `bundled` files by running the following commands:

```
npx @redocly/openapi-cli bundle --ext yaml --output bundled.yaml entrypoint.yaml
npx @redocly/openapi-cli bundle --ext json --output bundled.json entrypoint.yaml
```
```
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
```

You can run additional linting with the following command:

```
npx @redocly/cli lint bundled.json
```

Loading