API Documentation does not seem to be correct

(Ryan K) #1

According to the API documentation I should be able to access api/components/show

Screen shot shows what version I have installed and I have “Show Deprecated API” checked.

“Show Deprecated API” is not checked.

So why when I try to call this and many other API… I get an erorr telling me that componentid or components is mandatory? When documentation states it is not required

(G Ann Campbell) #2


Thanks for taking the time to report this.

What you’ve encountered is a problem we have when indicating that one of a set is required. You’ve nailed the problem by showing the deprecated API. The service requires either component or componentId, but not both. When we finally remove the deprecated parameters, we’ll update the docs to remove the ‘optional’ marking from component.