Skip to content

[8.x] [ResponseOps] Connector OAS for framework fields (#192767)#193349

Merged
kibanamachine merged 1 commit intoelastic:8.xfrom
kibanamachine:backport/8.x/pr-192767
Sep 18, 2024
Merged

[8.x] [ResponseOps] Connector OAS for framework fields (#192767)#193349
kibanamachine merged 1 commit intoelastic:8.xfrom
kibanamachine:backport/8.x/pr-192767

Conversation

@kibanamachine
Copy link
Copy Markdown
Contributor

Backport

This will backport the following commits from main to 8.x:

Questions ?

Please refer to the Backport tool documentation

Resolves elastic#192778

## Summary

This PR updates the following `response` schemas as well as the legacy
route schemas for connector APIs to generate OAS documentation:
- `POST /api/actions/connector/{id?}`
- `GET /api/actions/connector/{id}`
- `POST /api/actions/connector/{id}/_execute`
- `PUT /api/actions/connector/{id}`

The `request` schemas were updated in this
[PR](elastic#191678).

### To verify

1. Start ES
2. Add `server.oas.enabled: true` to `kibana.dev.yml`
3. Start Kibana `yarn start --no-base-path`
4. `curl -s -uelastic:changeme
http://localhost:5601/api/oas\?pathStartsWith\=/api/actions/ | jq`

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
(cherry picked from commit 3c01b13)
@kibanamachine kibanamachine added the backport This PR is a backport of another PR label Sep 18, 2024
@kibanamachine kibanamachine enabled auto-merge (squash) September 18, 2024 18:58
@kibanamachine kibanamachine merged commit 45010b4 into elastic:8.x Sep 18, 2024
@kibana-ci
Copy link
Copy Markdown

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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

cc @doakalexi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants