Skip to content

feat: scalar-typescript-sdk@0.2.5 #33

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

Closed
amritk wants to merge 1 commit into from
Closed

feat: scalar-typescript-sdk@0.2.5 #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ npm install @scalar/sdk
## Usage

```ts
import ScalarAPI from "@scalar/sdk";
import Scalar from "@scalar/sdk";

const client = new ScalarAPI({
const client = new Scalar({
bearerAuth: process.env["BEARER_AUTH"], // defaults to the BEARER_AUTH env var
environment: "production",
});
Expand Down Expand Up @@ -156,9 +156,9 @@ Documented error statuses: `400`, `401`, `403`, `404`, `422`, `500`.
Configure the generated client by setting any of these options when you create it.

```ts
import ScalarAPI from "@scalar/sdk";
import Scalar from "@scalar/sdk";

const client = new ScalarAPI({
const client = new Scalar({
timeout: 60000,
maxRetries: 2,
logLevel: "debug",
Expand Down
118 changes: 23 additions & 95 deletions api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ Complete reference of every operation, grouped by resource. See [the README](./R
## Setup

```ts
import ScalarAPI from "@scalar/sdk";
import Scalar from "@scalar/sdk";

const client = new ScalarAPI({
const client = new Scalar({
bearerAuth: process.env["BEARER_AUTH"], // defaults to the BEARER_AUTH env var
environment: "production",
});
Expand Down Expand Up @@ -126,38 +126,23 @@ Update metadata for an API document.
| Request | [`RegistryUpdateAPIDocumentParams`](./src/resources/registry.ts) |

```ts
await client.registry.updateAPIDocument("slug", {
namespace: "namespace",
});
await client.registry.updateAPIDocument("namespace", "slug", {});
```

### Delete API Document

Delete an API document and all versions.

| Direction | Type |
| --- | --- |
| Request | [`RegistryDeleteAPIDocumentParams`](./src/resources/registry.ts) |

```ts
await client.registry.deleteAPIDocument("slug", {
namespace: "namespace",
});
await client.registry.deleteAPIDocument("namespace", "slug");
```

### Get API Document

Get a specific API document version.

| Direction | Type |
| --- | --- |
| Request | [`RegistryRetrieveAPIDocumentVersionParams`](./src/resources/registry.ts) |

```ts
const string_ = await client.registry.retrieveAPIDocumentVersion("semver", {
namespace: "namespace",
slug: "slug",
});
const string_ = await client.registry.retrieveAPIDocumentVersion("namespace", "slug", "semver");
```

### Update API Document version
Expand All @@ -170,9 +155,7 @@ Update the registry file content for an API document version.
| Response | [`RegistryUpdateAPIDocumentVersionResponse`](./src/resources/registry.ts) |

```ts
const updateAPIDocumentVersion = await client.registry.updateAPIDocumentVersion("semver", {
namespace: "namespace",
slug: "slug",
const updateAPIDocumentVersion = await client.registry.updateAPIDocumentVersion("namespace", "slug", "semver", {
document: "",
});
```
Expand All @@ -181,15 +164,8 @@ const updateAPIDocumentVersion = await client.registry.updateAPIDocumentVersion(

Delete a specific API document version.

| Direction | Type |
| --- | --- |
| Request | [`RegistryDeleteAPIDocumentVersionParams`](./src/resources/registry.ts) |

```ts
await client.registry.deleteAPIDocumentVersion("semver", {
namespace: "namespace",
slug: "slug",
});
await client.registry.deleteAPIDocumentVersion("namespace", "slug", "semver");
```

### Get API Document version metadata
Expand All @@ -198,14 +174,10 @@ Get metadata (uid, content shas, version sha, tags) for a specific API document

| Direction | Type |
| --- | --- |
| Request | [`RegistryListAPIDocumentVersionMetadataParams`](./src/resources/registry.ts) |
| Response | [`ManagedDocVersion`](./src/resources/registry.ts) |

```ts
const managedDocVersion = await client.registry.listAPIDocumentVersionMetadata("semver", {
namespace: "namespace",
slug: "slug",
});
const managedDocVersion = await client.registry.listAPIDocumentVersionMetadata("namespace", "slug", "semver");
```

### Create API Document version
Expand All @@ -218,8 +190,7 @@ Create a new API document version.
| Response | [`ManagedDocVersion`](./src/resources/registry.ts) |

```ts
const managedDocVersion = await client.registry.createAPIDocumentVersion("slug", {
namespace: "namespace",
const managedDocVersion = await client.registry.createAPIDocumentVersion("namespace", "slug", {
version: "",
document: "",
});
Expand All @@ -234,8 +205,7 @@ Add an access group to an API document.
| Request | [`RegistryCreateAPIDocumentAccessGroupParams`](./src/resources/registry.ts) |

```ts
await client.registry.createAPIDocumentAccessGroup("slug", {
namespace: "namespace",
await client.registry.createAPIDocumentAccessGroup("namespace", "slug", {
accessGroupSlug: "",
});
```
Expand All @@ -249,8 +219,7 @@ Remove an access group from an API document.
| Request | [`RegistryDeleteAPIDocumentAccessGroupParams`](./src/resources/registry.ts) |

```ts
await client.registry.deleteAPIDocumentAccessGroup("slug", {
namespace: "namespace",
await client.registry.deleteAPIDocumentAccessGroup("namespace", "slug", {
accessGroupSlug: "",
});
```
Expand Down Expand Up @@ -296,23 +265,15 @@ Update schema metadata.
| Request | [`SchemaUpdateParams`](./src/resources/schemas/schemas.ts) |

```ts
await client.schemas.update("slug", {
namespace: "namespace",
});
await client.schemas.update("namespace", "slug", {});
```

### Delete a shared component

Delete a schema and all related versions.

| Direction | Type |
| --- | --- |
| Request | [`SchemaDeleteParams`](./src/resources/schemas/schemas.ts) |

```ts
await client.schemas.delete("slug", {
namespace: "namespace",
});
await client.schemas.delete("namespace", "slug");
```

### `Schemas Version`
Expand All @@ -321,30 +282,16 @@ await client.schemas.delete("slug", {

Get a specific schema version document.

| Direction | Type |
| --- | --- |
| Request | [`VersionRetrieveSchemaParams`](./src/resources/schemas/version.ts) |

```ts
const string_ = await client.schemas.version.retrieveSchema("semver", {
namespace: "namespace",
slug: "slug",
});
const string_ = await client.schemas.version.retrieveSchema("namespace", "slug", "semver");
```

#### Delete a shared component version

Delete a schema version.

| Direction | Type |
| --- | --- |
| Request | [`VersionDeleteSchemaParams`](./src/resources/schemas/version.ts) |

```ts
await client.schemas.version.deleteSchema("semver", {
namespace: "namespace",
slug: "slug",
});
await client.schemas.version.deleteSchema("namespace", "slug", "semver");
```

#### Create a shared component version
Expand All @@ -357,8 +304,7 @@ Create a schema version.
| Response | [`UID`](./src/resources/schemas/version.ts) |

```ts
const uID = await client.schemas.version.createSchema("slug", {
namespace: "namespace",
const uID = await client.schemas.version.createSchema("namespace", "slug", {
version: "",
document: "",
});
Expand All @@ -375,8 +321,7 @@ Add an access group to a schema.
| Request | [`AccessGroupCreateSchemaParams`](./src/resources/schemas/access-group.ts) |

```ts
await client.schemas.accessGroup.createSchema("slug", {
namespace: "namespace",
await client.schemas.accessGroup.createSchema("namespace", "slug", {
accessGroupSlug: "",
});
```
Expand All @@ -390,8 +335,7 @@ Remove an access group from a schema.
| Request | [`AccessGroupDeleteSchemaParams`](./src/resources/schemas/access-group.ts) |

```ts
await client.schemas.accessGroup.deleteSchema("slug", {
namespace: "namespace",
await client.schemas.accessGroup.deleteSchema("namespace", "slug", {
accessGroupSlug: "",
});
```
Expand Down Expand Up @@ -527,37 +471,23 @@ Update rule metadata by slug.
| Request | [`RuleUpdateRulesetParams`](./src/resources/rules.ts) |

```ts
await client.rules.updateRuleset("slug", {
namespace: "namespace",
});
await client.rules.updateRuleset("namespace", "slug", {});
```

### Delete a rule

Delete a rule by slug.

| Direction | Type |
| --- | --- |
| Request | [`RuleDeleteRulesetParams`](./src/resources/rules.ts) |

```ts
await client.rules.deleteRuleset("slug", {
namespace: "namespace",
});
await client.rules.deleteRuleset("namespace", "slug");
```

### Get a rule

Get a rule document by slug.

| Direction | Type |
| --- | --- |
| Request | [`RuleRetrieveRulesetDocumentParams`](./src/resources/rules.ts) |

```ts
const string_ = await client.rules.retrieveRulesetDocument("slug", {
namespace: "namespace",
});
const string_ = await client.rules.retrieveRulesetDocument("namespace", "slug");
```

### Add rule access group
Expand All @@ -569,8 +499,7 @@ Grant an access group to a rule.
| Request | [`RuleCreateRulesetAccessGroupParams`](./src/resources/rules.ts) |

```ts
await client.rules.createRulesetAccessGroup("slug", {
namespace: "namespace",
await client.rules.createRulesetAccessGroup("namespace", "slug", {
accessGroupSlug: "",
});
```
Expand All @@ -584,8 +513,7 @@ Remove an access group from a rule.
| Request | [`RuleDeleteRulesetAccessGroupParams`](./src/resources/rules.ts) |

```ts
await client.rules.deleteRulesetAccessGroup("slug", {
namespace: "namespace",
await client.rules.deleteRulesetAccessGroup("namespace", "slug", {
accessGroupSlug: "",
});
```
Expand Down
Loading
Loading