Skip to content

[ResponseOps][PerUserAuth] Add API availability docs to OAuth callback routes#262292

Merged
jcger merged 3 commits intoelastic:mainfrom
jcger:issue-257715-oauth-api-docs
Apr 10, 2026
Merged

[ResponseOps][PerUserAuth] Add API availability docs to OAuth callback routes#262292
jcger merged 3 commits intoelastic:mainfrom
jcger:issue-257715-oauth-api-docs

Conversation

@jcger
Copy link
Copy Markdown
Contributor

@jcger jcger commented Apr 9, 2026

Summary

Closes #257715

Adds availability: { since: '9.4.0' } to the two public OAuth routes introduced in #252369 (OAuth 2.0 Authorization Code Grant):

  • GET /api/actions/connector/_oauth_callback
  • GET /api/actions/connector/_oauth_callback_script

This ensures the generated API docs show "Added in 9.4" for both serverless and stack (non-serverless) documentation.

The two internal routes (_start_oauth_flow, _oauth_disconnect) don't need this annotation — the framework only applies availability to public routes, and internal routes are excluded from the OAS output.

@jcger jcger requested a review from florent-leborgne April 9, 2026 14:05
@jcger jcger requested a review from a team as a code owner April 9, 2026 14:05
@jcger jcger added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// docs backport:version Backport to applied version labels v9.4.0 v9.5.0 labels Apr 9, 2026
@elasticmachine
Copy link
Copy Markdown
Contributor

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

@elastic-vault-github-plugin-prod elastic-vault-github-plugin-prod bot requested a review from a team as a code owner April 9, 2026 14:41
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

LGTM for docs, thanks for adding this!

@elasticmachine
Copy link
Copy Markdown
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #130 / Detections Response - Detection rule type telemetry @ess @serverless Detection rule status telemetry "eql" rule type should have non zero values for "index_duration"
  • [job] [logs] FTR Configs #204 / Endpoint plugin @ess @serverless @skipInServerlessMKI Endpoint policy response api GET /api/endpoint/policy_response "before all" hook for "should return one policy response for an id"

Metrics [docs]

✅ unchanged

@jcger jcger merged commit 6e4d5bb into elastic:main Apr 10, 2026
11 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 9.5

https://github.com/elastic/kibana/actions/runs/24233530658

@kibanamachine
Copy link
Copy Markdown
Contributor

💔 All backports failed

Status Branch Result
9.5 The branch "9.5" does not exist

Manual backport

To create the backport manually run:

node scripts/backport --pr 262292

Questions ?

Please refer to the Backport tool documentation

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

Labels

backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v9.4.0 v9.5.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ResponseOps][PerUserAuth] 9.4 related documentation

5 participants