Fix SCIM pagination #193
Merged
Fix SCIM pagination #193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tanmay-db
approved these changes
Nov 24, 2023
.codegen/api.java.tmpl
Outdated
| 0 | ||
| {{- end}}L);{{end -}} | ||
| {{if and .Pagination.Limit (contains .Path "/scim/v2/")}} | ||
| if (request.get{{.Pagination.Limit.PascalName}}() == 0) { |
There was a problem hiding this comment.
nit: 0L instead of 0. It doesn't matter because implicitly java will know 0 is of Long type. But mentioning since we specify 1L and 100L below so might be good for consistency on code reading purposes.
mgyucht
added a commit
that referenced
this pull request
Nov 29, 2023
Bug fixes: * Fix databricks CLI authentication on Windows ([#192](#192)). * Fix SCIM pagination ([#193](#193)). Other changes: * Add more detailed error message on default credentials not found error ([#180](#180)). * Support custom scopes and redirectUrl for U2M OAuth flow ([#190](#190)). API Changes: * Removed `enableOptimization()` method for `workspaceClient.metastores()` service. * Added `pipelineId` field for `com.databricks.sdk.service.catalog.TableInfo`. * Added `enablePredictiveOptimization` field for `com.databricks.sdk.service.catalog.UpdateCatalog` and `com.databricks.sdk.service.catalog.UpdateSchema`. * Removed `com.databricks.sdk.service.catalog.UpdatePredictiveOptimization` and `com.databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse` class. * Added `description` field for `com.databricks.sdk.service.jobs.CreateJob` and `com.databricks.sdk.service.jobs.JobSettings`. * Added `listNetworkConnectivityConfigurations()` and `listPrivateEndpointRules()` methods for `accountClient.networkConnectivity()` service. * Added `com.databricks.sdk.service.settings.ListNccAzurePrivateEndpointRulesResponse`, `com.databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsRequest`, `com.databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse`, and `com.databricks.sdk.service.settings.ListPrivateEndpointRulesRequest` classes. * Added `stringSharedAs` field for `com.databricks.sdk.service.sharing.SharedDataObject`. OpenAPI SHA: 22f09783eb8a84d52026f856be3b2068f9498db3, Date: 2023-11-23 Dependency updates: * Bump API spec: 23 Nov 2023 ([#191](#191)).
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 29, 2023
Bug fixes: * Fix databricks CLI authentication on Windows ([#192](#192)). * Fix SCIM pagination ([#193](#193)). Other changes: * Add more detailed error message on default credentials not found error ([#180](#180)). * Support custom scopes and redirectUrl for U2M OAuth flow ([#190](#190)). API Changes: * Removed `enableOptimization()` method for `workspaceClient.metastores()` service. * Added `pipelineId` field for `com.databricks.sdk.service.catalog.TableInfo`. * Added `enablePredictiveOptimization` field for `com.databricks.sdk.service.catalog.UpdateCatalog` and `com.databricks.sdk.service.catalog.UpdateSchema`. * Removed `com.databricks.sdk.service.catalog.UpdatePredictiveOptimization` and `com.databricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse` class. * Added `description` field for `com.databricks.sdk.service.jobs.CreateJob` and `com.databricks.sdk.service.jobs.JobSettings`. * Added `listNetworkConnectivityConfigurations()` and `listPrivateEndpointRules()` methods for `accountClient.networkConnectivity()` service. * Added `com.databricks.sdk.service.settings.ListNccAzurePrivateEndpointRulesResponse`, `com.databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsRequest`, `com.databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse`, and `com.databricks.sdk.service.settings.ListPrivateEndpointRulesRequest` classes. * Added `stringSharedAs` field for `com.databricks.sdk.service.sharing.SharedDataObject`. OpenAPI SHA: 22f09783eb8a84d52026f856be3b2068f9498db3, Date: 2023-11-23
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Supersedes #188.
This PR incorporates two hard-coded changes for the SCIM API in the Python SDK:
startIndex starts at 1 for SCIM APIs, not 0. However, the existing .Pagination.Increment controls both the start index as well as whether the pagination is per-page or per-resource. Later, we should replace this extension with two independent OpenAPI options: one_indexed (defaulting to false) and pagination_basis (defaulting to resource but can be overridden to page).
If users don't specify a limit, the SDK will include a hard-coded limit of 100 resources per request. We could add this to the OpenAPI spec as an option default_limit, which is useful for any non-paginated APIs that later expose pagination options and allow the SDK to gracefully support those. However, we don't want to encourage folks to use this pattern: all new list APIs are required to be paginated from the start.
Tests