Skip to content

Commit a4fddb2

Browse files
kesmit13claude
andcommitted
docs: update API reference for management classes and methods
Add documentation for new management API classes and methods: - Add manage_storage_dr and manage_metrics functions - Add StorageDRManager with all methods - Add MetricsManager with get_workspace_group_metrics - Add UserInvitation class for user invitation management - Add new UsersManager invitation methods - Add StorageDRCompute, UsageItem, and BillingUsageItem classes - Correct WorkspaceGroupMetric to WorkspaceGroupMetrics 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 02f9ca3 commit a4fddb2

File tree

1 file changed

+70
-5
lines changed

1 file changed

+70
-5
lines changed

docs/src/api.rst

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,8 @@ object that can be used to interact with the Management API.
243243
manage_users
244244
manage_audit_logs
245245
manage_private_connections
246+
manage_storage_dr
247+
manage_metrics
246248

247249

248250
WorkspaceManager
@@ -485,6 +487,11 @@ They allow you to retrieve and manage users in your organization.
485487
UsersManager
486488
UsersManager.get_user
487489
UsersManager.get_user_identity_roles
490+
UsersManager.create_user_invitation
491+
UsersManager.get_user_invitation
492+
UsersManager.list_user_invitations
493+
UsersManager.delete_user_invitation
494+
UsersManager.user_invitations
488495

489496

490497
User
@@ -499,6 +506,17 @@ User objects are retrieved from :meth:`UsersManager.get_user`.
499506
User.identity_roles
500507

501508

509+
UserInvitation
510+
..............
511+
512+
UserInvitation objects are returned by the various UsersManager invitation methods.
513+
514+
.. autosummary::
515+
:toctree: generated/
516+
517+
UserInvitation
518+
519+
502520
AuditLogsManager
503521
................
504522

@@ -596,36 +614,83 @@ IdentityRole objects are used by both teams and users management for role inform
596614
IdentityRole
597615

598616

617+
StorageDRManager
618+
................
619+
620+
StorageDRManager objects are returned by the :func:`manage_storage_dr` function.
621+
They allow you to manage storage disaster recovery for your organization.
622+
623+
.. currentmodule:: singlestoredb.management.storage_dr
624+
625+
.. autosummary::
626+
:toctree: generated/
627+
628+
StorageDRManager
629+
StorageDRManager.get_status
630+
StorageDRManager.get_available_regions
631+
StorageDRManager.setup_storage_dr
632+
StorageDRManager.start_failover
633+
StorageDRManager.start_failback
634+
StorageDRManager.start_pre_provision
635+
StorageDRManager.stop_pre_provision
636+
637+
599638
Storage DR
600639
----------
601640

602641
Storage Disaster Recovery objects provide information about replicated databases
603642
and disaster recovery regions.
604643

605-
.. currentmodule:: singlestoredb.management.storage_dr
606-
607644
.. autosummary::
608645
:toctree: generated/
609646

610647
ReplicatedDatabase
611648
StorageDRStatus
612649
StorageDRRegion
650+
StorageDRCompute
651+
652+
653+
MetricsManager
654+
..............
655+
656+
MetricsManager objects are returned by the :func:`manage_metrics` function.
657+
They allow you to retrieve metrics for your organization.
658+
659+
.. currentmodule:: singlestoredb.management.metrics
660+
661+
.. autosummary::
662+
:toctree: generated/
663+
664+
MetricsManager
665+
MetricsManager.get_workspace_group_metrics
613666

614667

615668
Metrics
616669
-------
617670

618671
Metrics objects provide workspace group metrics and data points.
619672

620-
.. currentmodule:: singlestoredb.management.metrics
621-
622673
.. autosummary::
623674
:toctree: generated/
624675

625-
WorkspaceGroupMetric
676+
WorkspaceGroupMetrics
626677
MetricDataPoint
627678

628679

680+
Billing Usage
681+
-------------
682+
683+
Billing Usage objects provide usage and billing information for workspaces.
684+
685+
.. currentmodule:: singlestoredb.management.billing_usage
686+
687+
.. autosummary::
688+
:toctree: generated/
689+
690+
UsageItem
691+
BillingUsageItem
692+
693+
629694
Notebook Tools
630695
--------------
631696

0 commit comments

Comments
 (0)