From 803a8271535c958ab634417405fdce2d34d54173 Mon Sep 17 00:00:00 2001 From: broadbot Date: Mon, 8 Jul 2024 14:42:08 +0000 Subject: [PATCH] [sherlock-build] generated from ceb5dd02947b202506bcf1b1353a50a6db4e9112 --- .../models/sherlock_role_assignment_v3.go | 4 ++-- .../sherlock_role_assignment_v3_edit.go | 4 ++-- .../client/models/sherlock_role_v3.go | 2 +- .../client/models/sherlock_role_v3_edit.go | 2 +- .../get_api_role_assignments_v3_parameters.go | 18 +++++------------ .../roles/get_api_roles_v3_parameters.go | 5 ++++- sherlock-typescript-client/README.md | 4 ++-- sherlock-typescript-client/package-lock.json | 4 ++-- sherlock-typescript-client/package.json | 2 +- .../src/models/SherlockRoleAssignmentV3.ts | 2 +- .../models/SherlockRoleAssignmentV3Edit.ts | 2 +- .../src/models/SherlockRoleV3.ts | 2 +- .../src/models/SherlockRoleV3Edit.ts | 2 +- sherlock/docs/docs.go | 13 +++++++----- sherlock/docs/swagger.json | 13 +++++++----- sherlock/docs/swagger.yaml | 20 +++++++++++++++---- 16 files changed, 56 insertions(+), 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 index 7aec95d4e..243b2aff8 100644 --- a/sherlock-go-client/client/models/sherlock_role_assignment_v3.go +++ b/sherlock-go-client/client/models/sherlock_role_assignment_v3.go @@ -29,8 +29,8 @@ type SherlockRoleAssignmentV3 struct { // role info RoleInfo interface{} `json:"roleInfo,omitempty"` - // suspended - Suspended *bool `json:"suspended,omitempty"` + // If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users + Suspended bool `json:"suspended,omitempty"` // user info UserInfo interface{} `json:"userInfo,omitempty"` 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 index 4a1b39bdd..0df09084d 100644 --- a/sherlock-go-client/client/models/sherlock_role_assignment_v3_edit.go +++ b/sherlock-go-client/client/models/sherlock_role_assignment_v3_edit.go @@ -26,8 +26,8 @@ type SherlockRoleAssignmentV3Edit struct { // A Go time.Duration string that will be added to the current time to attempt to set expiresAt (this may be more convenient than setting expiresAt directly) ExpiresIn string `json:"expiresIn,omitempty"` - // suspended - Suspended *bool `json:"suspended,omitempty"` + // If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users + Suspended bool `json:"suspended,omitempty"` } // Validate validates this sherlock role assignment v3 edit diff --git a/sherlock-go-client/client/models/sherlock_role_v3.go b/sherlock-go-client/client/models/sherlock_role_v3.go index 1ebb2d57e..ef9a96828 100644 --- a/sherlock-go-client/client/models/sherlock_role_v3.go +++ b/sherlock-go-client/client/models/sherlock_role_v3.go @@ -60,7 +60,7 @@ type SherlockRoleV3 struct { // name Name string `json:"name,omitempty"` - // suspend non suitable users + // When true, the "suspended" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field SuspendNonSuitableUsers bool `json:"suspendNonSuitableUsers,omitempty"` // updated at diff --git a/sherlock-go-client/client/models/sherlock_role_v3_edit.go b/sherlock-go-client/client/models/sherlock_role_v3_edit.go index 3043935c0..b18b22f36 100644 --- a/sherlock-go-client/client/models/sherlock_role_v3_edit.go +++ b/sherlock-go-client/client/models/sherlock_role_v3_edit.go @@ -44,7 +44,7 @@ type SherlockRoleV3Edit struct { // name Name string `json:"name,omitempty"` - // suspend non suitable users + // When true, the "suspended" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field SuspendNonSuitableUsers bool `json:"suspendNonSuitableUsers,omitempty"` } 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 index 43863f7e2..554d40e29 100644 --- 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 @@ -83,7 +83,10 @@ type GetAPIRoleAssignmentsV3Params struct { */ Offset *int64 - // Suspended. + /* Suspended. + + If the assignment should be active. This field is only mutable through the API if the role doesn't automatically suspend non-suitable users + */ Suspended *bool timeout time.Duration @@ -103,18 +106,7 @@ func (o *GetAPIRoleAssignmentsV3Params) WithDefaults() *GetAPIRoleAssignmentsV3P // // All values with no default are reset to their zero value. func (o *GetAPIRoleAssignmentsV3Params) SetDefaults() { - var ( - suspendedDefault = bool(false) - ) - - val := GetAPIRoleAssignmentsV3Params{ - Suspended: &suspendedDefault, - } - - val.timeout = o.timeout - val.Context = o.Context - val.HTTPClient = o.HTTPClient - *o = val + // no default values defined for this parameter } // WithTimeout adds the timeout to the get API role assignments v3 params 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 index d06e9f9c7..546c9f929 100644 --- a/sherlock-go-client/client/roles/get_api_roles_v3_parameters.go +++ b/sherlock-go-client/client/roles/get_api_roles_v3_parameters.go @@ -107,7 +107,10 @@ type GetAPIRolesV3Params struct { */ Offset *int64 - // SuspendNonSuitableUsers. + /* SuspendNonSuitableUsers. + + When true, the "suspended" field on role assignments will be computed by Sherlock based on suitability instead of being a mutable API field + */ SuspendNonSuitableUsers *bool // UpdatedAt. diff --git a/sherlock-typescript-client/README.md b/sherlock-typescript-client/README.md index e04f27bbb..9a4b03c17 100644 --- 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/sherlock@v1.5.11 --save +npm install @sherlock-js-client/sherlock@v1.5.12 --save ``` _unPublished (not recommended):_ diff --git a/sherlock-typescript-client/package-lock.json b/sherlock-typescript-client/package-lock.json index c5686e25e..abb7f9605 100644 --- a/sherlock-typescript-client/package-lock.json +++ b/sherlock-typescript-client/package-lock.json @@ -1,12 +1,12 @@ { "name": "@sherlock-js-client/sherlock", - "version": "v1.5.11", + "version": "v1.5.12", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@sherlock-js-client/sherlock", - "version": "v1.5.11", + "version": "v1.5.12", "devDependencies": { "typescript": "^4.0 || ^5.0" } diff --git a/sherlock-typescript-client/package.json b/sherlock-typescript-client/package.json index ac01c790b..ce4a5b6d8 100644 --- 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 index 8a55a17cb..86942b284 100644 --- 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 index ec991d5f0..c66728cf0 100644 --- 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 index 11d7d1f74..12f0817f8 100644 --- 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 index 9036da049..ec6661e8d 100644 --- 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 index 0a5c5036e..4b004b058 100644 --- 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 index fc2bb9d57..5974dcee6 100644 --- 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 index 39b7beaca..5a9c7abdb 100644 --- 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