Skip to content

docs(api): publish public API beta M2 reference — tests, latest executions, per-test history (APP-1554) - #2332

Merged
MikaKerman merged 6 commits into
docsfrom
app-1554-public-api-m2-docs
Aug 24, 2026
Merged

docs(api): publish public API beta M2 reference — tests, latest executions, per-test history (APP-1554)#2332
MikaKerman merged 6 commits into
docsfrom
app-1554-public-api-m2-docs

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Summary

The tests / latest-test-executions / test-executions endpoints are now live (elementary-data/elementary-internal#7331), so their six reference pages stop being hand-written "coming soon" contracts and become generated ones. Each page collapses to the standard openapi stub used by the assets and columns pages.

docs/api-reference/beta/openapi.json is refreshed from the generated snapshot in the API repo (the same file the enforce_up_to_date_openapi check guards), so parameters, filters, enums, and the items / next_cursor / has_more envelope now come from the served schema instead of prose that can drift. Notably the hand-written history page described the direction default in a way the real endpoint does not implement (start_time DESC by default, direction applying to whichever order_by is in play) — the generated schema is authoritative.

Guide pages (introduction, authentication, incremental-sync) no longer mark tests as coming soon: the resource table, tests view-scope, and incremental support matrix describe the live M2 surface.

No docs.json changes: all six pages were already in the navigation.

Code-quality is expected to fail on this docs PR (prettier/openapi snapshot formatting) and is not a merge blocker.

Test plan

  • Confirm Mintlify renders the six OpenAPI stubs from api-reference/beta/openapi.json
  • Confirm intro / auth / incremental-sync no longer say coming soon for tests
  • Spot-check tests incremental vs latest snapshot vs per-test history in the generated reference

Link to Devin session: https://app.devin.ai/sessions/5178cb6e376846f180e423e43f8a4f79
Requested by: @MikaKerman

…tions, per-test history (APP-1554)

Co-Authored-By: mika@elementary-data.com <mika.kerman@gmail.com>
@linear

linear Bot commented Aug 21, 2026

Copy link
Copy Markdown

APP-1554

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@coderabbitai

coderabbitai Bot commented Aug 21, 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: fc81bf4e-b644-40e4-8627-b7394795e73f

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.

devin-ai-integration Bot and others added 5 commits August 22, 2026 09:12
Co-Authored-By: mika@elementary-data.com <mika.kerman@gmail.com>
Co-Authored-By: mika@elementary-data.com <mika.kerman@gmail.com>
Co-Authored-By: mika@elementary-data.com <mika.kerman@gmail.com>
…(APP-1554)

The six reference pages already use generated OpenAPI stubs; the intro,
auth, and incremental-sync guides still described tests as not shipping.

Co-authored-by: Cursor <cursoragent@cursor.com>
The internal OpenAPI snapshot used app.elementary-data.com/api, which is
the frontend host and breaks Mintlify Try it. The docs branch already
served prod.api.elementary-data.com.

Co-authored-by: Cursor <cursoragent@cursor.com>
@MikaKerman
MikaKerman merged commit 3fdaafc into docs Aug 24, 2026
5 of 6 checks passed
@MikaKerman
MikaKerman deleted the app-1554-public-api-m2-docs branch August 24, 2026 18:00
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