opnsense / docs

OPNsense documentation
Other
115 stars 182 forks source link

Create apicrud.rst #451

Open sde1aney opened 1 year ago

sde1aney commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

a generic example using curl is probably better indeed.