Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 23 additions & 14 deletions apps/docs/apis/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,22 +44,31 @@ async def main() -> None:
```
```go Golang
package main
import (
"fmt"
unkey "github.com/WilfredAlmeida/unkey-go/features"

import(
"context"
unkeygo "github.com/unkeyed/unkey-go"
"github.com/unkeyed/unkey-go/models/components"
"log"
)

func main() {
apiKey := "key_3ZZ7faUrkfv1YAhffAcnKW74"
response, err := unkey.KeyVerify(apiKey)
if err != nil {
fmt.Println("Error:", err)
return
}
if response.Valid {
fmt.Println("Key is valid")
} else {
fmt.Println("Key is invalid")
}
ctx := context.Background()

s := unkeygo.New(
unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
)

res, err := s.Keys.VerifyKey(ctx, components.V1KeysVerifyKeyRequest{
APIID: unkeygo.String("api_1234"),
Key: "sk_1234",
})
if err != nil {
log.Fatal(err)
}
if res.V1KeysVerifyKeyResponse != nil {
// handle response
}
}
```
```bash cURL
Expand Down
50 changes: 48 additions & 2 deletions apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,13 @@
"libraries/ts/sdk/keys/update",
"libraries/ts/sdk/keys/update-remaining",
"libraries/ts/sdk/keys/delete",
"libraries/ts/sdk/keys/verifications"
"libraries/ts/sdk/keys/verifications",
"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"
]
},
{
Expand All @@ -327,6 +333,16 @@
"libraries/ts/sdk/apis/delete"
]
},
{
"group": "Identities",
"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": [
Expand All @@ -341,6 +357,31 @@
]
}
]
},
{
"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"
]
}
]
}
]
},
Expand Down Expand Up @@ -384,7 +425,12 @@
]
}
]
},
}
]
},
{
"group": "Community Libraries",
"pages": [
{
"group": "Elixir",
"pages": [
Expand Down
47 changes: 27 additions & 20 deletions apps/docs/libraries/ts/sdk/apis/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,33 @@ title: "Create"
description: "Create a new API"
---

<RequestExample>

```ts
const { result, error } =await unkey.apis.create({ name: "Unkey production" });
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}

console.log(result);
```

</RequestExample>

<ResponseExample>
```json
{
"result": {
"apiId" : "api_123"
}
}
```

</ResponseExample>

## Request

<ParamField body="name" type="string" required>
Expand All @@ -20,23 +47,3 @@ description: "Create a new API"

</Expandable>
</ResponseField>

<RequestExample>

```ts
await unkey.apis.create({ name: "Unkey production" });
```

</RequestExample>

##
<ResponseExample>
```ts
{
result: {
apiId : "api_123"
}
}
```

</ResponseExample>
38 changes: 28 additions & 10 deletions apps/docs/libraries/ts/sdk/apis/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,31 @@ title: "Delete"
description: "Permanently delete an API and revoke all keys associated with it."
---

<RequestExample>

```ts
const { result, error } = await unkey.apis.delete({ apiId: "api_123" });

if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}

console.log(result);
```

</RequestExample>
<ResponseExample>
```json
{
"result": {}
}
```
</ResponseExample>


## Request

<ParamField body="apiId" type="string" required>
Expand All @@ -11,13 +36,6 @@ description: "Permanently delete an API and revoke all keys associated with it."

## Response

No response, but if no error is returned the API has been deleted successfully.

<RequestExample>

```ts
await unkey.apis.delete({ apiId: "api_123" });
```

</RequestExample>

<ResponseField name="result">
`{}`
</ResponseField>
57 changes: 32 additions & 25 deletions apps/docs/libraries/ts/sdk/apis/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@ title: "Get"
description: "Retrieve the configuration of an API"
---

<RequestExample>

```ts
const { result, error } = await unkey.apis.get({
apiId: "api_123",
});

if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}

console.log(result);
```

</RequestExample>

<ResponseExample>
```json
{
"result": {
"id": 'api_123',
"name": 'My API',
"workspaceId": 'ws_123'
}
}
```

</ResponseExample>

## Request

<ParamField body="apiId" type="string" required>
Expand All @@ -28,28 +60,3 @@ description: "Retrieve the configuration of an API"

</Expandable>
</ResponseField>

<RequestExample>

```ts
const api = await unkey.apis.get({
apiId: "api_123",
});

console.log(api);
```

</RequestExample>

<ResponseExample>
```ts
{
result: {
id: 'api_123',
name: 'My API',
workspaceId: 'ws_123'
}
}
```

</ResponseExample>
88 changes: 48 additions & 40 deletions apps/docs/libraries/ts/sdk/apis/list-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,54 @@ title: "List Keys"
description: "Get a list of keys belonging to an API"
---

<RequestExample>

```ts
const { result, error } = await unkey.apis.listKeys({
apiId: "api_QUGih1EMtBy9eSSf3vujmF",
limit: 100,
})

if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}

console.log(result)
```

</RequestExample>

<ResponseExample>
```json
{
"result": {
"keys": [
{
"id": "key_HPnfviesBEKHnZBFFiY4fg",
"apiId": "api_QUGih1EMtBy9eSSf3vujmF",
"workspaceId": "ws_o17fS1LvwtRswPdncAcUM",
"start": "key_Crg",
"createdAt": 1687642066782,
"expires": null,
"ratelimit": {
"type": "fast",
"limit": 11,
"refillRate": 11,
"refillInterval": 11
}
},
...
],
"total": 4
}
}
```

</ResponseExample>

## Request

<ParamField body="apiId" type="string" required>
Expand Down Expand Up @@ -135,43 +183,3 @@ In milliseconds

</Expandable>
</ResponseField>

<RequestExample>

```ts
const listKeys = await unkey.apis.listKeys({
apiId: "api_QUGih1EMtBy9eSSf3vujmF",
limit: 100,
})

console.log(listKeys)

```

</RequestExample>

<ResponseExample>
```ts
{
"keys": [
{
"id": "key_HPnfviesBEKHnZBFFiY4fg",
"apiId": "api_QUGih1EMtBy9eSSf3vujmF",
"workspaceId": "ws_o17fS1LvwtRswPdncAcUM",
"start": "key_Crg",
"createdAt": 1687642066782,
"expires": null,
"ratelimit": {
"type": "fast",
"limit": 11,
"refillRate": 11,
"refillInterval": 11
}
},
...
],
"total": 4
}
```

</ResponseExample>
Loading