Skip to content

feat: access-service-typescript@0.1.1 #11

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: access-service-typescript@0.1.1 #11

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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Developer-friendly, idiomatic Typescript SDK for the *access-service-typescript*

## Summary

Scalar API: Public facing api to manage all scalar platform entities
Access Service: Public facing api to manage all scalar platform entities
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
Expand Down Expand Up @@ -154,6 +154,10 @@ run();
* [postv1ApisNamespaceSlugAccessGroup](docs/sdks/apidocs/README.md#postv1apisnamespaceslugaccessgroup) - Add API access group
* [deletev1ApisNamespaceSlugAccessGroup](docs/sdks/apidocs/README.md#deletev1apisnamespaceslugaccessgroup) - Delete API access group

### [auth](docs/sdks/auth/README.md)

* [postv1AuthExchange](docs/sdks/auth/README.md#postv1authexchange) - Exchange token

### [guides](docs/sdks/guides/README.md)

* [getv1Guides](docs/sdks/guides/README.md#getv1guides) - List all projects
Expand Down Expand Up @@ -227,6 +231,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`apiDocsPostv1ApisNamespace`](docs/sdks/apidocs/README.md#postv1apisnamespace) - Create an API
- [`apiDocsPostv1ApisNamespaceSlugAccessGroup`](docs/sdks/apidocs/README.md#postv1apisnamespaceslugaccessgroup) - Add API access group
- [`apiDocsPostv1ApisNamespaceSlugVersion`](docs/sdks/apidocs/README.md#postv1apisnamespaceslugversion) - Create version
- [`authPostv1AuthExchange`](docs/sdks/auth/README.md#postv1authexchange) - Exchange token
- [`guidesGetv1Guides`](docs/sdks/guides/README.md#getv1guides) - List all projects
- [`guidesPostv1Guides`](docs/sdks/guides/README.md#postv1guides) - Create new project
- [`guidesPostv1GuidesSlugPublish`](docs/sdks/guides/README.md#postv1guidesslugpublish) - Publish project
Expand Down
6 changes: 6 additions & 0 deletions code-samples.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ actions:
- "lang": "typescript"
"label": "getv1ApisNamespaceSlugVersionSemver"
"source": "import { Scalar } from \"@scalar/sdk\";\n\nconst scalar = new Scalar({\n bearerAuth: \"<YOUR_BEARER_TOKEN_HERE>\",\n});\n\nasync function run() {\n const result = await scalar.apiDocs.getv1ApisNamespaceSlugVersionSemver({\n namespace: \"<value>\",\n slug: \"<value>\",\n semver: \"<value>\",\n });\n\n console.log(result);\n}\n\nrun();"
- target: $["paths"]["/v1/auth/exchange"]["post"]
update:
"x-codeSamples":
- "lang": "typescript"
"label": "postv1AuthExchange"
"source": "import { Scalar } from \"@scalar/sdk\";\n\nconst scalar = new Scalar();\n\nasync function run() {\n const result = await scalar.auth.postv1AuthExchange({\n personalToken: \"<value>\",\n });\n\n console.log(result);\n}\n\nrun();"
- target: $["paths"]["/v1/guides"]["get"]
update:
"x-codeSamples":
Expand Down
6 changes: 2 additions & 4 deletions docs/models/components/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@
```typescript
import { Security } from "@scalar/sdk/models/components";

let value: Security = {
bearerAuth: "<value>",
};
let value: Security = {};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `bearerAuth` | *string* | :heavy_check_mark: | N/A |
| `bearerAuth` | *string* | :heavy_minus_sign: | N/A |
15 changes: 15 additions & 0 deletions docs/models/operations/embedstatus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# EmbedStatus

## Example Usage

```typescript
import { EmbedStatus } from "@scalar/sdk/models/operations";

let value: EmbedStatus = "complete";
```

## Values

```typescript
"complete" | "failed"
```
7 changes: 3 additions & 4 deletions docs/models/operations/getv1guidesresponsebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import { Getv1GuidesResponseBody } from "@scalar/sdk/models/operations";

let value: Getv1GuidesResponseBody = {
uid: "<id>",
name: "<value>",
};
```
Expand All @@ -15,7 +14,9 @@ let value: Getv1GuidesResponseBody = {

| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `uid` | *string* | :heavy_check_mark: | N/A |
| `uid` | *string* | :heavy_minus_sign: | N/A |
| `createdAt` | *number* | :heavy_minus_sign: | N/A |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `activeDeployment` | [operations.ActiveDeployment](../../models/operations/activedeployment.md) | :heavy_minus_sign: | N/A |
| `lastPublished` | *number* | :heavy_minus_sign: | N/A |
Expand All @@ -25,8 +26,6 @@ let value: Getv1GuidesResponseBody = {
| `typesenseId` | *number* | :heavy_minus_sign: | N/A |
| `isPrivate` | *boolean* | :heavy_minus_sign: | N/A |
| `accessGroups` | *string*[] | :heavy_minus_sign: | N/A |
| `createdAt` | *number* | :heavy_minus_sign: | N/A |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
| `slug` | *string* | :heavy_minus_sign: | N/A |
| `publishStatus` | *string* | :heavy_minus_sign: | N/A |
| `publishMessage` | *string* | :heavy_minus_sign: | N/A |
Expand Down
4 changes: 2 additions & 2 deletions docs/models/operations/getv1schemasnamespaceversions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ let value: Getv1SchemasNamespaceVersions = {};
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `uid` | *string* | :heavy_minus_sign: | N/A |
| `version` | *string* | :heavy_minus_sign: | N/A |
| `createdAt` | *number* | :heavy_minus_sign: | N/A |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
| `version` | *string* | :heavy_minus_sign: | N/A |
17 changes: 17 additions & 0 deletions docs/models/operations/postv1authexchangerequestbody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Postv1AuthExchangeRequestBody

## Example Usage

```typescript
import { Postv1AuthExchangeRequestBody } from "@scalar/sdk/models/operations";

let value: Postv1AuthExchangeRequestBody = {
personalToken: "<value>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `personalToken` | *string* | :heavy_check_mark: | N/A |
19 changes: 19 additions & 0 deletions docs/models/operations/postv1authexchangeresponsebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Postv1AuthExchangeResponseBody

Default Response

## Example Usage

```typescript
import { Postv1AuthExchangeResponseBody } from "@scalar/sdk/models/operations";

let value: Postv1AuthExchangeResponseBody = {
accessToken: "<value>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `accessToken` | *string* | :heavy_check_mark: | N/A |
5 changes: 4 additions & 1 deletion docs/models/operations/repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,7 @@ let value: Repository = {
| `name` | *string* | :heavy_check_mark: | N/A |
| `configPath` | *string* | :heavy_minus_sign: | N/A |
| `branch` | *string* | :heavy_minus_sign: | N/A |
| `publishOnMerge` | *boolean* | :heavy_minus_sign: | N/A |
| `publishOnMerge` | *boolean* | :heavy_minus_sign: | N/A |
| `publishPreviews` | *boolean* | :heavy_minus_sign: | N/A |
| `prComments` | *boolean* | :heavy_minus_sign: | N/A |
| `expired` | *boolean* | :heavy_minus_sign: | N/A |
15 changes: 8 additions & 7 deletions docs/models/operations/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ let value: Versions = {

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `uid` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | *number* | :heavy_check_mark: | N/A |
| `version` | *string* | :heavy_check_mark: | N/A |
| `tags` | *string*[] | :heavy_minus_sign: | N/A |
| `corpusUid` | *string* | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `uid` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | *number* | :heavy_check_mark: | N/A |
| `version` | *string* | :heavy_check_mark: | N/A |
| `upgraded` | *boolean* | :heavy_minus_sign: | N/A |
| `embedStatus` | [operations.EmbedStatus](../../models/operations/embedstatus.md) | :heavy_minus_sign: | N/A |
| `tags` | *string*[] | :heavy_minus_sign: | N/A |
Loading