tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-04-08 17:05:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve REST API docs

Browse Source 
- Better explanation for filters and filter_vars
- Update examples to use filters in the body only, don't fuck around with the URL parameters.
- Better explain actions and their intent
- More insights into config packages and their intention
- Improve API clients and add the tables from icinga2-api-examples
- Formatting for CLI requests
This commit is contained in:
Michael Friedrich 2019-04-12 12:49:41 +02:00
parent 5e3df67ab3
commit 31170db123
3 changed files with 397 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/11-cli-commands.md
View File

@ -22,7 +22,7 @@ Supported commands:
* api setup (setup for API) * api setup (setup for API)
* ca list (lists all certificate signing requests) * ca list (lists all certificate signing requests)
* ca sign (signs an outstanding certificate request) * ca sign (signs an outstanding certificate request)
* console (Icinga console) * console (Icinga debug console)
* daemon (starts Icinga 2) * daemon (starts Icinga 2)
* feature disable (disables specified feature) * feature disable (disables specified feature)
* feature enable (enables specified feature) * feature enable (enables specified feature)
@ -272,7 +272,7 @@ are required for executing config expressions and auto-completion.
> **Note** > **Note**
> >
> The debug console does not currently support SSL certificate verification. > The debug console does not currently support TLS certificate verification.
> >
> Runtime modifications are not validated and might cause the Icinga 2 > Runtime modifications are not validated and might cause the Icinga 2
> daemon to crash or behave in an unexpected way. Use these runtime changes > daemon to crash or behave in an unexpected way. Use these runtime changes

511
doc/12-icinga2-api.md
View File

File diff suppressed because it is too large Load Diff

2
doc/19-technical-concepts.md
View File

@ -1680,7 +1680,7 @@ Message updates are dropped when
* The origin sender is not in a parent zone of the receiver. * The origin sender is not in a parent zone of the receiver.
* The certificate fingerprint is in an invalid format. * The certificate fingerprint is in an invalid format.
#### log::SetLogPosition <a id="technical-concepts-json-rpc-messages-pki-updatecertificate"></a> #### log::SetLogPosition <a id="technical-concepts-json-rpc-messages-log-setlogposition"></a>
> Location: `apilistener.cpp` and `jsonrpcconnection.cpp` > Location: `apilistener.cpp` and `jsonrpcconnection.cpp`