Annotating Parameters

We don’t want to replace API documentation but we’re wrapping up a feature that allows required and optional request parameters to be annotated with notes. Each annotation is editable wiki-style by anyone and may also be Markdown formatted.

The Instagram API is shown in this example, which requires the numeric ID of users to be specified in order to make a user-specific request. That sucks! But a quick jump over to the user search endpoint and back is now possible thanks to some helpful developer before us.

Posted on Jan 17, 2014

More by Eric Lanehart

View profile