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

[Internal] Update Doc generation to fix formatting issue #842

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+829 −946
Open

[Internal] Update Doc generation to fix formatting issue #842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion docs/account/billing/billable_usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,3 @@
false.

:returns: :class:`DownloadResponse`

11 changes: 5 additions & 6 deletions docs/account/billing/budgets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
Properties of the new budget configuration.

:returns: :class:`CreateBudgetConfigurationResponse`


.. py:method:: delete(budget_id: str)
Expand All @@ -67,8 +67,8 @@
:param budget_id: str
The Databricks budget configuration ID.




.. py:method:: get(budget_id: str) -> GetBudgetConfigurationResponse
Expand Down Expand Up @@ -118,7 +118,7 @@
The budget configuration ID

:returns: :class:`GetBudgetConfigurationResponse`


.. py:method:: list( [, page_token: Optional[str]]) -> Iterator[BudgetConfiguration]
Expand All @@ -143,7 +143,7 @@
retrieve the subsequent page. Requests first page if absent.

:returns: Iterator over :class:`BudgetConfiguration`


.. py:method:: update(budget_id: str, budget: UpdateBudgetConfigurationBudget) -> UpdateBudgetConfigurationResponse
Expand Down Expand Up @@ -215,4 +215,3 @@
The updated budget. This will overwrite the budget specified by the budget ID.

:returns: :class:`UpdateBudgetConfigurationResponse`

9 changes: 4 additions & 5 deletions docs/account/billing/log_delivery.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
:param log_delivery_configuration: :class:`CreateLogDeliveryConfigurationParams` (optional)

:returns: :class:`WrappedLogDeliveryConfiguration`


.. py:method:: get(log_delivery_configuration_id: str) -> WrappedLogDeliveryConfiguration
Expand Down Expand Up @@ -161,7 +161,7 @@
Databricks log delivery configuration ID

:returns: :class:`WrappedLogDeliveryConfiguration`


.. py:method:: list( [, credentials_id: Optional[str], status: Optional[LogDeliveryConfigStatus], storage_configuration_id: Optional[str]]) -> Iterator[LogDeliveryConfiguration]
Expand Down Expand Up @@ -189,7 +189,7 @@
Filter by storage configuration ID.

:returns: Iterator over :class:`LogDeliveryConfiguration`


.. py:method:: patch_status(log_delivery_configuration_id: str, status: LogDeliveryConfigStatus)
Expand All @@ -208,5 +208,4 @@
configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is
not supported, so disable a log delivery configuration that is no longer needed.




3 changes: 1 addition & 2 deletions docs/account/billing/usage_dashboards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
The workspace ID of the workspace in which the usage dashboard is created.

:returns: :class:`CreateBillingUsageDashboardResponse`


.. py:method:: get( [, dashboard_type: Optional[UsageDashboardType], workspace_id: Optional[int]]) -> GetBillingUsageDashboardResponse
Expand All @@ -36,4 +36,3 @@
The workspace ID of the workspace in which the usage dashboard is created.

:returns: :class:`GetBillingUsageDashboardResponse`

15 changes: 7 additions & 8 deletions docs/account/catalog/metastore_assignments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
Unity Catalog metastore ID
:param metastore_assignment: :class:`CreateMetastoreAssignment` (optional)




.. py:method:: delete(workspace_id: int, metastore_id: str)
Expand All @@ -32,8 +32,8 @@
:param metastore_id: str
Unity Catalog metastore ID




.. py:method:: get(workspace_id: int) -> AccountsMetastoreAssignment
Expand All @@ -47,7 +47,7 @@
Workspace ID.

:returns: :class:`AccountsMetastoreAssignment`


.. py:method:: list(metastore_id: str) -> Iterator[int]
Expand All @@ -72,7 +72,7 @@
Unity Catalog metastore ID

:returns: Iterator over int


.. py:method:: update(workspace_id: int, metastore_id: str [, metastore_assignment: Optional[UpdateMetastoreAssignment]])
Expand All @@ -87,5 +87,4 @@
Unity Catalog metastore ID
:param metastore_assignment: :class:`UpdateMetastoreAssignment` (optional)




11 changes: 5 additions & 6 deletions docs/account/catalog/metastores.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
:param metastore_info: :class:`CreateMetastore` (optional)

:returns: :class:`AccountsMetastoreInfo`


.. py:method:: delete(metastore_id: str [, force: Optional[bool]])
Expand All @@ -29,8 +29,8 @@
:param force: bool (optional)
Force deletion even if the metastore is not empty. Default is false.




.. py:method:: get(metastore_id: str) -> AccountsMetastoreInfo
Expand All @@ -42,7 +42,7 @@
Unity Catalog metastore ID

:returns: :class:`AccountsMetastoreInfo`


.. py:method:: list() -> Iterator[MetastoreInfo]
Expand All @@ -51,7 +51,7 @@
Gets all Unity Catalog metastores associated with an account specified by ID.

:returns: Iterator over :class:`MetastoreInfo`


.. py:method:: update(metastore_id: str [, metastore_info: Optional[UpdateMetastore]]) -> AccountsMetastoreInfo
Expand All @@ -64,4 +64,3 @@
:param metastore_info: :class:`UpdateMetastore` (optional)

:returns: :class:`AccountsMetastoreInfo`

11 changes: 5 additions & 6 deletions docs/account/catalog/storage_credentials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
:param credential_info: :class:`CreateStorageCredential` (optional)

:returns: :class:`AccountsStorageCredentialInfo`


.. py:method:: delete(metastore_id: str, storage_credential_name: str [, force: Optional[bool]])
Expand All @@ -39,8 +39,8 @@
:param force: bool (optional)
Force deletion even if the Storage Credential is not empty. Default is false.




.. py:method:: get(metastore_id: str, storage_credential_name: str) -> AccountsStorageCredentialInfo
Expand All @@ -55,7 +55,7 @@
Name of the storage credential.

:returns: :class:`AccountsStorageCredentialInfo`


.. py:method:: list(metastore_id: str) -> Iterator[StorageCredentialInfo]
Expand All @@ -67,7 +67,7 @@
Unity Catalog metastore ID

:returns: Iterator over :class:`StorageCredentialInfo`


.. py:method:: update(metastore_id: str, storage_credential_name: str [, credential_info: Optional[UpdateStorageCredential]]) -> AccountsStorageCredentialInfo
Expand All @@ -83,4 +83,3 @@
:param credential_info: :class:`UpdateStorageCredential` (optional)

:returns: :class:`AccountsStorageCredentialInfo`

5 changes: 2 additions & 3 deletions docs/account/iam/access_control.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
The resource name for which assignable roles will be listed.

:returns: :class:`GetAssignableRolesForResourceResponse`


.. py:method:: get_rule_set(name: str, etag: str) -> RuleSetResponse
Expand All @@ -39,7 +39,7 @@
version you are updating.

:returns: :class:`RuleSetResponse`


.. py:method:: update_rule_set(name: str, rule_set: RuleSetUpdateRequest) -> RuleSetResponse
Expand All @@ -53,4 +53,3 @@
:param rule_set: :class:`RuleSetUpdateRequest`

:returns: :class:`RuleSetResponse`

17 changes: 8 additions & 9 deletions docs/account/iam/groups.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
The schema of the group.

:returns: :class:`Group`


.. py:method:: delete(id: str)
Expand All @@ -48,8 +48,8 @@
:param id: str
Unique ID for a group in the Databricks account.




.. py:method:: get(id: str) -> Group
Expand All @@ -61,7 +61,7 @@
Unique ID for a group in the Databricks account.

:returns: :class:`Group`


.. py:method:: list( [, attributes: Optional[str], count: Optional[int], excluded_attributes: Optional[str], filter: Optional[str], sort_by: Optional[str], sort_order: Optional[ListSortOrder], start_index: Optional[int]]) -> Iterator[Group]
Expand Down Expand Up @@ -90,7 +90,7 @@
Specifies the index of the first result. First item is number 1.

:returns: Iterator over :class:`Group`


.. py:method:: patch(id: str [, operations: Optional[List[Patch]], schemas: Optional[List[PatchSchema]]])
Expand All @@ -104,8 +104,8 @@
:param schemas: List[:class:`PatchSchema`] (optional)
The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].




.. py:method:: update(id: str [, display_name: Optional[str], entitlements: Optional[List[ComplexValue]], external_id: Optional[str], groups: Optional[List[ComplexValue]], members: Optional[List[ComplexValue]], meta: Optional[ResourceMeta], roles: Optional[List[ComplexValue]], schemas: Optional[List[GroupSchema]]])
Expand All @@ -132,5 +132,4 @@
:param schemas: List[:class:`GroupSchema`] (optional)
The schema of the group.




17 changes: 8 additions & 9 deletions docs/account/iam/service_principals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
The schema of the List response.

:returns: :class:`ServicePrincipal`


.. py:method:: delete(id: str)
Expand All @@ -64,8 +64,8 @@
:param id: str
Unique ID for a service principal in the Databricks account.




.. py:method:: get(id: str) -> ServicePrincipal
Expand Down Expand Up @@ -95,7 +95,7 @@
Unique ID for a service principal in the Databricks account.

:returns: :class:`ServicePrincipal`


.. py:method:: list( [, attributes: Optional[str], count: Optional[int], excluded_attributes: Optional[str], filter: Optional[str], sort_by: Optional[str], sort_order: Optional[ListSortOrder], start_index: Optional[int]]) -> Iterator[ServicePrincipal]
Expand Down Expand Up @@ -144,7 +144,7 @@
Specifies the index of the first result. First item is number 1.

:returns: Iterator over :class:`ServicePrincipal`


.. py:method:: patch(id: str [, operations: Optional[List[Patch]], schemas: Optional[List[PatchSchema]]])
Expand Down Expand Up @@ -181,8 +181,8 @@
:param schemas: List[:class:`PatchSchema`] (optional)
The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].




.. py:method:: update(id: str [, active: Optional[bool], application_id: Optional[str], display_name: Optional[str], entitlements: Optional[List[ComplexValue]], external_id: Optional[str], groups: Optional[List[ComplexValue]], roles: Optional[List[ComplexValue]], schemas: Optional[List[ServicePrincipalSchema]]])
Expand Down Expand Up @@ -232,5 +232,4 @@
:param schemas: List[:class:`ServicePrincipalSchema`] (optional)
The schema of the List response.




Loading
Loading