All Questions
221 questions
0
votes
1
answer
98
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 ...
- 12.1k
2
votes
1
answer
117
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 ...
- 12.1k
1
vote
1
answer
80
views
`type=jsontext` JSON results for help pages
It would greatly simplify machine reading if we could apply type=jsontext to API help pages, including the index.
Update: Here's an unofficial JSON schema for v1.x.
- 12.1k
1
vote
1
answer
83
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 ...
- 12.1k
1
vote
1
answer
78
views
Please supply working example URLs for each route
It would take a lot of the guess work out of understanding the API if each route's page provided a small handful of working URLs.
This would also serve to provide authoritative examples of the ...
- 12.1k
1
vote
1
answer
40
views
help page issue: revisions by revisionguid example needed
/revisions/{id}/{revisionguid} - usage of this route is not clear to me.
can someone provide a working url and perhaps a simple use case.
- 12.1k
1
vote
1
answer
44
views
help page format issue: missing parameter
/users/{id}/tags is missing id parameter
fixing this will remove one more special case from my parser.
- 12.1k
1
vote
1
answer
57
views
help page format issue: revisionGuid
http://api.stackoverflow.com/0.8/help/method?method=revisions/{id}/{revisionguid}
revisionGuid is inconsistent.
revisionguid seems appropriate (and will remove one special case from my api parser).
- 12.1k
3
votes
1
answer
72
views
Minor typo on help page
On the API Routes help page, this:
/users/{id}/favorites Gets summary information for the questions that have been favorited a set of users.
should probably be:
/users/{id}/favorites Gets ...
1
vote
1
answer
77
views
Can we have all possible closed reasons in help page?
Can we have all possible closed_reasons in help page and if possible, closed_reason_id, too?
For example
closed_reason_id=1, closed_reason="exact duplicate",
closed_reason_id=2, closed_reason="off-...
- 5,022
1
vote
1
answer
62
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 ...
- 3,315
2
votes
2
answers
927
views
Can we have maximum length of string in API help pages?
For the type "string", I think there is some upper limit of character count.
For example,
post title : 200 characters
post body : 30000 characters
In the help page, currently like this
"body": {
...
- 5,022
2
votes
1
answer
57
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?
- 369
3
votes
1
answer
98
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:
/...
- 369
3
votes
2
answers
82
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 ...
- 133
4
votes
1
answer
118
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 | ...
- 369
4
votes
2
answers
95
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 ...
- 369
0
votes
1
answer
62
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
The ...
- 369
2
votes
1
answer
70
views
questions/{id} help page sort parameter description is inconsistence with others
The description of the Sort parameter in questions/{id} help page is inconsistent with those of other pages.
On the questions/{id} help page:
sort (optional):
How a collection
should be ...
- 5,022
5
votes
1
answer
142
views
Two minor typos in the API help
In http://api.stackoverflow.com/0.8/help
/users/{id}/answers Gets answer summary informatino for the user with 'id'.
and in the Returns section of http://api.stackoverflow.com/0.8/help/method?method=...
- 185
109
votes
3
answers
23k
views
API Documentation and Help
Method List
All API methods can be found at https://api.stackexchange.com/docs.
Global Method Parameters
All methods accept the following parameters:
type=jsontext: responds with mime-type text/json.
...