Skip to content

docs: update sdks #3712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 1, 2025
Merged

docs: update sdks #3712

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
61a8bfd
docs: update sdks
chronark Aug 1, 2025
9eefa47
Update nextjs.mdx
chronark Aug 1, 2025
0d24641
[autofix.ci] apply automated fixes
autofix-ci[bot] Aug 1, 2025
5899e4c
fix: rabbit feedback
chronark Aug 1, 2025
403ea27
Merge branch '08-01-docs_update_sdks' of https://github.com/unkeyed/u…
chronark Aug 1, 2025
7daf3ee
Update nextjs.mdx
chronark Aug 1, 2025
6402def
fix: root key is required
chronark Aug 1, 2025
137ac8d
Merge branch '08-01-docs_update_sdks' of https://github.com/unkeyed/u…
chronark Aug 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 44 additions & 114 deletions apps/docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@
},
{
"group": "Identities",
"pages": ["quickstart/identities/shared-ratelimits"]
"pages": [
"quickstart/identities/shared-ratelimits"
]
}
]
},
Expand Down Expand Up @@ -83,7 +85,10 @@
{
"group": "Identities",
"icon": "fingerprint",
"pages": ["concepts/identities/overview", "concepts/identities/ratelimits"]
"pages": [
"concepts/identities/overview",
"concepts/identities/ratelimits"
]
}
]
},
Expand Down Expand Up @@ -138,12 +143,18 @@
{
"group": "Audit logs",
"icon": "scroll",
"pages": ["audit-log/introduction", "audit-log/types"]
"pages": [
"audit-log/introduction",
"audit-log/types"
]
},
{
"group": "Analytics",
"icon": "chart-bar",
"pages": ["analytics/overview", "analytics/quickstarts"]
"pages": [
"analytics/overview",
"analytics/quickstarts"
]
}
]
},
Expand All @@ -153,7 +164,10 @@
{
"icon": "plane",
"group": "Migrating API Keys",
"pages": ["migrations/introduction", "migrations/keys"]
"pages": [
"migrations/introduction",
"migrations/keys"
]
}
]
},
Expand Down Expand Up @@ -212,7 +226,9 @@
},
{
"group": "User Errors",
"pages": ["errors/user/bad_request/permissions_query_syntax_error"]
"pages": [
"errors/user/bad_request/permissions_query_syntax_error"
]
}
]
}
Expand Down Expand Up @@ -282,130 +298,40 @@
"icon": "code",
"pages": [
{
"group": "@unkey/api",
"group": "Typescript",
"pages": [
"libraries/ts/sdk/overview",
{
"group": "Keys",
"pages": [
"libraries/ts/sdk/keys/create",
"libraries/ts/sdk/keys/verify",
"libraries/ts/sdk/keys/get",
"libraries/ts/sdk/keys/update",
"libraries/ts/sdk/keys/update-remaining",
"libraries/ts/sdk/keys/delete",
"libraries/ts/sdk/keys/add-permission",
"libraries/ts/sdk/keys/remove-permission",
"libraries/ts/sdk/keys/set-permission",
"libraries/ts/sdk/keys/add-roles",
"libraries/ts/sdk/keys/remove-roles",
"libraries/ts/sdk/keys/set-roles"
]
},
{
"group": "Analytics",
"pages": ["libraries/ts/sdk/analytics/get"]
},
{
"group": "APIs",
"pages": [
"libraries/ts/sdk/apis/create",
"libraries/ts/sdk/apis/get",
"libraries/ts/sdk/apis/list-keys",
"libraries/ts/sdk/apis/delete"
]
},
"libraries/ts/api",
{
"group": "Identities",
"group": "@unkey/ratelimit",
"pages": [
"libraries/ts/sdk/identities/create-identity",
"libraries/ts/sdk/identities/get-identity",
"libraries/ts/sdk/identities/update-identity",
"libraries/ts/sdk/identities/list-identity",
"libraries/ts/sdk/identities/delete-identity"
]
},
{
"group": "Ratelimits",
"pages": [
"libraries/ts/sdk/ratelimits/limit",
"libraries/ts/ratelimit/ratelimit",
{
"group": "Overrides",
"pages": [
"libraries/ts/sdk/ratelimits/overrides/set-override",
"libraries/ts/sdk/ratelimits/overrides/get-override",
"libraries/ts/sdk/ratelimits/overrides/list-overrides",
"libraries/ts/sdk/ratelimits/overrides/delete-override"
"libraries/ts/ratelimit/override/overview",
"libraries/ts/ratelimit/override/set-override",
"libraries/ts/ratelimit/override/get-override",
"libraries/ts/ratelimit/override/list-overrides",
"libraries/ts/ratelimit/override/delete-override"
]
}
]
},
{
"group": "Migrations",
"pages": ["libraries/ts/sdk/migrations/migrate-to-unkey"]
},
{
"group": "Permissions",
"pages": [
{
"group": "Roles",
"pages": [
"libraries/ts/sdk/permissions/create-role",
"libraries/ts/sdk/permissions/get-role",
"libraries/ts/sdk/permissions/delete-role"
]
},
{
"group": "Permissions",
"pages": [
"libraries/ts/sdk/permissions/create-permission",
"libraries/ts/sdk/permissions/get-permission",
"libraries/ts/sdk/permissions/delete-permission"
]
}
]
}
"libraries/ts/nextjs",
"libraries/ts/hono",
"libraries/ts/cache/overview"
]
},
{
"group": "@unkey/ratelimit",
"group": "Go",
"pages": [
"libraries/ts/ratelimit/ratelimit",
{
"group": "Overrides",
"pages": [
"libraries/ts/ratelimit/override/overview",
"libraries/ts/ratelimit/override/set-override",
"libraries/ts/ratelimit/override/get-override",
"libraries/ts/ratelimit/override/list-overrides",
"libraries/ts/ratelimit/override/delete-override"
]
}
"libraries/go/api"
]
},
"libraries/ts/nextjs",
"libraries/ts/hono",
"libraries/ts/cache/overview",
{
"group": "unkey-go",
"pages": ["libraries/go/overview"]
},
{
"group": "unkey.py",
"group": "Python",
"pages": [
"libraries/py/overview",
"libraries/py/async",
{
"group": "Services",
"pages": [
"libraries/py/services/keys",
"libraries/py/services/apis",
"libraries/py/services/permissions",
"libraries/py/services/migrations",
"libraries/py/services/identities",
"libraries/py/services/ratelimits"
]
}
"libraries/py/api"
]
}
]
Expand All @@ -431,11 +357,15 @@
},
{
"group": "Nuxt",
"pages": ["libraries/nuxt/overview"]
"pages": [
"libraries/nuxt/overview"
]
},
{
"group": "Rust",
"pages": ["libraries/rs/overview"]
"pages": [
"libraries/rs/overview"
]
},
{
"group": "Springboot",
Expand Down
59 changes: 59 additions & 0 deletions apps/docs/libraries/go/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "unkey-go"
description: "Unkey's API provides programmatic access for all resources within our platform."
---

## SDK Installation

To add the SDK as a dependency to your project:

```bash
go get github.com/unkeyed/sdks/api/go/v2
```

## SDK Example Usage

### Example

```go
package main

import (
"context"
unkey "github.com/unkeyed/sdks/api/go/v2"
"github.com/unkeyed/sdks/api/go/v2/models/components"
"log"
"os"
)

func main() {
ctx := context.Background()

s := unkey.New(
unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
)

res, err := s.Apis.CreateAPI(ctx, components.V2ApisCreateAPIRequestBody{
Name: "payment-service-production",
})
if err != nil {
log.Fatal(err)
}
if res.V2ApisCreateAPIResponseBody != nil {
// handle response
}
}

```

## Repository

{" "}
<Card
title="GitHub"
icon="github"
href="https://github.com/unkeyed/sdks/blob/main/api/go/README.md"
cta="README"
>
The full autogenerated documentation can be found on GitHub.
</Card>
Loading