Skip to content
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.

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

[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs #184956

Merged
merged 14 commits into from
Jul 25, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 6, 2024

Summary

Relates to #180056, #182779

This PR:

NOTE: I've commented out details about the kibana feature privileges since I think we'll need to quality the difference between privileges in serverless and stateful contexts.

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -uelastic http://localhost:5601/api/oas\?pathStartsWith\=/api/actions | jq > test1.json

The output will contain info like this:

      "delete": {
        "summary": "Delete a connector",
        "tags": [ "connectors" ],
        "description": "WARNING: When you delete a connector, it cannot be recovered.",
...
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "An identifier for the connector."

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs v8.15.0 labels Jun 6, 2024
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl changed the title [DOCS] Add descriptions to connector APIs [DOCS][OAS] Add descriptions, tags, deprecation to connector APIs Jul 24, 2024
@lcawl lcawl added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS and removed backport:skip This commit does not require backporting v8.15.0 labels Jul 24, 2024
@lcawl lcawl marked this pull request as ready for review July 24, 2024 22:05
@lcawl lcawl requested a review from a team as a code owner July 24, 2024 22:05
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

Copy link
Contributor

@adcoelho adcoelho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and is working as expected 👍

@lcawl lcawl enabled auto-merge (squash) July 25, 2024 20:29
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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

@lcawl lcawl merged commit e6795e5 into elastic:main Jul 25, 2024
20 checks passed
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.15 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.15:
- [OAS][DOCS] Add x-topics info about running APIs in spaces (#189144)
- [DOCS][OAS] Add data view swap saved object references and preview APIs (#187927)

Manual backport

To create the backport manually run:

node scripts/backport --pr 184956

Questions ?

Please refer to the Backport tool documentation

@lcawl
Copy link
Contributor Author

lcawl commented Jul 25, 2024

💚 All backports created successfully

Status Branch Result
8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl deleted the action-descriptions branch July 25, 2024 21:58
lcawl added a commit that referenced this pull request Jul 26, 2024
…PIs (#184956) (#189237)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs
(#184956)](#184956)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-07-25T21:46:30Z","message":"[DOCS][OAS]
Add descriptions, tags, deprecation to connector APIs
(#184956)","sha":"e6795e5b0a58f8369e354fc2806531a173b052c9","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","backport:prev-minor","Feature:OAS","v8.16.0"],"number":184956,"url":"https://github.com/elastic/kibana/pull/184956","mergeCommit":{"message":"[DOCS][OAS]
Add descriptions, tags, deprecation to connector APIs
(#184956)","sha":"e6795e5b0a58f8369e354fc2806531a173b052c9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/184956","number":184956,"mergeCommit":{"message":"[DOCS][OAS]
Add descriptions, tags, deprecation to connector APIs
(#184956)","sha":"e6795e5b0a58f8369e354fc2806531a173b052c9"}}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants