Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs on ListIdentities #4248

Merged
merged 2 commits into from
Dec 20, 2024
Merged

chore: update docs on ListIdentities #4248

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
108dc11
chore: update docs on ListIdentities
alnr Dec 17, 2024
41706a6
fix: identity/handler.go
alnr Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions identity/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
alnr marked this conversation as resolved.
Show resolved Hide resolved
//
// required: false
// in: query
Expand Down Expand Up @@ -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"`
Expand Down
4 changes: 2 additions & 2 deletions spec/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
4 changes: 2 additions & 2 deletions spec/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand All @@ -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"
}
Expand Down
Loading