Skip to main content

API Documentation Needs Updating

Some parts of the API Documentation could really use a re-write in the examples and the parameters.

My main example is that the Assets API Endpoint lacks so much. This was an email I received to help me with the Asset endpoint: https://pastebin.com/MVJNhVj0 . The current API documenation only shows this:

{

"name": "string",

"assetlayoutid": 0,

"primary_serial": "string",

"primary_mail": "string",

"primary_model": "string",

"primary_manufacturer": "string",

"custom_fields": [

{  "additionalProp1": "string",  "additionalProp2": "string",  "additionalProp3": "string"}

]

}

Additionally, the kickoff endpoint has a "name" parameter, which seems to not do anything. I suspect that one is a bug but it's another example of the API documentation being incorrect.

My wish is that each API endpoint example has the full list of parameters available, and possibly multiple examples if that's not too much trouble.

Log in to comment and vote

No comments yet

Be the first to share your thoughts.