Skip to content

Commit

Permalink
Show undocumented fields in dataclasses (#520)
Browse files Browse the repository at this point in the history
## Changes
Some fields are undocumented in dataclasses. Those are hidden by default
with `autoclass`. This PR makes sure that all public fields are shown,
even those with no documentation.

https://databricks-sdk-py--520.org.readthedocs.build/en/520/

## Tests
<!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [ ] `make test` run locally
- [ ] `make fmt` applied
- [ ] relevant integration tests applied
  • Loading branch information
mgyucht authored Jan 29, 2024
1 parent 851be2b commit fff9a67
Show file tree
Hide file tree
Showing 18 changed files with 898 additions and 18 deletions.
17 changes: 16 additions & 1 deletion docs/dbdataclasses/billing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,46 @@ These dataclasses are used in the SDK to represent API requests and responses fo
.. py:currentmodule:: databricks.sdk.service.billing
.. autoclass:: Budget
:members:
:undoc-members:
.. autoclass:: BudgetAlert
:members:
:undoc-members:
.. autoclass:: BudgetList
:members:
:undoc-members:
.. autoclass:: BudgetWithStatus
:members:
:undoc-members:
.. autoclass:: BudgetWithStatusStatusDailyItem
:members:
:undoc-members:
.. autoclass:: CreateLogDeliveryConfigurationParams
:members:
:undoc-members:
.. autoclass:: DownloadResponse
:members:
:undoc-members:
.. autoclass:: LogDeliveryConfiguration
:members:
:undoc-members:
.. autoclass:: LogDeliveryStatus
:members:
:undoc-members:
.. autoclass:: UpdateLogDeliveryConfigurationStatusRequest
:members:
:undoc-members:
.. autoclass:: WrappedBudget
:members:
:undoc-members:
.. autoclass:: WrappedBudgetWithStatus
:members:
:undoc-members:
.. autoclass:: WrappedCreateLogDeliveryConfiguration
:members:
:undoc-members:
.. autoclass:: WrappedLogDeliveryConfiguration
:members:
:undoc-members:
.. autoclass:: WrappedLogDeliveryConfigurations
:members:
:members:
:undoc-members:
106 changes: 105 additions & 1 deletion docs/dbdataclasses/catalog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,209 +6,313 @@ These dataclasses are used in the SDK to represent API requests and responses fo
.. py:currentmodule:: databricks.sdk.service.catalog
.. autoclass:: AccountsCreateMetastore
:members:
:undoc-members:
.. autoclass:: AccountsCreateMetastoreAssignment
:members:
:undoc-members:
.. autoclass:: AccountsCreateStorageCredential
:members:
:undoc-members:
.. autoclass:: AccountsMetastoreAssignment
:members:
:undoc-members:
.. autoclass:: AccountsMetastoreInfo
:members:
:undoc-members:
.. autoclass:: AccountsStorageCredentialInfo
:members:
:undoc-members:
.. autoclass:: AccountsUpdateMetastore
:members:
:undoc-members:
.. autoclass:: AccountsUpdateMetastoreAssignment
:members:
:undoc-members:
.. autoclass:: AccountsUpdateStorageCredential
:members:
:undoc-members:
.. autoclass:: ArtifactAllowlistInfo
:members:
:undoc-members:
.. autoclass:: ArtifactMatcher
:members:
:undoc-members:
.. autoclass:: AwsIamRole
:members:
:undoc-members:
.. autoclass:: AzureManagedIdentity
:members:
:undoc-members:
.. autoclass:: AzureServicePrincipal
:members:
:undoc-members:
.. autoclass:: CatalogInfo
:members:
:undoc-members:
.. autoclass:: CloudflareApiToken
:members:
:undoc-members:
.. autoclass:: ColumnInfo
:members:
:undoc-members:
.. autoclass:: ColumnMask
:members:
:undoc-members:
.. autoclass:: ConnectionInfo
:members:
:undoc-members:
.. autoclass:: CreateCatalog
:members:
:undoc-members:
.. autoclass:: CreateConnection
:members:
:undoc-members:
.. autoclass:: CreateExternalLocation
:members:
:undoc-members:
.. autoclass:: CreateFunction
:members:
:undoc-members:
.. autoclass:: CreateFunctionRequest
:members:
:undoc-members:
.. autoclass:: CreateMetastore
:members:
:undoc-members:
.. autoclass:: CreateMetastoreAssignment
:members:
:undoc-members:
.. autoclass:: CreateRegisteredModelRequest
:members:
:undoc-members:
.. autoclass:: CreateSchema
:members:
:undoc-members:
.. autoclass:: CreateStorageCredential
:members:
:undoc-members:
.. autoclass:: CreateTableConstraint
:members:
:undoc-members:
.. autoclass:: CreateVolumeRequestContent
:members:
:undoc-members:
.. autoclass:: CurrentWorkspaceBindings
:members:
:undoc-members:
.. autoclass:: DatabricksGcpServiceAccountResponse
:members:
:undoc-members:
.. autoclass:: DeltaRuntimePropertiesKvPairs
:members:
:undoc-members:
.. autoclass:: Dependency
:members:
:undoc-members:
.. autoclass:: DependencyList
:members:
:undoc-members:
.. autoclass:: EffectivePermissionsList
:members:
:undoc-members:
.. autoclass:: EffectivePredictiveOptimizationFlag
:members:
:undoc-members:
.. autoclass:: EffectivePrivilege
:members:
:undoc-members:
.. autoclass:: EffectivePrivilegeAssignment
:members:
:undoc-members:
.. autoclass:: EncryptionDetails
:members:
:undoc-members:
.. autoclass:: ExternalLocationInfo
:members:
:undoc-members:
.. autoclass:: ForeignKeyConstraint
:members:
:undoc-members:
.. autoclass:: FunctionDependency
:members:
:undoc-members:
.. autoclass:: FunctionInfo
:members:
:undoc-members:
.. autoclass:: FunctionParameterInfo
:members:
:undoc-members:
.. autoclass:: FunctionParameterInfos
:members:
:undoc-members:
.. autoclass:: GetMetastoreSummaryResponse
:members:
:undoc-members:
.. autoclass:: ListAccountMetastoreAssignmentsResponse
:members:
:undoc-members:
.. autoclass:: ListCatalogsResponse
:members:
:undoc-members:
.. autoclass:: ListConnectionsResponse
:members:
:undoc-members:
.. autoclass:: ListExternalLocationsResponse
:members:
:undoc-members:
.. autoclass:: ListFunctionsResponse
:members:
:undoc-members:
.. autoclass:: ListMetastoresResponse
:members:
:undoc-members:
.. autoclass:: ListModelVersionsResponse
:members:
:undoc-members:
.. autoclass:: ListRegisteredModelsResponse
:members:
:undoc-members:
.. autoclass:: ListSchemasResponse
:members:
:undoc-members:
.. autoclass:: ListStorageCredentialsResponse
:members:
:undoc-members:
.. autoclass:: ListSystemSchemasResponse
:members:
:undoc-members:
.. autoclass:: ListTableSummariesResponse
:members:
:undoc-members:
.. autoclass:: ListTablesResponse
:members:
:undoc-members:
.. autoclass:: ListVolumesResponseContent
:members:
:undoc-members:
.. autoclass:: MetastoreAssignment
:members:
:undoc-members:
.. autoclass:: MetastoreInfo
:members:
:undoc-members:
.. autoclass:: ModelVersionInfo
:members:
:undoc-members:
.. autoclass:: NamedTableConstraint
:members:
:undoc-members:
.. autoclass:: PermissionsChange
:members:
:undoc-members:
.. autoclass:: PermissionsList
:members:
:undoc-members:
.. autoclass:: PrimaryKeyConstraint
:members:
:undoc-members:
.. autoclass:: PrivilegeAssignment
:members:
:undoc-members:
.. autoclass:: ProvisioningInfo
:members:
:undoc-members:
.. autoclass:: RegisteredModelAlias
:members:
:undoc-members:
.. autoclass:: RegisteredModelInfo
:members:
:undoc-members:
.. autoclass:: SchemaInfo
:members:
:undoc-members:
.. autoclass:: SetArtifactAllowlist
:members:
:undoc-members:
.. autoclass:: SetRegisteredModelAliasRequest
:members:
:undoc-members:
.. autoclass:: SseEncryptionDetails
:members:
:undoc-members:
.. autoclass:: StorageCredentialInfo
:members:
:undoc-members:
.. autoclass:: SystemSchemaInfo
:members:
:undoc-members:
.. autoclass:: TableConstraint
:members:
:undoc-members:
.. autoclass:: TableDependency
:members:
:undoc-members:
.. autoclass:: TableInfo
:members:
:undoc-members:
.. autoclass:: TableRowFilter
:members:
:undoc-members:
.. autoclass:: TableSummary
:members:
:undoc-members:
.. autoclass:: UpdateCatalog
:members:
:undoc-members:
.. autoclass:: UpdateConnection
:members:
:undoc-members:
.. autoclass:: UpdateExternalLocation
:members:
:undoc-members:
.. autoclass:: UpdateFunction
:members:
:undoc-members:
.. autoclass:: UpdateMetastore
:members:
:undoc-members:
.. autoclass:: UpdateMetastoreAssignment
:members:
:undoc-members:
.. autoclass:: UpdateModelVersionRequest
:members:
:undoc-members:
.. autoclass:: UpdatePermissions
:members:
:undoc-members:
.. autoclass:: UpdateRegisteredModelRequest
:members:
:undoc-members:
.. autoclass:: UpdateSchema
:members:
:undoc-members:
.. autoclass:: UpdateStorageCredential
:members:
:undoc-members:
.. autoclass:: UpdateVolumeRequestContent
:members:
:undoc-members:
.. autoclass:: UpdateWorkspaceBindings
:members:
:undoc-members:
.. autoclass:: UpdateWorkspaceBindingsParameters
:members:
:undoc-members:
.. autoclass:: ValidateStorageCredential
:members:
:undoc-members:
.. autoclass:: ValidateStorageCredentialResponse
:members:
:undoc-members:
.. autoclass:: ValidationResult
:members:
:undoc-members:
.. autoclass:: VolumeInfo
:members:
:undoc-members:
.. autoclass:: WorkspaceBinding
:members:
:undoc-members:
.. autoclass:: WorkspaceBindingsResponse
:members:
:members:
:undoc-members:
Loading

0 comments on commit fff9a67

Please sign in to comment.