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

Create apicrud.rst #451

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create apicrud.rst #451

wants to merge 1 commit into from

Conversation

sde1aney
Copy link

@sde1aney sde1aney commented Feb 2, 2023

basic information around using POST operations for create, read, update, delete operations with the API. worked examples using the Trafficshaper API endpoint, curl syntax.

basic information around using POST operations for create, read, update, delete operations with the API.
worked examples using the Trafficshaper API endpoint, curl syntax.
@AdSchellevis
Copy link
Member

I don't mind extending the examples, but it should fit somewhere in the documentation. The most logic option is likely to add some common scenario's here https://docs.opnsense.org/development/how-tos/api.html

@sde1aney
Copy link
Author

sde1aney commented Feb 2, 2023

I'm happy for it to go wherever, I did put it as another how-to doc to avoid cluttering the existing API how-to page.
I had also considered putting a very small example on the trafficshaper page here https://docs.opnsense.org/development/api/core/trafficshaper.html, but decided it would then ideally require the equivalent examples on other pages.

@AdSchellevis
Copy link
Member

a generic example using curl is probably better indeed.

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

Successfully merging this pull request may close these issues.

2 participants