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.

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

Published and subscribed events missing from README #546

Open
Auwate opened this issue Oct 24, 2024 · 1 comment
Open

Published and subscribed events missing from README #546

Auwate opened this issue Oct 24, 2024 · 1 comment
Labels
epic_documentation Documentation improvements good first issue Good for newcomers

Comments

@Auwate
Copy link

Auwate commented Oct 24, 2024

Context

Almost all of the listed events (both published and subscribed) can by found in the utils.py, main.py, or models.py

Published

There are published events that are not mentioned in the README file:

kytos/mef_eline.redeployed_link_down -> Found in the handle_evc_affected_by_link_down function

kytos/mef_eline.error_redeploy_link_down -> Found in the handle_evc_affected_by_link_down function

kytos/mef_eline.cleanup_evcs_old_path -> Found in the handle_link_down function

kytos/mef_eline.evcs_affected_by_link_down -> Found in the handle_link_down function

kytos/flow_manager.flows.install -> Found in the handle_link_down function, which is then sent to the send_flow_mods_event function

kytos/flow_manager.flows.deleted -> Found in the delete_circuit function, which is then sent to the send_flow_mods_event function

kytos/mef_eline.updated -> Found in the update function

kytos/mef_eline.redeployed_link_up -> Found in the handle_link_up function

kytos/mef_eline.undeployed -> Found in the remove function

kytos/mef_eline.deployed -> Found in the deploy function

Subscribed

Here are the subscribed events that are also not mentioned

kytos/mef_eline.evc_affected_by_link_down

kytos/mef_eline.cleanup_evcs_old_path

kytos/mef_eline.redeployed_link_up

kytos/mef_eline.redeployed_link_down

kytos/mef_eline.deployed

.*.switch.interface.link_up

.*.switch.interface.link_down

.*.switch.interface.created

.*.switch.interface.deleted

@viniarck viniarck added good first issue Good for newcomers epic_documentation Documentation improvements labels Oct 28, 2024
@viniarck
Copy link
Member

Good finding @Auwate, indeed most here needs to be included. The only exception are non owning published events as we're discussing in other issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic_documentation Documentation improvements good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants