Skip to content

Show Learn readers how to make their first Lovat API request - #136

Merged
jackshim415 merged 3 commits into
mainfrom
codex/lvt-237-learn-api-guide
Nov 21, 2026
Merged

jackshim415 merged 3 commits into
mainfrom
codex/lvt-237-learn-api-guide

Conversation

@jackshim415

Copy link
Copy Markdown
Contributor

Add a Lovat API section to Learn with a guide to bearer credentials, a read-only team lookup, and structured errors. The guide links to the interactive API reference and its OpenAPI JSON.

Verification

  • npm ci, npm run build (17 pages), npm test (20 passing), npm run lint, npm run format:check, and npm run test:typecheck passed.
  • Verified that the generated article exists and the generated sidebar links to it. The example uses a placeholder environment variable for the API key.

Refs: LVT-237.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-20T23:52:22.997420Z 438ab58 PR opened
🔒 Security Review ✅ Completed 2026-11-20T23:52:31.242092Z 438ab58 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@railway-app
railway-app Bot temporarily deployed to lovat / lovat-pr-136 November 20, 2026 23:50 Destroyed
@railway-app

railway-app Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

🚅 Deployed to the lovat-pr-136 environment in lovat

Service Status Web Updated
api ✅ Success (View Logs) Web Nov 21, 2026 at 5:42 am UTC
website ✅ Success (View Logs) Web Nov 21, 2026 at 5:41 am UTC
learn ✅ Success (View Logs) Web Nov 21, 2026 at 5:39 am UTC
worker ⏭️ Skipped (View Logs) Nov 21, 2026 at 5:39 am UTC
dashboard 😴 Sleeping (View Logs) Web Nov 21, 2026 at 12:02 am UTC
2 services not affected by this PR
  • support
  • worker

@github-actions

github-actions Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Lovat AI review

Status: completed · Model: z-ai/glm-5.3-flash · Findings: 0

Reviewed commit: 4240b93beb58bcce0e4736d41a6050cdeda797a4

Critical: 0 · High: 0 · Medium: 0 · Low: 0

Overall assessment

This pull request is documentation-only: it adds a Learn guide page and a matching sidebar entry. No application code, contracts, or data paths are changed. The guide contains no committed secrets and does not alter any shipped behavior, so no concrete defects are evidenced in the diff.

No high-confidence issues were found in the reviewed changes.

Review details

  • Review batches: 1
  • Diff characters reviewed: 3,389
  • Tokens: 3,026 prompt + 378 completion
  • Estimated inference cost: $0.0004

Limitations

  • The reviewer examined only changed lines and their diff context, not the whole repository.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 438ab581fa

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


Send your credential in the `Authorization` header as a bearer token. Use an `lvt-` API key for scripts that support key authentication. The [API reference](https://api.lovat.app/v1/doc/) lists the authentication, parameters, and permissions for each operation.

If you need a key, use the **Create a new API key** operation under **Manager - API Keys** in the reference. Creating a key requires an Auth0 access token for a signed-in account on a verified Lovat team. Enter a name that identifies the integration. Save the returned `apiKey` in your integration's secret store. The list operation returns metadata, so copy the key when you create it. Revoke it in the reference if it is exposed.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Explain how to obtain the bootstrap Auth0 token

For a reader who does not already have an API key, this step is not actionable: the Server's OpenAPI configuration defines only a plain bearer-token field (apps/server/src/lib/openapi.ts:58-63), and its Swagger setup has no Auth0 sign-in or token-acquisition flow (apps/server/src/routes/index.ts:27-34). Merely being signed in to a Lovat account therefore does not authenticate the reference. Document the supported way to obtain and paste the Auth0 access token, or link to a key-creation UI, so a new reader can actually reach the curl example.

AGENTS.md reference: apps/learn/AGENTS.md:L9-L9

Useful? React with 👍 / 👎.

@railway-app
railway-app Bot temporarily deployed to lovat / lovat-pr-136 November 21, 2026 05:39 Destroyed
@jackshim415
jackshim415 merged commit 1a59b16 into main Nov 21, 2026
27 checks passed

This branch was successfully deployed

No deployments
lovat / lovat-pr-136 — 4240b93b Deployed Nov 21, 2026 by railway-app[bot]
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