Skip to content

Adding create channel api changes to python SDK#709

Draft
mawasthy-lgtm wants to merge 6 commits into
linode:devfrom
mawasthy-lgtm:feat/add-create-alert-channel
Draft

Adding create channel api changes to python SDK#709
mawasthy-lgtm wants to merge 6 commits into
linode:devfrom
mawasthy-lgtm:feat/add-create-alert-channel

Conversation

@mawasthy-lgtm

@mawasthy-lgtm mawasthy-lgtm commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

📝 Description

Updating python sdk to include create channel management api

What does this PR do and why is this change necessary?

Adds full SDK support for Creating a new channel (post request) used by tests and examples.
Ensures create channel fields are parsed and exposed as per the latest API response.

This change is necessary because:

The SDK did not have channel management api added.

✔️ How to Test
Clone the repository
Prepare environment (zsh / macOS)

✔️create & activate venv (recommended)
python3 -m venv .venv
source .venv/bin/activate

install deps
python -m pip install --upgrade pip

Install runtime dependencies:
pip3 install requests polling deprecated

Install dev/test extras
pip3 install -e '.[dev,test]'

test deps
pip3 install pytest mock httpretty pytest-rerunfailures

✔️How do I run the relevant unit tests?
cd <PROJECT_DIRECTORY>/linode_api4-python
Unit tests: python -m pytest test/unit -q

Unit test for all monitor: python3 -m pytest test/unit/objects/monitor_test.py -q -s
python3 -m pytest test/unit/groups/monitor_api_test.py -q -s -v

Single unit: python3 -m pytest test/unit/objects/monitor_test.py::MonitorTest -q -s
python3 -m pytest test/unit/groups/monitor_api_test.py::MonitorAlertDefinitionsTest::test_create_channel -q -s -v

What are the steps to reproduce the issue or verify the changes?
End to end integration testing should suffice

✔️How do I run the relevant integration tests?
Integration tests (E2E):
Note:
#if you have PAT token with write access only to Monitor and read for rest of the services for integration
export SKIP_E2E_FIREWALL=1 # optional: skip firewall autouse fixture
export LINODE_TOKEN="YOUR_REAL_TOKEN" # required for integration
export SKIP_E2E_FIREWALL=1 # optional: skip firewall autouse fixture

python3 -m pytest test/integration/models/monitor/test_monitor.py::test_integration_create_get_delete_alert_channel -q -s

Comment thread linode_api4/groups/monitor.py Outdated
Comment thread linode_api4/groups/monitor.py Outdated
Comment thread linode_api4/groups/monitor.py Outdated
Comment thread linode_api4/objects/monitor.py Outdated
Comment thread linode_api4/objects/monitor.py Outdated
Comment thread test/integration/models/monitor/test_monitor.py Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we have create and delete channel API, we can replace this list API.
For alert definition, attach a newly created channel and later delete it.

The channel object contains all configuration details for the notification
destination (e.g., email lists, webhooks, etc.).

.. note:: This endpoint is in beta and requires using the v4beta base URL.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. note:: This endpoint is in beta and requires using the v4beta base URL.

should be removed. endpoints support both v4beta and v4

:rtype: AlertChannel
:raises ApiError: if the requested channel could not be loaded.
"""
return self.client.load(AlertChannel, channel_id)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This API is not required to be implemented.
In create API we can add below comment.

`If you need to obtain a single :class:`AlertDefinition`, use :meth:`LinodeClient.load`
`example: client.load(AlertChannel, channel_id)`

Refer create alert definitions.

specified alert channel. This allows you to see which alert definitions
are configured to notify this specific channel.

.. note:: This endpoint is in beta and requires using the v4beta base URL.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be removed

result.append(alert)

# Return paginated list with pagination metadata from response
return PaginatedList(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you check this implementation again?
Below code should be enough.

endpoint = f"/monitor/alert-channels/{channel_id}/alerts"
        return self.client._get_and_filter(AlertDefinition, *filters, endpoint=endpoint)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants