Skip to content

Commit 784ad7e

Browse files
matthiasreisachermatthiasreisacher
committed
Generate spec version 1.7.0
1 parent 6547217 commit 784ad7e

File tree

6 files changed

+182
-20
lines changed

6 files changed

+182
-20
lines changed

‎oas_spec.yaml‎

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ info:
77
* host Grasshopper models in a secure, reliable, scalable, and performant way,
88
* run computations of Grasshopper models,
99
* and cache and output the results of computations and exports.
10-
version: 1.6.1
10+
version: 1.7.0
1111

1212
externalDocs:
1313
description: ShapeDiver Help Center
@@ -244,6 +244,16 @@ components:
244244
required:
245245
- id
246246
- name
247+
CommonsModelBlockingReasons: &CommonsModelBlockingReasons
248+
description: Reasons why the model may be blocked.
249+
type: object
250+
properties:
251+
creditLimit:
252+
description: The model owner's credit limit has been exceeded.
253+
type: boolean
254+
owner:
255+
description: The model has been blocked explicitly by its owner.
256+
type: boolean
247257
CommonsModelStatus: &CommonsModelStatus
248258
description: Status of a model.
249259
type: string
@@ -263,13 +273,13 @@ components:
263273
- CONFIRMED
264274
- DENIED
265275
- DELETED
266-
CommonsBasicParameter:
276+
CommonsBasicParameter: &CommonsBasicParameter
267277
description: Definition of a basic ShapeDiver parameter.
268278
oneOf:
269279
- type: string
270280
- type: number
271281
- type: boolean
272-
CommonsStypeParameter:
282+
CommonsStypeParameter: &CommonsStypeParameter
273283
description: Definition of the value to use for s-type parameters.
274284
type: object
275285
properties:
@@ -605,11 +615,15 @@ components:
605615
- id
606616
required:
607617
- parameters
618+
ReqBasicParameter:
619+
<<: *CommonsBasicParameter
620+
ReqStypeParameter:
621+
<<: *CommonsStypeParameter
608622
ReqParameterValue:
609623
description: The value of a single model parameter.
610624
oneOf:
611-
- $ref: "#/components/schemas/CommonsBasicParameter"
612-
- $ref: "#/components/schemas/CommonsStypeParameter"
625+
- $ref: "#/components/schemas/ReqBasicParameter"
626+
- $ref: "#/components/schemas/ReqStypeParameter"
613627
ReqCustomization:
614628
description: |-
615629
A directory of parameter keys and values.
@@ -621,8 +635,8 @@ components:
621635
* `displayname`
622636
623637
Supported parameter values are:
624-
* Basic parameter (`CommonsBasicParameter`)
625-
* S-type parameter (`CommonsStypeParameter`)
638+
* Basic parameter (`ReqBasicParameter`)
639+
* S-type parameter (`ReqStypeParameter`)
626640
type: object
627641
additionalProperties:
628642
$ref: "#/components/schemas/ReqParameterValue"
@@ -810,6 +824,9 @@ components:
810824
backendaccess:
811825
description: Should backend access to the model be allowed.
812826
type: boolean
827+
blockingReasons:
828+
title: ReqModelBlockingReasons
829+
<<: *CommonsModelBlockingReasons
813830
filename:
814831
description: Original name of the model's grasshopper file.
815832
type: string
@@ -2757,6 +2774,20 @@ components:
27572774
backlinkurl:
27582775
description: Link to view the model on the ShapeDiver Platform.
27592776
type: string
2777+
blockingReasons:
2778+
title: ResModelBlockingReasons
2779+
allOf:
2780+
- $ref: "#/components/schemas/CommonsModelBlockingReasons"
2781+
- type: object
2782+
properties:
2783+
pluginPermission:
2784+
description: >-
2785+
The model uses a Grasshopper plugin that is not allowed for the owner.
2786+
type: boolean
2787+
required:
2788+
- creditLimit
2789+
- owner
2790+
- pluginPermission
27602791
checkurl:
27612792
description: >-
27622793
Link to continue the checking process of the model on the ShapeDiver Platform.
@@ -3368,16 +3399,20 @@ components:
33683399
- hasImage
33693400
- hasGltf
33703401
- hasUsdz
3402+
ResBasicParameter:
3403+
<<: *CommonsBasicParameter
3404+
ResStypeParameter:
3405+
<<: *CommonsStypeParameter
33713406
ResParameterValue:
33723407
description: >-
33733408
The value of a single model parameter.
33743409
33753410
Supported parameter values are:
3376-
* Basic parameter (`CommonsBasicParameter`)
3377-
* S-type parameter (`CommonsStypeParameter`)
3411+
* Basic parameter (`ResBasicParameter`)
3412+
* S-type parameter (`ResStypeParameter`)
33783413
oneOf:
3379-
- $ref: "#/components/schemas/CommonsBasicParameter"
3380-
- $ref: "#/components/schemas/CommonsStypeParameter"
3414+
- $ref: "#/components/schemas/ResBasicParameter"
3415+
- $ref: "#/components/schemas/ResStypeParameter"
33813416
ResModelComputationStats:
33823417
description: Stats of a computation request.
33833418
type: object

‎packages/sdk.geometry-api-sdk-v2/src/client/api.ts‎

Lines changed: 132 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Geometry Backend API v2
55
* The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
66
*
7-
* The version of the OpenAPI document: 1.6.1
7+
* The version of the OpenAPI document: 1.7.0
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -98,6 +98,25 @@ export interface CommonsGroup {
9898
*/
9999
'name': string;
100100
}
101+
/**
102+
* Reasons why the model may be blocked.
103+
* @export
104+
* @interface CommonsModelBlockingReasons
105+
*/
106+
export interface CommonsModelBlockingReasons {
107+
/**
108+
* The model owner\'s credit limit has been exceeded.
109+
* @type {boolean}
110+
* @memberof CommonsModelBlockingReasons
111+
*/
112+
'creditLimit'?: boolean;
113+
/**
114+
* The model has been blocked explicitly by its owner.
115+
* @type {boolean}
116+
* @memberof CommonsModelBlockingReasons
117+
*/
118+
'owner'?: boolean;
119+
}
101120
/**
102121
* Status of a model.
103122
* @export
@@ -360,6 +379,13 @@ export interface ReqAuthorizationGroup {
360379
*/
361380
'organizations'?: Array<string>;
362381
}
382+
/**
383+
* @type ReqBasicParameter
384+
* Definition of a basic ShapeDiver parameter.
385+
* @export
386+
*/
387+
export type ReqBasicParameter = boolean | number | string;
388+
363389
/**
364390
* Body of an export or output cache request. A directory of export-/output-IDs and version-IDs.
365391
* @export
@@ -423,7 +449,7 @@ export interface ReqCreditMetrics {
423449
'parameters': Array<ReqCreditMetric>;
424450
}
425451
/**
426-
* A directory of parameter keys and values. Supported parameter keys are as follows, whereby the parameter resolution is done in the same order as the keys are listed: * `id` * `name` * `displayname` Supported parameter values are: * Basic parameter (`CommonsBasicParameter`) * S-type parameter (`CommonsStypeParameter`)
452+
* A directory of parameter keys and values. Supported parameter keys are as follows, whereby the parameter resolution is done in the same order as the keys are listed: * `id` * `name` * `displayname` Supported parameter values are: * Basic parameter (`ReqBasicParameter`) * S-type parameter (`ReqStypeParameter`)
427453
* @export
428454
* @interface ReqCustomization
429455
*/
@@ -654,6 +680,12 @@ export interface ReqModel {
654680
* @memberof ReqModel
655681
*/
656682
'backendaccess'?: boolean;
683+
/**
684+
*
685+
* @type {ReqModelBlockingReasons}
686+
* @memberof ReqModel
687+
*/
688+
'blockingReasons'?: ReqModelBlockingReasons;
657689
/**
658690
* Original name of the model\'s grasshopper file.
659691
* @type {string}
@@ -819,6 +851,25 @@ export interface ReqModel {
819851
}
820852

821853

854+
/**
855+
* Reasons why the model may be blocked.
856+
* @export
857+
* @interface ReqModelBlockingReasons
858+
*/
859+
export interface ReqModelBlockingReasons {
860+
/**
861+
* The model owner\'s credit limit has been exceeded.
862+
* @type {boolean}
863+
* @memberof ReqModelBlockingReasons
864+
*/
865+
'creditLimit'?: boolean;
866+
/**
867+
* The model has been blocked explicitly by its owner.
868+
* @type {boolean}
869+
* @memberof ReqModelBlockingReasons
870+
*/
871+
'owner'?: boolean;
872+
}
822873
/**
823874
* Model metrics
824875
* @export
@@ -1120,7 +1171,7 @@ export interface ReqParameterDefinitions {
11201171
* The value of a single model parameter.
11211172
* @export
11221173
*/
1123-
export type ReqParameterValue = CommonsBasicParameter | CommonsStypeParameter;
1174+
export type ReqParameterValue = ReqBasicParameter | ReqStypeParameter;
11241175

11251176
/**
11261177
* Data for a single sdTF parameter.
@@ -1168,6 +1219,25 @@ export const ReqSdtfType = {
11681219
export type ReqSdtfType = typeof ReqSdtfType[keyof typeof ReqSdtfType];
11691220

11701221

1222+
/**
1223+
* Definition of the value to use for s-type parameters.
1224+
* @export
1225+
* @interface ReqStypeParameter
1226+
*/
1227+
export interface ReqStypeParameter {
1228+
/**
1229+
* Optional embedded value. If this is set the asset is ignored.
1230+
* @type {string}
1231+
* @memberof ReqStypeParameter
1232+
*/
1233+
'value'?: string;
1234+
/**
1235+
*
1236+
* @type {CommmonsParameterAsset}
1237+
* @memberof ReqStypeParameter
1238+
*/
1239+
'asset'?: CommmonsParameterAsset;
1240+
}
11711241
/**
11721242
* System-wide metrics
11731243
* @export
@@ -1787,6 +1857,13 @@ export interface ResBaseSystem {
17871857
*/
17881858
'system'?: ResSystem;
17891859
}
1860+
/**
1861+
* @type ResBasicParameter
1862+
* Definition of a basic ShapeDiver parameter.
1863+
* @export
1864+
*/
1865+
export type ResBasicParameter = boolean | number | string;
1866+
17901867
/**
17911868
*
17921869
* @export
@@ -4352,6 +4429,12 @@ export interface ResModel {
43524429
* @memberof ResModel
43534430
*/
43544431
'backlinkurl'?: string;
4432+
/**
4433+
*
4434+
* @type {ResModelBlockingReasons}
4435+
* @memberof ResModel
4436+
*/
4437+
'blockingReasons'?: ResModelBlockingReasons;
43554438
/**
43564439
* Link to continue the checking process of the model on the ShapeDiver Platform.
43574440
* @type {string}
@@ -4433,6 +4516,31 @@ export interface ResModel {
44334516
}
44344517

44354518

4519+
/**
4520+
*
4521+
* @export
4522+
* @interface ResModelBlockingReasons
4523+
*/
4524+
export interface ResModelBlockingReasons {
4525+
/**
4526+
* The model owner\'s credit limit has been exceeded.
4527+
* @type {boolean}
4528+
* @memberof ResModelBlockingReasons
4529+
*/
4530+
'creditLimit': boolean;
4531+
/**
4532+
* The model has been blocked explicitly by its owner.
4533+
* @type {boolean}
4534+
* @memberof ResModelBlockingReasons
4535+
*/
4536+
'owner': boolean;
4537+
/**
4538+
* The model uses a Grasshopper plugin that is not allowed for the owner.
4539+
* @type {boolean}
4540+
* @memberof ResModelBlockingReasons
4541+
*/
4542+
'pluginPermission': boolean;
4543+
}
44364544
/**
44374545
* Information about a model cleanup process.
44384546
* @export
@@ -6043,10 +6151,10 @@ export type ResParameterType = typeof ResParameterType[keyof typeof ResParameter
60436151

60446152
/**
60456153
* @type ResParameterValue
6046-
* The value of a single model parameter. Supported parameter values are: * Basic parameter (`CommonsBasicParameter`) * S-type parameter (`CommonsStypeParameter`)
6154+
* The value of a single model parameter. Supported parameter values are: * Basic parameter (`ResBasicParameter`) * S-type parameter (`ResStypeParameter`)
60476155
* @export
60486156
*/
6049-
export type ResParameterValue = CommonsBasicParameter | CommonsStypeParameter;
6157+
export type ResParameterValue = ResBasicParameter | ResStypeParameter;
60506158

60516159
/**
60526160
*
@@ -6731,6 +6839,25 @@ export const ResStructureType = {
67316839
export type ResStructureType = typeof ResStructureType[keyof typeof ResStructureType];
67326840

67336841

6842+
/**
6843+
* Definition of the value to use for s-type parameters.
6844+
* @export
6845+
* @interface ResStypeParameter
6846+
*/
6847+
export interface ResStypeParameter {
6848+
/**
6849+
* Optional embedded value. If this is set the asset is ignored.
6850+
* @type {string}
6851+
* @memberof ResStypeParameter
6852+
*/
6853+
'value'?: string;
6854+
/**
6855+
*
6856+
* @type {CommmonsParameterAsset}
6857+
* @memberof ResStypeParameter
6858+
*/
6859+
'asset'?: CommmonsParameterAsset;
6860+
}
67346861
/**
67356862
* ShapeDiver API response of system-request.
67366863
* @export

‎packages/sdk.geometry-api-sdk-v2/src/client/base.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Geometry Backend API v2
55
* The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
66
*
7-
* The version of the OpenAPI document: 1.6.1
7+
* The version of the OpenAPI document: 1.7.0
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎packages/sdk.geometry-api-sdk-v2/src/client/common.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Geometry Backend API v2
55
* The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
66
*
7-
* The version of the OpenAPI document: 1.6.1
7+
* The version of the OpenAPI document: 1.7.0
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎packages/sdk.geometry-api-sdk-v2/src/client/configuration.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Geometry Backend API v2
55
* The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
66
*
7-
* The version of the OpenAPI document: 1.6.1
7+
* The version of the OpenAPI document: 1.7.0
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎packages/sdk.geometry-api-sdk-v2/src/client/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Geometry Backend API v2
55
* The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
66
*
7-
* The version of the OpenAPI document: 1.6.1
7+
* The version of the OpenAPI document: 1.7.0
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

0 commit comments

Comments
 (0)