Question pertaining to the documentation provided with the API.

learn more… | top users | synonyms

0
votes
1answer
81 views

/questions/tagged/{tags} - tags param clarification

This API method has been removed as of Jul 16 '10. The original question is preserved below for posterity. It is not clear what a "list" of {tags} looks like. Does this parameter follow the ...
2
votes
1answer
99 views

Indicate in documentation whether “numbers” can be non-integral

"number" is an very ambiguous term. Integral or non-integral? For developers in more dynamically-typed languages like JavaScript, this is not an issue; but when using more statically-typed languages ...
1
vote
1answer
72 views

Position required parameters at the top of help pages

The required id parameter for ...a lot of API routes... is now placed at the bottom of the page. It makes more sense to place required parameters at the top of the page with a slight separation, like ...
1
vote
1answer
51 views

The user and owner objects appear to be optional in the question timeline result.

This is probably just a simple documentation fix and not really a bug. The doc for the /questions/{id}/timeline method says that the user and owner objects are not optional, but they aren't always ...
2
votes
1answer
50 views

/users/{id} and /users/{id}/timeline - filter parameter?

Both /users/{id} and /users/{id}/timeline say they take a filter parameter for users' names, but it seems to do nothing. Are they not supposed to be there?
3
votes
1answer
81 views

Methods that return comments document body and comments parameters but they do nothing

Methods that return comments document the "body" and "comments" parameters, but they have no effect on the results, which cannot include comments and always include the body. Specific methods: ...
3
votes
2answers
59 views

Inconsistency in the handling of multiple IDs with a duplicate

There appears to be some inconsistency in the way multiple ids are being handled, especially when a duplicate exists. Duplicate ID is significant For example, when requesting a timeline of multiple ...
4
votes
1answer
83 views

Confirmation on sort, order and min/max

I'd like confirmation, if possible, that the following chart of sort types is correct: sort |orderable|min/max |min/max type ------------------------------------------ activity | yes | ...
4
votes
2answers
84 views

Document fields that may be not be included in responses

I'd like to see documentation on what fields may not be included in responses or, alternatively, which fields are guaranteed to be included. Currently it's a little confusing because some fields may ...
0
votes
1answer
44 views

questions/{id}/timeline documentation: timeline_type values not listed

The timeline_type for post timelines just says "string" for the "values". From a cursory look at a few questions, I've seen the following types of events: question answer comment revision votes ...