chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: "Authentication"
|
||||
description: "How to authenticate requests to your on-premise Context7 instance"
|
||||
---
|
||||
|
||||
The on-premise API supports API keys for server-to-server and MCP access. Pass the key in the `Authorization` header:
|
||||
|
||||
```bash
|
||||
Authorization: Bearer ctx7op-xxxxxxxx_xxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
Keys are scoped to the user account that created them and inherit that user's role (`admin` or `member`). There are no per-key scopes or expiry - revoke a key to invalidate it.
|
||||
|
||||
## Creating an API Key
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Settings">
|
||||
Go to **Personal Settings > API Keys** in the admin dashboard and click **Create API Key**.
|
||||
|
||||
<Frame>
|
||||

|
||||
</Frame>
|
||||
</Step>
|
||||
<Step title="Name the key">
|
||||
Give the key a descriptive name so you know which client or service is using it (e.g. `CI pipeline`, `Cursor`).
|
||||
|
||||
<Frame>
|
||||

|
||||
</Frame>
|
||||
</Step>
|
||||
<Step title="Copy the key">
|
||||
Copy the full key value before closing the dialog. It is only shown once.
|
||||
|
||||
<Frame>
|
||||

|
||||
</Frame>
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Warning>API keys are shown only once at creation. Store yours securely before closing the dialog.</Warning>
|
||||
|
||||
## Revoking a Key
|
||||
|
||||
Go to **Settings > API Keys** and click the delete icon next to the key. Revocation is immediate and cannot be undone. Update any integrations using the key before revoking.
|
||||
|
||||
## Roles
|
||||
|
||||
| Role | Access |
|
||||
|---|---|
|
||||
| `admin` | Full access to all endpoints including settings, user management, and delete operations |
|
||||
| `member` | Can trigger parsing and search. Cannot access admin endpoints |
|
||||
|
||||
Default credentials on a fresh install are `admin` / `admin`. Change them immediately from **Settings > Change Credentials**.
|
||||
|
||||
## Anonymous Access
|
||||
|
||||
Certain operations can be allowed without authentication. Configure them from **Settings > Permissions**:
|
||||
|
||||
| Permission | Default |
|
||||
|---|---|
|
||||
| Anonymous parse / refresh | Off |
|
||||
| Anonymous delete | Off |
|
||||
|
||||
The search (`GET /v2/libs/search`) and context (`GET /v2/context`) endpoints are always publicly accessible unless a global `API_KEY` environment variable is set, in which case every endpoint requires a bearer token.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Get documentation context"
|
||||
description: "Retrieve documentation snippets for a library ranked by relevance to your query"
|
||||
openapi: "openapi-enterprise.json GET /v2/context"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Get parse status"
|
||||
description: "Returns the status of all active and queued parse jobs"
|
||||
openapi: "openapi-enterprise.json GET /parse-status"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Import a library bundle"
|
||||
description: "Import pre-parsed libraries into an airgapped on-premise install, as a JSON body or a Context7 Cloud export file"
|
||||
openapi: "openapi-enterprise.json POST /import-libraries"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Parse a Git repository"
|
||||
description: "Queue a GitHub or GitLab repository for parsing and indexing"
|
||||
openapi: "openapi-enterprise.json POST /parse"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Parse a website"
|
||||
description: "Crawl and index a public website starting from the given URL"
|
||||
openapi: "openapi-enterprise.json POST /parse-website"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Parse an OpenAPI spec by URL"
|
||||
description: "Queue a remote OpenAPI specification (JSON or YAML) for parsing and indexing"
|
||||
openapi: "openapi-enterprise.json POST /parse-openapi"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Refresh a library"
|
||||
description: "Re-parse an existing library using its stored settings"
|
||||
openapi: "openapi-enterprise.json POST /projects/{projectId}/refresh"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Upload an OpenAPI spec file"
|
||||
description: "Upload an OpenAPI specification file directly for parsing and indexing"
|
||||
openapi: "openapi-enterprise.json POST /parse-openapi-upload"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Search for libraries"
|
||||
description: "Search locally indexed libraries by name"
|
||||
openapi: "openapi-enterprise.json GET /v2/libs/search"
|
||||
---
|
||||
Reference in New Issue
Block a user