From 108dc116a1095bb14efbee072aae54630894bab5 Mon Sep 17 00:00:00 2001 From: Arne Luenser Date: Tue, 17 Dec 2024 12:05:18 +0100 Subject: [PATCH 1/2] chore: update docs on ListIdentities --- identity/handler.go | 11 +++++++---- spec/api.json | 4 ++-- spec/swagger.json | 4 ++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/identity/handler.go b/identity/handler.go index 84bc886322fd..ef51930567fe 100644 --- a/identity/handler.go +++ b/identity/handler.go @@ -136,8 +136,12 @@ type _ struct { type _ struct { migrationpagination.RequestParameters - // List of ids used to filter identities. - // If this list is empty, then no filter will be applied. + // Retrieve multiple identities by their IDs. + // The order of the IDs in the response may be different from the request. + // Duplicate or non-existent IDs are ignored. + // Max. no. of ids: 500 + // This filter does not support pagination. To retrieve more than 500 + // identities by ID, split your request into multiple calls client-side. // // required: false // in: query @@ -169,9 +173,8 @@ type _ struct { // in: query DeclassifyCredentials []string `json:"include_credential"` - // OrganizationID is the organization id to filter identities by. + // List identities that belong to a specific organization. // - // If `ids` is set, this parameter is ignored. // required: false // in: query OrganizationID string `json:"organization_id"` diff --git a/spec/api.json b/spec/api.json index 87650d834bb7..896e18f672a9 100644 --- a/spec/api.json +++ b/spec/api.json @@ -3991,7 +3991,7 @@ "x-go-enum-desc": " ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps." }, { - "description": "List of ids used to filter identities.\nIf this list is empty, then no filter will be applied.", + "description": "Retrieve multiple identities by their IDs.\nThe order of the IDs in the response may be different from the request.\nDuplicate or non-existent IDs are ignored.\nMax. no. of ids: 500\nThis filter does not support pagination. To retrieve more than 500\nidentities by ID, split your request into multiple calls client-side.", "in": "query", "name": "ids", "schema": { @@ -4029,7 +4029,7 @@ } }, { - "description": "OrganizationID is the organization id to filter identities by.\n\nIf `ids` is set, this parameter is ignored.", + "description": "List identities that belong to a specific organization.", "in": "query", "name": "organization_id", "schema": { diff --git a/spec/swagger.json b/spec/swagger.json index 9071e0d298bf..7f260e2b0e3e 100755 --- a/spec/swagger.json +++ b/spec/swagger.json @@ -237,7 +237,7 @@ "items": { "type": "string" }, - "description": "List of ids used to filter identities.\nIf this list is empty, then no filter will be applied.", + "description": "Retrieve multiple identities by their IDs.\nThe order of the IDs in the response may be different from the request.\nDuplicate or non-existent IDs are ignored.\nMax. no. of ids: 500\nThis filter does not support pagination. To retrieve more than 500\nidentities by ID, split your request into multiple calls client-side.", "name": "ids", "in": "query" }, @@ -264,7 +264,7 @@ }, { "type": "string", - "description": "OrganizationID is the organization id to filter identities by.\n\nIf `ids` is set, this parameter is ignored.", + "description": "List identities that belong to a specific organization.", "name": "organization_id", "in": "query" } From 41706a6a7705be43a6a0ac6ea635b8965f7d29ad Mon Sep 17 00:00:00 2001 From: Arne Luenser Date: Tue, 17 Dec 2024 13:12:38 +0100 Subject: [PATCH 2/2] fix: identity/handler.go Co-authored-by: hackerman <3372410+aeneasr@users.noreply.github.com> --- identity/handler.go | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/identity/handler.go b/identity/handler.go index ef51930567fe..6d458636854d 100644 --- a/identity/handler.go +++ b/identity/handler.go @@ -137,11 +137,12 @@ type _ struct { migrationpagination.RequestParameters // Retrieve multiple identities by their IDs. - // The order of the IDs in the response may be different from the request. - // Duplicate or non-existent IDs are ignored. - // Max. no. of ids: 500 - // This filter does not support pagination. To retrieve more than 500 - // identities by ID, split your request into multiple calls client-side. + // + // This parameter has the following limitations: + // + // - Duplicate or non-existent IDs are ignored. + // - The order of returned IDs may be different from the request. + // - This filter does not support pagination. You must implement your own pagination as the maximum number of items returned by this endpoint may not exceed a certain threshold (currently 500). // // required: false // in: query