Can i document an endpoint for a cron job?

asyncapi / spec

The AsyncAPI specification allows you to create machine-readable definitions of your asynchronous APIs.

https://www.asyncapi.com

Apache License 2.0

4.15k stars 265 forks source link

Can i document an endpoint for a cron job? #1056

Open angelaguirrejs opened 4 months ago

angelaguirrejs commented 4 months ago

Hi! I know this is used for event driven, however i'd like to know if it is possible to document an endpoint which is used by a cron job in order to execute a task, keeping in mind the best practices for asyncapi

github-actions[bot] commented 4 months ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

derberg commented 3 months ago

Can you provide a bit more details on the cron job and what it is executing, like a webhook or? I'm trying to understand why would you like to use AsyncAPI for it