Skip to content

Add OpenAPI docs for usage quotas admin #3895

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI docs for usage quotas admin #3895

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
554 changes: 554 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50292,6 +50292,111 @@ datadog\_api\_client.v2.model.usage\_observability\_pipelines\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_create\_attributes module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_create_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_create\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_request\_scope module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_request_scope
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_response module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_response\_attributes module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_response_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_response\_data module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_response\_scope module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_response_scope
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_type module
-------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_update\_attributes module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_update_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_update\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_update_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quota\_update\_request module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quota_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quotas\_create\_request module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quotas_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quotas\_list\_response module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quotas_list_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quotas\_response module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quotas_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_quotas\_response\_meta module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.usage_quotas_response_meta
:members:
:show-inheritance:

datadog\_api\_client.v2.model.usage\_summary\_available\_fields\_attributes module
----------------------------------------------------------------------------------

Expand Down
35 changes: 35 additions & 0 deletions examples/v2/usage-metering/CreateOrUpdateQuotas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
"""
Create or update usage quotas returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
from datadog_api_client.v2.model.usage_quota_create_attributes import UsageQuotaCreateAttributes
from datadog_api_client.v2.model.usage_quota_create_data import UsageQuotaCreateData
from datadog_api_client.v2.model.usage_quota_request_scope import UsageQuotaRequestScope
from datadog_api_client.v2.model.usage_quota_type import UsageQuotaType
from datadog_api_client.v2.model.usage_quotas_create_request import UsageQuotasCreateRequest

body = UsageQuotasCreateRequest(
data=[
UsageQuotaCreateData(
attributes=UsageQuotaCreateAttributes(
enforced=True,
org_public_id="abcdef12345",
scope=UsageQuotaRequestScope(
user_handle="jane@example.com",
),
usage_limit=100000,
),
type=UsageQuotaType.QUOTA,
),
],
)

configuration = Configuration()
configuration.unstable_operations["create_or_update_quotas"] = True
with ApiClient(configuration) as api_client:
api_instance = UsageMeteringApi(api_client)
response = api_instance.create_or_update_quotas(quota_namespace="ai_credits", body=body)

print(response)
15 changes: 15 additions & 0 deletions examples/v2/usage-metering/DeleteQuota.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Delete a usage quota returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi

configuration = Configuration()
configuration.unstable_operations["delete_quota"] = True
with ApiClient(configuration) as api_client:
api_instance = UsageMeteringApi(api_client)
api_instance.delete_quota(
quota_namespace="ai_credits",
id="MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f",
)
16 changes: 16 additions & 0 deletions examples/v2/usage-metering/ListQuotas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
List usage quotas returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi

configuration = Configuration()
configuration.unstable_operations["list_quotas"] = True
with ApiClient(configuration) as api_client:
api_instance = UsageMeteringApi(api_client)
response = api_instance.list_quotas(
quota_namespace="ai_credits",
)

print(response)
16 changes: 16 additions & 0 deletions examples/v2/usage-metering/ListQuotas_918754421.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
List usage quotas returns "OK" response with pagination
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi

configuration = Configuration()
configuration.unstable_operations["list_quotas"] = True
with ApiClient(configuration) as api_client:
api_instance = UsageMeteringApi(api_client)
items = api_instance.list_quotas_with_pagination(
quota_namespace="ai_credits",
)
for item in items:
print(item)
32 changes: 32 additions & 0 deletions examples/v2/usage-metering/UpdateQuota.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
"""
Update a usage quota returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
from datadog_api_client.v2.model.usage_quota_type import UsageQuotaType
from datadog_api_client.v2.model.usage_quota_update_attributes import UsageQuotaUpdateAttributes
from datadog_api_client.v2.model.usage_quota_update_data import UsageQuotaUpdateData
from datadog_api_client.v2.model.usage_quota_update_request import UsageQuotaUpdateRequest

body = UsageQuotaUpdateRequest(
data=UsageQuotaUpdateData(
attributes=UsageQuotaUpdateAttributes(
enforced=False,
org_public_id="abcdef12345",
usage_limit=120000,
),
id="MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f",
type=UsageQuotaType.QUOTA,
),
)

configuration = Configuration()
configuration.unstable_operations["update_quota"] = True
with ApiClient(configuration) as api_client:
api_instance = UsageMeteringApi(api_client)
response = api_instance.update_quota(
quota_namespace="ai_credits", id="MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f", body=body
)

print(response)
4 changes: 4 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,10 @@ def __init__(
"v2.list_cost_tag_metadata_months": False,
"v2.list_cost_tag_metadata_orchestrators": False,
"v2.search_cost_recommendations": False,
"v2.create_or_update_quotas": False,
"v2.delete_quota": False,
"v2.list_quotas": False,
"v2.update_quota": False,
"v2.create_ownership_feedback": False,
"v2.get_ownership_evidence": False,
"v2.get_ownership_inference": False,
Expand Down
Loading
Loading