Skip to content

docs: add coming-soon public API test endpoints (APP-1552) - #2330

Merged
MikaKerman merged 2 commits into
docsfrom
app-1552-document-coming-soon-public-api-test-endpoints
Aug 20, 2026
Merged

docs: add coming-soon public API test endpoints (APP-1552)#2330
MikaKerman merged 2 commits into
docsfrom
app-1552-document-coming-soon-public-api-test-endpoints

Conversation

@MikaKerman

Copy link
Copy Markdown
Contributor

Summary

  • Documents the planned M2 public API surface (tests, latest test executions, per-test execution history) so Elastic can review the contract before the routes exist.
  • Six hand-written list/get pages with a Coming soon callout. No openapi: frontmatter and no fake OpenAPI paths, so the playground cannot 404.
  • Intro table, tests overview, incremental-sync note, and tests view-scope on authentication. Nav groups in docs.json.

Linear: APP-1552

When the API ships, replace these pages with generated OpenAPI stubs (same pattern as columns).

Test plan

  • Mintlify preview: Tests / Latest test executions / Test executions groups appear in the API Reference sidebar
  • Each of the six pages shows the Coming soon warning and example JSON
  • Intro “What you can read” lists the three coming-soon rows
  • No “Try it” playground on these pages (no OpenAPI binding)
  • Existing asset/column/lineage pages still generate from OpenAPI

Made with Cursor

Publish the planned tests / latest-test-executions / per-test history contract so design partners can review it before the routes ship. Hand-written pages, no OpenAPI stubs, so the playground cannot 404.

Co-authored-by: Cursor <cursoragent@cursor.com>
@linear

linear Bot commented Aug 20, 2026

Copy link
Copy Markdown

APP-1552

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c4b66a20-d4a8-4b53-889f-8916034b8053

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

Use Info+clock instead of Warning for coming-soon pages, and rename the nested history page so it is clearly per-test.

Co-authored-by: Cursor <cursoragent@cursor.com>
@MikaKerman
MikaKerman merged commit 27a60c3 into docs Aug 20, 2026
4 of 5 checks passed
@MikaKerman
MikaKerman deleted the app-1552-document-coming-soon-public-api-test-endpoints branch August 20, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant