[sherlock-build] generated from ceb5dd0

broadinstitute · Jul 8, 2024 · 803a827 · 803a827
1 parent ceb5dd0
commit 803a827
Show file tree

Hide file tree

Showing 16 changed files with 56 additions and 43 deletions.
diff --git a/sherlock-go-client/client/models/sherlock_role_assignment_v3.go b/sherlock-go-client/client/models/sherlock_role_assignment_v3.go
diff --git a/sherlock-go-client/client/models/sherlock_role_assignment_v3_edit.go b/sherlock-go-client/client/models/sherlock_role_assignment_v3_edit.go
diff --git a/sherlock-go-client/client/models/sherlock_role_v3.go b/sherlock-go-client/client/models/sherlock_role_v3.go
diff --git a/sherlock-go-client/client/models/sherlock_role_v3_edit.go b/sherlock-go-client/client/models/sherlock_role_v3_edit.go
diff --git a/sherlock-go-client/client/role_assignments/get_api_role_assignments_v3_parameters.go b/sherlock-go-client/client/role_assignments/get_api_role_assignments_v3_parameters.go
diff --git a/sherlock-go-client/client/roles/get_api_roles_v3_parameters.go b/sherlock-go-client/client/roles/get_api_roles_v3_parameters.go
diff --git a/sherlock-typescript-client/README.md b/sherlock-typescript-client/README.md
@@ -1,4 +1,4 @@
-## @sherlock-js-client/sherlock@v1.5.11
+## @sherlock-js-client/sherlock@v1.5.12
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @sherlock-js-client/[email protected].11 --save
+npm install @sherlock-js-client/[email protected].12 --save
 ```
 
 _unPublished (not recommended):_

diff --git a/sherlock-typescript-client/package-lock.json b/sherlock-typescript-client/package-lock.json
diff --git a/sherlock-typescript-client/package.json b/sherlock-typescript-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@sherlock-js-client/sherlock",
-  "version": "v1.5.11",
+  "version": "v1.5.12",
   "description": "OpenAPI client for @sherlock-js-client/sherlock",
   "author": "OpenAPI-Generator",
   "repository": {

diff --git a/sherlock-typescript-client/src/models/SherlockRoleAssignmentV3.ts b/sherlock-typescript-client/src/models/SherlockRoleAssignmentV3.ts
@@ -38,7 +38,7 @@ export interface SherlockRoleAssignmentV3 {
      */
     roleInfo?: object;
     /**
-     * 
+     * If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users
      * @type {boolean}
      * @memberof SherlockRoleAssignmentV3
      */

diff --git a/sherlock-typescript-client/src/models/SherlockRoleAssignmentV3Edit.ts b/sherlock-typescript-client/src/models/SherlockRoleAssignmentV3Edit.ts
@@ -32,7 +32,7 @@ export interface SherlockRoleAssignmentV3Edit {
      */
     expiresIn?: string;
     /**
-     * 
+     * If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users
      * @type {boolean}
      * @memberof SherlockRoleAssignmentV3Edit
      */

diff --git a/sherlock-typescript-client/src/models/SherlockRoleV3.ts b/sherlock-typescript-client/src/models/SherlockRoleV3.ts
@@ -105,7 +105,7 @@ export interface SherlockRoleV3 {
      */
     name?: string;
     /**
-     * 
+     * When true, the "suspended" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field
      * @type {boolean}
      * @memberof SherlockRoleV3
      */

diff --git a/sherlock-typescript-client/src/models/SherlockRoleV3Edit.ts b/sherlock-typescript-client/src/models/SherlockRoleV3Edit.ts
@@ -74,7 +74,7 @@ export interface SherlockRoleV3Edit {
      */
     name?: string;
     /**
-     * 
+     * When true, the "suspended" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field
      * @type {boolean}
      * @memberof SherlockRoleV3Edit
      */

diff --git a/sherlock/docs/docs.go b/sherlock/docs/docs.go
@@ -6598,7 +6598,7 @@ const docTemplate = `{
                     },
                     {
                         "type": "boolean",
-                        "default": false,
+                        "description": "If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users",
                         "name": "suspended",
                         "in": "query"
                     },
@@ -7027,6 +7027,7 @@ const docTemplate = `{
                     },
                     {
                         "type": "boolean",
+                        "description": "When true, the \"suspended\" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field",
                         "name": "suspendNonSuitableUsers",
                         "in": "query"
                     },
@@ -9822,8 +9823,8 @@ const docTemplate = `{
                     "type": "object"
                 },
                 "suspended": {
-                    "type": "boolean",
-                    "default": false
+                    "description": "If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users",
+                    "type": "boolean"
                 },
                 "userInfo": {
                     "type": "object"
@@ -9842,8 +9843,8 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "suspended": {
-                    "type": "boolean",
-                    "default": false
+                    "description": "If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users",
+                    "type": "boolean"
                 }
             }
         },
@@ -9894,6 +9895,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "suspendNonSuitableUsers": {
+                    "description": "When true, the \"suspended\" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field",
                     "type": "boolean"
                 },
                 "updatedAt": {
@@ -9933,6 +9935,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "suspendNonSuitableUsers": {
+                    "description": "When true, the \"suspended\" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field",
                     "type": "boolean"
                 }
             }

diff --git a/sherlock/docs/swagger.json b/sherlock/docs/swagger.json
@@ -6594,7 +6594,7 @@
                     },
                     {
                         "type": "boolean",
-                        "default": false,
+                        "description": "If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users",
                         "name": "suspended",
                         "in": "query"
                     },
@@ -7023,6 +7023,7 @@
                     },
                     {
                         "type": "boolean",
+                        "description": "When true, the \"suspended\" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field",
                         "name": "suspendNonSuitableUsers",
                         "in": "query"
                     },
@@ -9818,8 +9819,8 @@
                     "type": "object"
                 },
                 "suspended": {
-                    "type": "boolean",
-                    "default": false
+                    "description": "If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users",
+                    "type": "boolean"
                 },
                 "userInfo": {
                     "type": "object"
@@ -9838,8 +9839,8 @@
                     "type": "string"
                 },
                 "suspended": {
-                    "type": "boolean",
-                    "default": false
+                    "description": "If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users",
+                    "type": "boolean"
                 }
             }
         },
@@ -9890,6 +9891,7 @@
                     "type": "string"
                 },
                 "suspendNonSuitableUsers": {
+                    "description": "When true, the \"suspended\" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field",
                     "type": "boolean"
                 },
                 "updatedAt": {
@@ -9929,6 +9931,7 @@
                     "type": "string"
                 },
                 "suspendNonSuitableUsers": {
+                    "description": "When true, the \"suspended\" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field",
                     "type": "boolean"
                 }
             }

diff --git a/sherlock/docs/swagger.yaml b/sherlock/docs/swagger.yaml
@@ -1560,7 +1560,8 @@ definitions:
       roleInfo:
         type: object
       suspended:
-        default: false
+        description: If the assignment should be active. This field is only mutable
+          through the API if the role doesn't automatically suspend non-suitable users
         type: boolean
       userInfo:
         type: object
@@ -1576,7 +1577,8 @@ definitions:
           directly)
         type: string
       suspended:
-        default: false
+        description: If the assignment should be active. This field is only mutable
+          through the API if the role doesn't automatically suspend non-suitable users
         type: boolean
     type: object
   sherlock.RoleV3:
@@ -1611,6 +1613,9 @@ definitions:
       name:
         type: string
       suspendNonSuitableUsers:
+        description: When true, the "suspended" field on role assignments will be
+          computed by Sherlock based on suitability instead of being a mutable API
+          field
         type: boolean
       updatedAt:
         format: date-time
@@ -1637,6 +1642,9 @@ definitions:
       name:
         type: string
       suspendNonSuitableUsers:
+        description: When true, the "suspended" field on role assignments will be
+          computed by Sherlock based on suitability instead of being a mutable API
+          field
         type: boolean
     type: object
   sherlock.SlackDeployHookTestRunRequest:
@@ -6216,7 +6224,8 @@ paths:
         in: query
         name: expiresIn
         type: string
-      - default: false
+      - description: If the assignment should be active. This field is only mutable
+          through the API if the role doesn't automatically suspend non-suitable users
         in: query
         name: suspended
         type: boolean
@@ -6522,7 +6531,10 @@ paths:
       - in: query
         name: name
         type: string
-      - in: query
+      - description: When true, the "suspended" field on role assignments will be
+          computed by Sherlock based on suitability instead of being a mutable API
+          field
+        in: query
         name: suspendNonSuitableUsers
         type: boolean
       - format: date-time