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

chore: add /notify api endpoint to openapi.yml #2035

Closed
1 task
mfw78 opened this issue Nov 1, 2023 · 2 comments
Closed
1 task

chore: add /notify api endpoint to openapi.yml #2035

mfw78 opened this issue Nov 1, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mfw78
Copy link
Contributor

mfw78 commented Nov 1, 2023

Background

It's frustrating when there are endpoints of which there is no documentation (noted that the endpoint in question is in development 😁).

Details

All endpoints should be documented in the applicable openapi.yml.

Acceptance criteria

  • /notify endpoint documented in openapi.yml.
@mfw78 mfw78 added the documentation Improvements or additions to documentation label Nov 1, 2023
Copy link

github-actions bot commented Feb 7, 2024

This issue has been marked as stale because it has been inactive a while. Please update this issue or it will be automatically closed.

@github-actions github-actions bot added the stale label Feb 7, 2024
@MartinquaXD
Copy link
Contributor

The /notify endpoint has been documented in the solvers create by now.
It's still not present in the driver openapi spec but that endpoint is only useful for the transition period where we are still running drivers for external solvers. Once solvers run their own drivers they can could get all the data from the logs or the competition endpoint.
Closing this issue for now. If there is enough demand down the line to keep this endpoint alive for some reason we can reopen it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants