Skip to content

Commit

Permalink
try settings api
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzad31 committed Aug 8, 2023
1 parent 1bb65b8 commit af07fed
Show file tree
Hide file tree
Showing 21 changed files with 1,016 additions and 19 deletions.
2 changes: 1 addition & 1 deletion x-pack/plugins/uptime/common/constants/rest_api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

export enum API_URLS {
DYNAMIC_SETTINGS = `/internal/uptime/dynamic_settings`,
DYNAMIC_SETTINGS = `/uptime/settings`,
INDEX_STATUS = '/internal/uptime/index_status',
MONITOR_LIST = `/internal/uptime/monitor/list`,
MONITOR_LOCATIONS = `/internal/uptime/monitor/locations`,
Expand Down
33 changes: 33 additions & 0 deletions x-pack/plugins/uptime/docs/openapi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# OpenAPI (Experimental)

The current self-contained spec file is [as YAML](https://raw.githubusercontent.com/elastic/kibana/master/x-pack/plugins/obserbability/docs/openapi/slo/bundled.yaml) and can be used for online tools like those found at <https://openapi.tools/>.
This spec is experimental and may be incomplete or change later.

A guide about the OpenApi specification can be found at [https://swagger.io/docs/specification/about/](https://swagger.io/docs/specification/about/).

## The `openapi/slo` folder

- `entrypoint.yaml` is the overview file which pulls together all the paths and components.
- [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
- [Components](components/README.md): Reusable components

## Tools

It is possible to manually validate the docs before bundling them with the following
command in the `x-pack/plugins/observability/docs/openapi/slo` folder:

```bash
make validate
```

Then you can generate the `bundled` files by running the following command- this target will automatically validate inputs and lint the result:

```bash
make bundle
```

To lint the generated bundle manually, run:

```bash
make lint
```
Loading

0 comments on commit af07fed

Please sign in to comment.