@griffin-app/griffin-hub-sdk 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +15 -20
- package/README.md +18 -24
- package/api.ts +389 -617
- package/dist/api.d.ts +221 -356
- package/dist/api.js +281 -473
- package/dist/esm/api.d.ts +221 -356
- package/dist/esm/api.js +272 -460
- package/dist/openapi-ts.config.d.ts +2 -0
- package/dist/openapi-ts.config.js +14 -0
- package/dist/openapi-ts.config.js.map +1 -0
- package/dist/src/client/client/client.gen.d.ts +2 -0
- package/dist/src/client/client/client.gen.js +199 -0
- package/dist/src/client/client/client.gen.js.map +1 -0
- package/dist/src/client/client/index.d.ts +8 -0
- package/dist/src/client/client/index.js +6 -0
- package/dist/src/client/client/index.js.map +1 -0
- package/dist/src/client/client/types.gen.d.ts +68 -0
- package/dist/src/client/client/types.gen.js +2 -0
- package/dist/src/client/client/types.gen.js.map +1 -0
- package/dist/src/client/client/utils.gen.d.ts +30 -0
- package/dist/src/client/client/utils.gen.js +232 -0
- package/dist/src/client/client/utils.gen.js.map +1 -0
- package/dist/src/client/client.gen.d.ts +4 -0
- package/dist/src/client/client.gen.js +3 -0
- package/dist/src/client/client.gen.js.map +1 -0
- package/dist/src/client/core/auth.gen.d.ts +8 -0
- package/dist/src/client/core/auth.gen.js +23 -0
- package/dist/src/client/core/auth.gen.js.map +1 -0
- package/dist/src/client/core/bodySerializer.gen.d.ts +21 -0
- package/dist/src/client/core/bodySerializer.gen.js +57 -0
- package/dist/src/client/core/bodySerializer.gen.js.map +1 -0
- package/dist/src/client/core/params.gen.d.ts +26 -0
- package/dist/src/client/core/params.gen.js +100 -0
- package/dist/src/client/core/params.gen.js.map +1 -0
- package/dist/src/client/core/pathSerializer.gen.d.ts +30 -0
- package/dist/src/client/core/pathSerializer.gen.js +114 -0
- package/dist/src/client/core/pathSerializer.gen.js.map +1 -0
- package/dist/src/client/core/queryKeySerializer.gen.d.ts +6 -0
- package/dist/src/client/core/queryKeySerializer.gen.js +84 -0
- package/dist/src/client/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/src/client/core/serverSentEvents.gen.d.ts +23 -0
- package/dist/src/client/core/serverSentEvents.gen.js +153 -0
- package/dist/src/client/core/serverSentEvents.gen.js.map +1 -0
- package/dist/src/client/core/types.gen.d.ts +32 -0
- package/dist/src/client/core/types.gen.js +2 -0
- package/dist/src/client/core/types.gen.js.map +1 -0
- package/dist/src/client/core/utils.gen.d.ts +19 -0
- package/dist/src/client/core/utils.gen.js +84 -0
- package/dist/src/client/core/utils.gen.js.map +1 -0
- package/dist/src/client/index.d.ts +2 -0
- package/dist/src/client/index.js +2 -0
- package/dist/src/client/index.js.map +1 -0
- package/dist/src/client/sdk.gen.d.ts +11 -0
- package/dist/src/client/sdk.gen.js +10 -0
- package/dist/src/client/sdk.gen.js.map +1 -0
- package/dist/src/client/types.gen.d.ts +217 -0
- package/dist/src/client/types.gen.js +2 -0
- package/dist/src/client/types.gen.js.map +1 -0
- package/docs/{Assertion1AnyOf.md → AssertionAnyOf.md} +3 -3
- package/docs/{Assertion1AnyOf1.md → AssertionAnyOf1.md} +3 -3
- package/docs/{Assertion1AnyOf2.md → AssertionAnyOf2.md} +3 -3
- package/docs/Assertions.md +1 -1
- package/docs/{Assertion1.md → AssertionsAssertionsInner.md} +4 -4
- package/docs/AssertionsAssertionsInnerAnyOf.md +28 -0
- package/docs/AssertionsAssertionsInnerAnyOfAllOfPredicate.md +22 -0
- package/docs/AssertionsAssertionsInnerAnyOfAllOfPredicateAnyOf.md +22 -0
- package/docs/Endpoint.md +3 -3
- package/docs/{Endpoint1HeadersValue.md → EndpointHeadersValue.md} +4 -4
- package/docs/{Endpoint1HeadersValueAnyOf.md → EndpointHeadersValueAnyOf.md} +4 -4
- package/docs/{Endpoint1HeadersValueAnyOfSecret.md → EndpointHeadersValueAnyOfSecret.md} +3 -3
- package/docs/{Edge1.md → EndpointPath.md} +5 -7
- package/docs/{Wait1.md → EndpointPathAnyOf.md} +5 -9
- package/docs/{Endpoint1Base.md → EndpointPathAnyOfVariable.md} +5 -5
- package/docs/Node.md +4 -4
- package/docs/PlanApi.md +195 -5
- package/docs/PlanPostRequest.md +34 -0
- package/docs/PlanPostRequestFrequency.md +22 -0
- package/docs/TestPlanV1.md +4 -6
- package/package.json +1 -1
- package/docs/Assertions1.md +0 -24
- package/docs/ConfigApi.md +0 -330
- package/docs/ConfigGet200Response.md +0 -20
- package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response.md +0 -20
- package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200ResponseData.md +0 -20
- package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response.md +0 -20
- package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData.md +0 -30
- package/docs/ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest.md +0 -20
- package/docs/Endpoint1.md +0 -34
- package/docs/Node1.md +0 -38
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AssertionsAssertionsInner
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -9,15 +9,15 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**nodeId** | **string** | | [default to undefined]
|
|
10
10
|
**accessor** | **string** | | [default to undefined]
|
|
11
11
|
**path** | **string** | | [default to undefined]
|
|
12
|
-
**predicate** | [**
|
|
12
|
+
**predicate** | [**AssertionsAssertionsInnerAnyOfAllOfPredicate**](AssertionsAssertionsInnerAnyOfAllOfPredicate.md) | | [default to undefined]
|
|
13
13
|
**expected** | **any** | | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import {
|
|
18
|
+
import { AssertionsAssertionsInner } from 'griffin-hub-sdk';
|
|
19
19
|
|
|
20
|
-
const instance:
|
|
20
|
+
const instance: AssertionsAssertionsInner = {
|
|
21
21
|
assertionType,
|
|
22
22
|
nodeId,
|
|
23
23
|
accessor,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# AssertionsAssertionsInnerAnyOf
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**assertionType** | **string** | | [default to undefined]
|
|
9
|
+
**nodeId** | **string** | | [default to undefined]
|
|
10
|
+
**accessor** | **string** | | [default to undefined]
|
|
11
|
+
**path** | **Array<string>** | | [default to undefined]
|
|
12
|
+
**predicate** | [**AssertionsAssertionsInnerAnyOfAllOfPredicate**](AssertionsAssertionsInnerAnyOfAllOfPredicate.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { AssertionsAssertionsInnerAnyOf } from 'griffin-hub-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: AssertionsAssertionsInnerAnyOf = {
|
|
20
|
+
assertionType,
|
|
21
|
+
nodeId,
|
|
22
|
+
accessor,
|
|
23
|
+
path,
|
|
24
|
+
predicate,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AssertionsAssertionsInnerAnyOfAllOfPredicate
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**expected** | **any** | | [default to undefined]
|
|
9
|
+
**operator** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AssertionsAssertionsInnerAnyOfAllOfPredicate } from 'griffin-hub-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: AssertionsAssertionsInnerAnyOfAllOfPredicate = {
|
|
17
|
+
expected,
|
|
18
|
+
operator,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AssertionsAssertionsInnerAnyOfAllOfPredicateAnyOf
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**expected** | **any** | | [default to undefined]
|
|
9
|
+
**operator** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AssertionsAssertionsInnerAnyOfAllOfPredicateAnyOf } from 'griffin-hub-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: AssertionsAssertionsInnerAnyOfAllOfPredicateAnyOf = {
|
|
17
|
+
expected,
|
|
18
|
+
operator,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Endpoint.md
CHANGED
|
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**type** | **string** | | [default to undefined]
|
|
10
10
|
**method** | **string** | | [default to undefined]
|
|
11
|
-
**path** | **
|
|
12
|
-
**base** | [**
|
|
13
|
-
**headers** | [**{ [key: string]:
|
|
11
|
+
**path** | [**EndpointPath**](EndpointPath.md) | | [default to undefined]
|
|
12
|
+
**base** | [**EndpointPath**](EndpointPath.md) | | [default to undefined]
|
|
13
|
+
**headers** | [**{ [key: string]: EndpointHeadersValue; }**](EndpointHeadersValue.md) | | [optional] [default to undefined]
|
|
14
14
|
**body** | **any** | | [optional] [default to undefined]
|
|
15
15
|
**response_format** | **string** | | [default to undefined]
|
|
16
16
|
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EndpointHeadersValue
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**$secret** | [**
|
|
8
|
+
**$secret** | [**EndpointHeadersValueAnyOfSecret**](EndpointHeadersValueAnyOfSecret.md) | | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { EndpointHeadersValue } from 'griffin-hub-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: EndpointHeadersValue = {
|
|
16
16
|
$secret,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EndpointHeadersValueAnyOf
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**$secret** | [**
|
|
8
|
+
**$secret** | [**EndpointHeadersValueAnyOfSecret**](EndpointHeadersValueAnyOfSecret.md) | | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { EndpointHeadersValueAnyOf } from 'griffin-hub-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: EndpointHeadersValueAnyOf = {
|
|
16
16
|
$secret,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EndpointHeadersValueAnyOfSecret
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { EndpointHeadersValueAnyOfSecret } from 'griffin-hub-sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: EndpointHeadersValueAnyOfSecret = {
|
|
19
19
|
provider,
|
|
20
20
|
ref,
|
|
21
21
|
version,
|
|
@@ -1,21 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EndpointPath
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**to** | **string** | | [default to undefined]
|
|
8
|
+
**$variable** | [**EndpointPathAnyOfVariable**](EndpointPathAnyOfVariable.md) | | [default to undefined]
|
|
10
9
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
13
12
|
```typescript
|
|
14
|
-
import {
|
|
13
|
+
import { EndpointPath } from 'griffin-hub-sdk';
|
|
15
14
|
|
|
16
|
-
const instance:
|
|
17
|
-
|
|
18
|
-
to,
|
|
15
|
+
const instance: EndpointPath = {
|
|
16
|
+
$variable,
|
|
19
17
|
};
|
|
20
18
|
```
|
|
21
19
|
|
|
@@ -1,23 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EndpointPathAnyOf
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**type** | **string** | | [default to undefined]
|
|
10
|
-
**duration_ms** | **number** | | [default to undefined]
|
|
8
|
+
**$variable** | [**EndpointPathAnyOfVariable**](EndpointPathAnyOfVariable.md) | | [default to undefined]
|
|
11
9
|
|
|
12
10
|
## Example
|
|
13
11
|
|
|
14
12
|
```typescript
|
|
15
|
-
import {
|
|
13
|
+
import { EndpointPathAnyOf } from 'griffin-hub-sdk';
|
|
16
14
|
|
|
17
|
-
const instance:
|
|
18
|
-
|
|
19
|
-
type,
|
|
20
|
-
duration_ms,
|
|
15
|
+
const instance: EndpointPathAnyOf = {
|
|
16
|
+
$variable,
|
|
21
17
|
};
|
|
22
18
|
```
|
|
23
19
|
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EndpointPathAnyOfVariable
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**type** | **string** | | [default to undefined]
|
|
9
8
|
**key** | **string** | | [default to undefined]
|
|
9
|
+
**template** | **string** | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EndpointPathAnyOfVariable } from 'griffin-hub-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
17
|
-
type,
|
|
16
|
+
const instance: EndpointPathAnyOfVariable = {
|
|
18
17
|
key,
|
|
18
|
+
template,
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
package/docs/Node.md
CHANGED
|
@@ -8,13 +8,13 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**type** | **string** | | [default to undefined]
|
|
10
10
|
**method** | **string** | | [default to undefined]
|
|
11
|
-
**path** | **
|
|
12
|
-
**base** | [**
|
|
13
|
-
**headers** | [**{ [key: string]:
|
|
11
|
+
**path** | [**EndpointPath**](EndpointPath.md) | | [default to undefined]
|
|
12
|
+
**base** | [**EndpointPath**](EndpointPath.md) | | [default to undefined]
|
|
13
|
+
**headers** | [**{ [key: string]: EndpointHeadersValue; }**](EndpointHeadersValue.md) | | [optional] [default to undefined]
|
|
14
14
|
**body** | **any** | | [optional] [default to undefined]
|
|
15
15
|
**response_format** | **string** | | [default to undefined]
|
|
16
16
|
**duration_ms** | **number** | | [default to undefined]
|
|
17
|
-
**assertions** | [**Array<
|
|
17
|
+
**assertions** | [**Array<AssertionsAssertionsInner>**](AssertionsAssertionsInner.md) | | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
package/docs/PlanApi.md
CHANGED
|
@@ -4,9 +4,76 @@ All URIs are relative to *http://localhost:3000*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**planByNameGet**](#planbynameget) | **GET** /plan/by-name | |
|
|
7
8
|
|[**planGet**](#planget) | **GET** /plan/ | |
|
|
9
|
+
|[**planIdDelete**](#planiddelete) | **DELETE** /plan/{id} | |
|
|
10
|
+
|[**planIdPut**](#planidput) | **PUT** /plan/{id} | |
|
|
8
11
|
|[**planPost**](#planpost) | **POST** /plan/ | |
|
|
9
12
|
|
|
13
|
+
# **planByNameGet**
|
|
14
|
+
> PlanPost201Response planByNameGet()
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
PlanApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from 'griffin-hub-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new PlanApi(configuration);
|
|
27
|
+
|
|
28
|
+
let projectId: string; // (default to undefined)
|
|
29
|
+
let environment: string; // (default to undefined)
|
|
30
|
+
let name: string; // (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.planByNameGet(
|
|
33
|
+
projectId,
|
|
34
|
+
environment,
|
|
35
|
+
name
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
44
|
+
| **environment** | [**string**] | | defaults to undefined|
|
|
45
|
+
| **name** | [**string**] | | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**PlanPost201Response**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Default Response | - |
|
|
66
|
+
|**400** | Default Response | - |
|
|
67
|
+
|**401** | Default Response | - |
|
|
68
|
+
|**403** | Default Response | - |
|
|
69
|
+
|**404** | Default Response | - |
|
|
70
|
+
|**500** | Default Response | - |
|
|
71
|
+
|**502** | Default Response | - |
|
|
72
|
+
|**503** | Default Response | - |
|
|
73
|
+
|**504** | Default Response | - |
|
|
74
|
+
|
|
75
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
76
|
+
|
|
10
77
|
# **planGet**
|
|
11
78
|
> PlanGet200Response planGet()
|
|
12
79
|
|
|
@@ -23,11 +90,13 @@ const configuration = new Configuration();
|
|
|
23
90
|
const apiInstance = new PlanApi(configuration);
|
|
24
91
|
|
|
25
92
|
let projectId: string; // (optional) (default to undefined)
|
|
93
|
+
let environment: string; // (optional) (default to undefined)
|
|
26
94
|
let limit: number; // (optional) (default to undefined)
|
|
27
95
|
let offset: number; // (optional) (default to undefined)
|
|
28
96
|
|
|
29
97
|
const { status, data } = await apiInstance.planGet(
|
|
30
98
|
projectId,
|
|
99
|
+
environment,
|
|
31
100
|
limit,
|
|
32
101
|
offset
|
|
33
102
|
);
|
|
@@ -38,6 +107,7 @@ const { status, data } = await apiInstance.planGet(
|
|
|
38
107
|
|Name | Type | Description | Notes|
|
|
39
108
|
|------------- | ------------- | ------------- | -------------|
|
|
40
109
|
| **projectId** | [**string**] | | (optional) defaults to undefined|
|
|
110
|
+
| **environment** | [**string**] | | (optional) defaults to undefined|
|
|
41
111
|
| **limit** | [**number**] | | (optional) defaults to undefined|
|
|
42
112
|
| **offset** | [**number**] | | (optional) defaults to undefined|
|
|
43
113
|
|
|
@@ -56,6 +126,126 @@ No authorization required
|
|
|
56
126
|
- **Accept**: application/json
|
|
57
127
|
|
|
58
128
|
|
|
129
|
+
### HTTP response details
|
|
130
|
+
| Status code | Description | Response headers |
|
|
131
|
+
|-------------|-------------|------------------|
|
|
132
|
+
|**200** | Default Response | - |
|
|
133
|
+
|**400** | Default Response | - |
|
|
134
|
+
|**401** | Default Response | - |
|
|
135
|
+
|**403** | Default Response | - |
|
|
136
|
+
|**404** | Default Response | - |
|
|
137
|
+
|**500** | Default Response | - |
|
|
138
|
+
|**502** | Default Response | - |
|
|
139
|
+
|**503** | Default Response | - |
|
|
140
|
+
|**504** | Default Response | - |
|
|
141
|
+
|
|
142
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
143
|
+
|
|
144
|
+
# **planIdDelete**
|
|
145
|
+
> planIdDelete()
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
### Example
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
import {
|
|
152
|
+
PlanApi,
|
|
153
|
+
Configuration
|
|
154
|
+
} from 'griffin-hub-sdk';
|
|
155
|
+
|
|
156
|
+
const configuration = new Configuration();
|
|
157
|
+
const apiInstance = new PlanApi(configuration);
|
|
158
|
+
|
|
159
|
+
let id: string; // (default to undefined)
|
|
160
|
+
|
|
161
|
+
const { status, data } = await apiInstance.planIdDelete(
|
|
162
|
+
id
|
|
163
|
+
);
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Parameters
|
|
167
|
+
|
|
168
|
+
|Name | Type | Description | Notes|
|
|
169
|
+
|------------- | ------------- | ------------- | -------------|
|
|
170
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
### Return type
|
|
174
|
+
|
|
175
|
+
void (empty response body)
|
|
176
|
+
|
|
177
|
+
### Authorization
|
|
178
|
+
|
|
179
|
+
No authorization required
|
|
180
|
+
|
|
181
|
+
### HTTP request headers
|
|
182
|
+
|
|
183
|
+
- **Content-Type**: Not defined
|
|
184
|
+
- **Accept**: application/json
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
### HTTP response details
|
|
188
|
+
| Status code | Description | Response headers |
|
|
189
|
+
|-------------|-------------|------------------|
|
|
190
|
+
|**204** | Default Response | - |
|
|
191
|
+
|**400** | Default Response | - |
|
|
192
|
+
|**401** | Default Response | - |
|
|
193
|
+
|**403** | Default Response | - |
|
|
194
|
+
|**404** | Default Response | - |
|
|
195
|
+
|**500** | Default Response | - |
|
|
196
|
+
|**502** | Default Response | - |
|
|
197
|
+
|**503** | Default Response | - |
|
|
198
|
+
|**504** | Default Response | - |
|
|
199
|
+
|
|
200
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
201
|
+
|
|
202
|
+
# **planIdPut**
|
|
203
|
+
> PlanPost201Response planIdPut(planPostRequest)
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### Example
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import {
|
|
210
|
+
PlanApi,
|
|
211
|
+
Configuration,
|
|
212
|
+
PlanPostRequest
|
|
213
|
+
} from 'griffin-hub-sdk';
|
|
214
|
+
|
|
215
|
+
const configuration = new Configuration();
|
|
216
|
+
const apiInstance = new PlanApi(configuration);
|
|
217
|
+
|
|
218
|
+
let id: string; // (default to undefined)
|
|
219
|
+
let planPostRequest: PlanPostRequest; //
|
|
220
|
+
|
|
221
|
+
const { status, data } = await apiInstance.planIdPut(
|
|
222
|
+
id,
|
|
223
|
+
planPostRequest
|
|
224
|
+
);
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Parameters
|
|
228
|
+
|
|
229
|
+
|Name | Type | Description | Notes|
|
|
230
|
+
|------------- | ------------- | ------------- | -------------|
|
|
231
|
+
| **planPostRequest** | **PlanPostRequest**| | |
|
|
232
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
### Return type
|
|
236
|
+
|
|
237
|
+
**PlanPost201Response**
|
|
238
|
+
|
|
239
|
+
### Authorization
|
|
240
|
+
|
|
241
|
+
No authorization required
|
|
242
|
+
|
|
243
|
+
### HTTP request headers
|
|
244
|
+
|
|
245
|
+
- **Content-Type**: application/json
|
|
246
|
+
- **Accept**: application/json
|
|
247
|
+
|
|
248
|
+
|
|
59
249
|
### HTTP response details
|
|
60
250
|
| Status code | Description | Response headers |
|
|
61
251
|
|-------------|-------------|------------------|
|
|
@@ -72,7 +262,7 @@ No authorization required
|
|
|
72
262
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
73
263
|
|
|
74
264
|
# **planPost**
|
|
75
|
-
> PlanPost201Response planPost()
|
|
265
|
+
> PlanPost201Response planPost(planPostRequest)
|
|
76
266
|
|
|
77
267
|
|
|
78
268
|
### Example
|
|
@@ -81,16 +271,16 @@ No authorization required
|
|
|
81
271
|
import {
|
|
82
272
|
PlanApi,
|
|
83
273
|
Configuration,
|
|
84
|
-
|
|
274
|
+
PlanPostRequest
|
|
85
275
|
} from 'griffin-hub-sdk';
|
|
86
276
|
|
|
87
277
|
const configuration = new Configuration();
|
|
88
278
|
const apiInstance = new PlanApi(configuration);
|
|
89
279
|
|
|
90
|
-
let
|
|
280
|
+
let planPostRequest: PlanPostRequest; //
|
|
91
281
|
|
|
92
282
|
const { status, data } = await apiInstance.planPost(
|
|
93
|
-
|
|
283
|
+
planPostRequest
|
|
94
284
|
);
|
|
95
285
|
```
|
|
96
286
|
|
|
@@ -98,7 +288,7 @@ const { status, data } = await apiInstance.planPost(
|
|
|
98
288
|
|
|
99
289
|
|Name | Type | Description | Notes|
|
|
100
290
|
|------------- | ------------- | ------------- | -------------|
|
|
101
|
-
| **
|
|
291
|
+
| **planPostRequest** | **PlanPostRequest**| | |
|
|
102
292
|
|
|
103
293
|
|
|
104
294
|
### Return type
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# PlanPostRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**project** | **string** | | [default to undefined]
|
|
9
|
+
**locations** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | | [default to undefined]
|
|
11
|
+
**version** | **string** | | [default to undefined]
|
|
12
|
+
**frequency** | [**PlanPostRequestFrequency**](PlanPostRequestFrequency.md) | | [default to undefined]
|
|
13
|
+
**environment** | **string** | | [default to 'default']
|
|
14
|
+
**nodes** | [**Array<Node>**](Node.md) | | [default to undefined]
|
|
15
|
+
**edges** | [**Array<Edge>**](Edge.md) | | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { PlanPostRequest } from 'griffin-hub-sdk';
|
|
21
|
+
|
|
22
|
+
const instance: PlanPostRequest = {
|
|
23
|
+
project,
|
|
24
|
+
locations,
|
|
25
|
+
name,
|
|
26
|
+
version,
|
|
27
|
+
frequency,
|
|
28
|
+
environment,
|
|
29
|
+
nodes,
|
|
30
|
+
edges,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PlanPostRequestFrequency
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**every** | **number** | | [default to undefined]
|
|
9
|
+
**unit** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PlanPostRequestFrequency } from 'griffin-hub-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: PlanPostRequestFrequency = {
|
|
17
|
+
every,
|
|
18
|
+
unit,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/TestPlanV1.md
CHANGED
|
@@ -5,16 +5,15 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**project** | **string** | | [optional] [default to undefined]
|
|
8
|
+
**project** | **string** | | [default to undefined]
|
|
10
9
|
**locations** | **Array<string>** | | [optional] [default to undefined]
|
|
11
10
|
**id** | **string** | | [default to undefined]
|
|
12
11
|
**name** | **string** | | [default to undefined]
|
|
13
12
|
**version** | **string** | | [default to undefined]
|
|
14
|
-
**frequency** | [**Frequency1**](Frequency1.md) | | [
|
|
13
|
+
**frequency** | [**Frequency1**](Frequency1.md) | | [default to undefined]
|
|
15
14
|
**environment** | **string** | | [default to 'default']
|
|
16
|
-
**nodes** | [**Array<
|
|
17
|
-
**edges** | [**Array<
|
|
15
|
+
**nodes** | [**Array<Node>**](Node.md) | | [default to undefined]
|
|
16
|
+
**edges** | [**Array<Edge>**](Edge.md) | | [default to undefined]
|
|
18
17
|
|
|
19
18
|
## Example
|
|
20
19
|
|
|
@@ -22,7 +21,6 @@ Name | Type | Description | Notes
|
|
|
22
21
|
import { TestPlanV1 } from 'griffin-hub-sdk';
|
|
23
22
|
|
|
24
23
|
const instance: TestPlanV1 = {
|
|
25
|
-
organization,
|
|
26
24
|
project,
|
|
27
25
|
locations,
|
|
28
26
|
id,
|
package/package.json
CHANGED
package/docs/Assertions1.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# Assertions1
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**type** | **string** | | [default to undefined]
|
|
10
|
-
**assertions** | [**Array<Assertion1>**](Assertion1.md) | | [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { Assertions1 } from 'griffin-hub-sdk';
|
|
16
|
-
|
|
17
|
-
const instance: Assertions1 = {
|
|
18
|
-
id,
|
|
19
|
-
type,
|
|
20
|
-
assertions,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|