Skip to content

Commit

Permalink
Merge main into sweep/update_the_docstrings_and_comments_in_sd_87fed
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] authored Apr 18, 2024
2 parents da09b88 + 5d511a4 commit 365e9f2
Show file tree
Hide file tree
Showing 25 changed files with 304 additions and 221 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/generate-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Generate docs on merge to dev
run-name: ${{ github.actor }} is generating documentation

on:
push:
branches:
- "dev"
- "main"

jobs:
Generate-Docs-For-TS-SDK:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"

- name: Cache npm dependencies
uses: actions/cache@v4
with:
path: sdks/ts/node_modules
key: ${{ runner.os }}-sdks-ts-npm-${{ hashFiles('sdks/ts/package-lock.json') }}
restore-keys: |
${{ runner.os }}-sdks-ts-npm-
- name: Install npm dependencies
run: |
cd sdks/ts
npm ci
- name: Generate docs
run: |
cd sdks/ts
npm run generate-docs
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "doc(sdks/ts): Generate docs for sdks/ts (CI)"
branch: ${{ github.head_ref }}

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
12 changes: 6 additions & 6 deletions docs/js-sdk-docs/classes/api.ApiError.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Error.constructor

#### Defined in

[src/api/core/ApiError.ts:15](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/ApiError.ts#L15)
[src/api/core/ApiError.ts:15](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/ApiError.ts#L15)

## Properties

Expand All @@ -67,7 +67,7 @@ Error.constructor

#### Defined in

[src/api/core/ApiError.ts:12](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/ApiError.ts#L12)
[src/api/core/ApiError.ts:12](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/ApiError.ts#L12)

___

Expand Down Expand Up @@ -105,7 +105,7 @@ ___

#### Defined in

[src/api/core/ApiError.ts:13](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/ApiError.ts#L13)
[src/api/core/ApiError.ts:13](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/ApiError.ts#L13)

___

Expand All @@ -129,7 +129,7 @@ ___

#### Defined in

[src/api/core/ApiError.ts:10](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/ApiError.ts#L10)
[src/api/core/ApiError.ts:10](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/ApiError.ts#L10)

___

Expand All @@ -139,7 +139,7 @@ ___

#### Defined in

[src/api/core/ApiError.ts:11](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/ApiError.ts#L11)
[src/api/core/ApiError.ts:11](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/ApiError.ts#L11)

___

Expand All @@ -149,7 +149,7 @@ ___

#### Defined in

[src/api/core/ApiError.ts:9](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/ApiError.ts#L9)
[src/api/core/ApiError.ts:9](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/ApiError.ts#L9)

___

Expand Down
6 changes: 3 additions & 3 deletions docs/js-sdk-docs/classes/api.BaseHttpRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

#### Defined in

[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)
[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)

## Properties

Expand All @@ -46,7 +46,7 @@

#### Defined in

[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)
[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)

## Methods

Expand All @@ -72,4 +72,4 @@

#### Defined in

[src/api/core/BaseHttpRequest.ts:12](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/BaseHttpRequest.ts#L12)
[src/api/core/BaseHttpRequest.ts:12](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/BaseHttpRequest.ts#L12)
4 changes: 2 additions & 2 deletions docs/js-sdk-docs/classes/api.CancelError.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Error.constructor

#### Defined in

[src/api/core/CancelablePromise.ts:6](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L6)
[src/api/core/CancelablePromise.ts:6](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L6)

## Properties

Expand Down Expand Up @@ -159,7 +159,7 @@ node_modules/@types/node/globals.d.ts:30

#### Defined in

[src/api/core/CancelablePromise.ts:11](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L11)
[src/api/core/CancelablePromise.ts:11](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L11)

## Methods

Expand Down
28 changes: 14 additions & 14 deletions docs/js-sdk-docs/classes/api.CancelablePromise.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

#### Defined in

[src/api/core/CancelablePromise.ts:33](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L33)
[src/api/core/CancelablePromise.ts:33](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L33)

## Properties

Expand All @@ -76,7 +76,7 @@

#### Defined in

[src/api/core/CancelablePromise.ts:28](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L28)
[src/api/core/CancelablePromise.ts:28](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L28)

___

Expand All @@ -86,7 +86,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:27](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L27)
[src/api/core/CancelablePromise.ts:27](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L27)

___

Expand All @@ -96,7 +96,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:26](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L26)
[src/api/core/CancelablePromise.ts:26](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L26)

___

Expand All @@ -106,7 +106,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:25](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L25)
[src/api/core/CancelablePromise.ts:25](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L25)

___

Expand All @@ -116,7 +116,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:29](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L29)
[src/api/core/CancelablePromise.ts:29](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L29)

___

Expand All @@ -140,7 +140,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:31](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L31)
[src/api/core/CancelablePromise.ts:31](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L31)

___

Expand All @@ -164,7 +164,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:30](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L30)
[src/api/core/CancelablePromise.ts:30](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L30)

## Accessors

Expand All @@ -182,7 +182,7 @@ Promise.[toStringTag]

#### Defined in

[src/api/core/CancelablePromise.ts:87](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L87)
[src/api/core/CancelablePromise.ts:87](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L87)

___

Expand All @@ -196,7 +196,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:127](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L127)
[src/api/core/CancelablePromise.ts:127](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L127)

## Methods

Expand All @@ -210,7 +210,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:108](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L108)
[src/api/core/CancelablePromise.ts:108](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L108)

___

Expand Down Expand Up @@ -240,7 +240,7 @@ Promise.catch

#### Defined in

[src/api/core/CancelablePromise.ts:98](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L98)
[src/api/core/CancelablePromise.ts:98](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L98)

___

Expand All @@ -264,7 +264,7 @@ Promise.finally

#### Defined in

[src/api/core/CancelablePromise.ts:104](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L104)
[src/api/core/CancelablePromise.ts:104](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L104)

___

Expand Down Expand Up @@ -296,4 +296,4 @@ Promise.then

#### Defined in

[src/api/core/CancelablePromise.ts:91](https://github.com/julep-ai/infuse/blob/63738d5f951c5fea204e283c17a58fa33f2f6fe0/sdks/ts/src/api/core/CancelablePromise.ts#L91)
[src/api/core/CancelablePromise.ts:91](https://github.com/julep-ai/julep/blob/ce48ab353cb3923f310063ca91b5cb4c90b1757d/sdks/ts/src/api/core/CancelablePromise.ts#L91)
Loading

0 comments on commit 365e9f2

Please sign in to comment.