Skip to content

add v2 flag suggestion endpoints to feature flags spec #3428

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 v2 flag suggestion endpoints to feature flags spec #3428

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
534 changes: 534 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 @@ -6563,6 +6563,27 @@ datadog\_api\_client.v2.model.create\_feature\_flag\_request module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_flag\_suggestion\_attributes module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_flag\_suggestion\_data module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_flag\_suggestion\_request module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_incident\_notification\_rule\_request module
----------------------------------------------------------------------------------

Expand Down Expand Up @@ -11295,6 +11316,62 @@ datadog\_api\_client.v2.model.findings module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.flag\_suggestion module
-----------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_action module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_attributes module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_data\_type module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_event\_data\_type module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_property module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_response module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.flag\_suggestion\_status module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.flaky\_test module
------------------------------------------------

Expand Down Expand Up @@ -25449,6 +25526,27 @@ datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request\_data\_att
:members:
:show-inheritance:

datadog\_api\_client.v2.model.review\_flag\_suggestion\_attributes module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.review\_flag\_suggestion\_data module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.review\_flag\_suggestion\_request module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.role module
-----------------------------------------

Expand Down Expand Up @@ -31462,6 +31560,13 @@ datadog\_api\_client.v2.model.step\_display\_bounds module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.suggestion\_metadata module
---------------------------------------------------------

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

datadog\_api\_client.v2.model.suite\_create\_edit module
--------------------------------------------------------

Expand Down
29 changes: 29 additions & 0 deletions examples/v2/feature-flags/ApproveFlagSuggestion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
"""
Approve a flag suggestion returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
from datadog_api_client.v2.model.flag_suggestion_event_data_type import FlagSuggestionEventDataType
from datadog_api_client.v2.model.review_flag_suggestion_attributes import ReviewFlagSuggestionAttributes
from datadog_api_client.v2.model.review_flag_suggestion_data import ReviewFlagSuggestionData
from datadog_api_client.v2.model.review_flag_suggestion_request import ReviewFlagSuggestionRequest
from uuid import UUID

body = ReviewFlagSuggestionRequest(
data=ReviewFlagSuggestionData(
attributes=ReviewFlagSuggestionAttributes(
comment="Looks good, approved!",
),
type=FlagSuggestionEventDataType.FLAG_SUGGESTION_EVENTS,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = FeatureFlagsApi(api_client)
response = api_instance.approve_flag_suggestion(
suggestion_id=UUID("550e8400-e29b-41d4-a716-446655440020"), body=body
)

print(response)
42 changes: 42 additions & 0 deletions examples/v2/feature-flags/CreateFlagSuggestion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
"""
Create a flag suggestion returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
from datadog_api_client.v2.model.create_flag_suggestion_attributes import CreateFlagSuggestionAttributes
from datadog_api_client.v2.model.create_flag_suggestion_data import CreateFlagSuggestionData
from datadog_api_client.v2.model.create_flag_suggestion_request import CreateFlagSuggestionRequest
from datadog_api_client.v2.model.flag_suggestion_action import FlagSuggestionAction
from datadog_api_client.v2.model.flag_suggestion_data_type import FlagSuggestionDataType
from datadog_api_client.v2.model.flag_suggestion_property import FlagSuggestionProperty
from datadog_api_client.v2.model.suggestion_metadata import SuggestionMetadata
from uuid import UUID

body = CreateFlagSuggestionRequest(
data=CreateFlagSuggestionData(
attributes=CreateFlagSuggestionAttributes(
action=FlagSuggestionAction.ARCHIVED,
comment="Archive this deprecated flag",
environment_id=UUID("550e8400-e29b-41d4-a716-446655440001"),
notification_rule_targets=[
"user@example.com",
],
_property=FlagSuggestionProperty.FLAG,
suggestion="ENABLED",
suggestion_metadata=SuggestionMetadata(
variant_id="550e8400-e29b-41d4-a716-446655440005",
),
),
type=FlagSuggestionDataType.FLAG_SUGGESTIONS,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = FeatureFlagsApi(api_client)
response = api_instance.create_flag_suggestion(
feature_flag_id=UUID("550e8400-e29b-41d4-a716-446655440000"), body=body
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/feature-flags/DeleteFlagSuggestion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Delete a flag suggestion returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
from uuid import UUID

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = FeatureFlagsApi(api_client)
api_instance.delete_flag_suggestion(
suggestion_id=UUID("550e8400-e29b-41d4-a716-446655440020"),
)
16 changes: 16 additions & 0 deletions examples/v2/feature-flags/GetFlagSuggestion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get a flag suggestion returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
from uuid import UUID

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = FeatureFlagsApi(api_client)
response = api_instance.get_flag_suggestion(
suggestion_id=UUID("550e8400-e29b-41d4-a716-446655440020"),
)

print(response)
29 changes: 29 additions & 0 deletions examples/v2/feature-flags/RejectFlagSuggestion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
"""
Reject a flag suggestion returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
from datadog_api_client.v2.model.flag_suggestion_event_data_type import FlagSuggestionEventDataType
from datadog_api_client.v2.model.review_flag_suggestion_attributes import ReviewFlagSuggestionAttributes
from datadog_api_client.v2.model.review_flag_suggestion_data import ReviewFlagSuggestionData
from datadog_api_client.v2.model.review_flag_suggestion_request import ReviewFlagSuggestionRequest
from uuid import UUID

body = ReviewFlagSuggestionRequest(
data=ReviewFlagSuggestionData(
attributes=ReviewFlagSuggestionAttributes(
comment="Looks good, approved!",
),
type=FlagSuggestionEventDataType.FLAG_SUGGESTION_EVENTS,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = FeatureFlagsApi(api_client)
response = api_instance.reject_flag_suggestion(
suggestion_id=UUID("550e8400-e29b-41d4-a716-446655440020"), body=body
)

print(response)
Loading
Loading