Repository navigation
Show Learn readers how to make their first Lovat API request - #136
Conversation
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
🚅 Deployed to the lovat-pr-136 environment in lovat
2 services not affected by this PR
|
Lovat AI reviewStatus: completed · Model: Reviewed commit: Critical: 0 · High: 0 · Medium: 0 · Low: 0 Overall assessmentThis 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
Limitations
|
There was a problem hiding this comment.
💡 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. |
There was a problem hiding this comment.
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 👍 / 👎.
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, andnpm run test:typecheckpassed.Refs: LVT-237.