All Questions
Tagged with documentation status-completed
52 questions
9
votes
1
answer
141
views
Typos in API documentation
From the /posts documentation:
Most applications should use the question or answer specific methods, but /posts is available for those rare cases where any activity is of intereset.
intereset => ...
- 6,885
6
votes
1
answer
1k
views
Please "release" and/or document API version 2.3
I was playing around a bit with Fiddler to capture traffic from the Stack Exchange iOS app. To my surprise, it uses version 2.3 of the Stack Exchange API:
I noticed here that it has some extra ...
- 6,885
5
votes
1
answer
125
views
API docs titled "v2.0"; should be "v2.1"
The documentation is titled "StackExchange API v2.0"... this should be updated to "v2.1" as it's not readily obvious that version 2.1 has been published otherwise.
https://api.stackexchange.com/docs
- 373
5
votes
1
answer
78
views
API documentation pages match some site names incorrectly
The bug is not in the API itself, but in the pages documenting its methods. To reproduce, follow the link http://api.stackexchange.com/docs/info#filter=default&site=math and observe that the page ...
5
votes
2
answers
161
views
API Help's CSS is missing
The API Help page's CSS file, located at http://sstatic.net/so/all.css, is current returning 404 for me:
<div id="header"><h1>Server Error</h1></div>
<div id="content">
...
- 819
5
votes
1
answer
180
views
Few typos in the documentation pages
https://api.stackexchange.com/docs/vectors
When passing a vector, sepeate each id with a semicolon. For example, /users/1;2;3;4;5?site=somesite would fetch users with ids 1 through 5 on somesite.
...
- 578
5
votes
1
answer
130
views
Typos on api.stackexchange.com/docs/js-lib
Under the Authentication section on https://api.stackexchange.com/docs/js-lib, there are a few typos (emphasis mine):
scope (optional) – an array of scopes to request during authentication, valid ...
- 4,385
5
votes
1
answer
37
views
Typo in API filter documentation
When using unsafe filters, the API returns the highest fidelity data is can reasonably access for the given request.
should be
When using unsafe filters, the API returns the highest fidelity data ...
- 882
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
5
votes
0
answers
124
views
"What is meta" should be rephrased
Stackapps.com/help/whats-meta tells that there is "Meta Stack Apps". However there isn't.
Stack Apps is its own meta and meta is used to ask meta questions here.
- 426
4
votes
1
answer
52
views
Typo in the docs for /me
The doc says:
Returns the user associated with the passed auth_token.
This method returns a user.
It should say "access_token" instead of "auth_token".
- 358
4
votes
1
answer
82
views
"Try it" facility suffers a double-encoding bug
As you can clearly see from the above, the ampersand in the site name in the "Try It" section of the API method documentation has been double-encoded. This affects any site with an ampersand in the ...
4
votes
2
answers
95
views
Documentation sorted by return type
Right now the documentation is pretty terribly organized. For example, consider the things under the "Users" heading:
/users => returns Users
/users/{ids} => returns Users
/users/{ids}/answers => ...
- 5,264
4
votes
2
answers
108
views
Possible bug in the help page?
There are some weird dot things in this help page:
api.stackoverflow.com/0.8/help/method?method=users/{id}/badges
{Dead link to missing image: http://files.quickmediasolutions.com/stackbug.png}
...
- 23.3k
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
4
votes
1
answer
52
views
Stylistic error on the JavaScript SDK documentation page
There is a small stylistic error on the JavaScript SDK documentation page.
Your application must have the client side OAuth flow enabled, and must not have disabled the desktop application redirect ...
- 147
3
votes
1
answer
93
views
Why is "body" missing from certain inbox items?
I have run into some confusion over the presence of the body attribute in an inbox-item returned by the /inbox method.
When item_type is set to "careers_invitations", the body attribute appears to be ...
- 23.3k
3
votes
1
answer
59
views
Events: field request
The "Event" object doesn't have an easy way for getting at the object relating to the event. There's a link field, but I don't fancy having to parse the information out of that (although I could).
...
- 5,264
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
3
votes
1
answer
120
views
top-answerers / top-askers documentation bug: number of results returned incorrect
The top-answerers-on-tags and top-askers-on-tags documentation claim:
Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days.
and
Returns the top 30 askers ...
- 931
3
votes
1
answer
228
views
API documentation console unsuccessfully tries to load MiniProfiler results
All of the documentation pages (example) with the test console currently attempt to load MiniProfiler result data, which fails with a 404:
POST https://api.stackexchange.com/mini-profiler-resources/...
- 4,676
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
1
answer
57
views
Documentation has broken link (JSONP)
On Wikipedia, JSONP now has its own article, instead of being part of the JSON article.
The documentation links JSONP to Wikpedia:JSON#JSONP. It should link to Wikipedia:JSONP.
- 133
3
votes
1
answer
83
views
What happened to the /stats method?
I can't find the /stats method in the new usage documentation.
A quick run of http://api.stackoverflow.com/1.1/stats reveals that the method is still there. However, it is not documented.
- 23.3k
3
votes
0
answers
81
views
SE API V1.1 documentation, date errata
The Stack Exchange API, version 1.1, documentation is ever so slightly confusing wherever Unix timestamps are mentioned (perhaps any ranges, I haven't dug too deeply)
For instance:
todate – Unix ...
- 131
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 ...
2
votes
3
answers
76
views
What is the "inname" parameter to the /tags 2.0 API?
I'm just playing with the new 2.0 API and in /tags there is a field inname that I can't find any description or documentation for.
What does it do? Is it like the old filter parameter on the old API?
...
- 882
2
votes
1
answer
53
views
Minor spello/typo on the "Complex Queries" documentation page
The documentation page
Complex Queries
has a minor typo or spello:
The ?filter=total build-in filter is provided for just this purpose.
Should instead be:
The ?filter=total built-in filter ...
- 882
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
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
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
2
votes
1
answer
102
views
"Javascript" typo on documentation pages
On page Usage of /sites, it should be JavaScript, not Javascript, in the right sidebar:
This obviously also applies to (most/all) API documentation pages, since they share the sidebar.
- 375
2
votes
1
answer
66
views
No token field in the docs test page for /me/reputation-history
There is no form field for an access token at:
https://api.stackexchange.com/docs/me-reputation-history
https://api.stackexchange.com/docs/me-full-reputation-history
After attempting to Run the API ...
- 123
2
votes
1
answer
61
views
Mistake in API 2.0 Documentation - Wrong item type for Careers Message
On https://api.stackexchange.com/docs/types/inbox-item the Careers Message example shows the wrong item type.
- 809
2
votes
1
answer
27
views
Dead link in documentation
On the docs for question timelines the link for "Question" points to /docs/type/question when it should point to /docs/types/question
2
votes
1
answer
24
views
type related_site not listed in 'by type' tab list
The type "related_site" is not listed in the 'by type' tab in documentation.
- 12.1k
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
2
votes
0
answers
48
views
Spelling mistake in API Documentation's "Authentication" page
Can you find the spelling mistake in "Unregistered Users" (last section) of the Authentication page?
In case you're not in the mood for games, here is it:
This is actually a correct spelling - of ...
- 256
2
votes
1
answer
47
views
There is a small discrepancy in the docs for users-id-associated
The main doc page, https://api.stackexchange.com/docs, shows /users/{id}/associated while the method page, https://api.stackexchange.com/docs/associated-users, uses /users/{ids}/associated.
It's ...
- 12.1k
2
votes
1
answer
39
views
integer and decimal are used to describe fields in return types but not in method parameters
Integer and Decimal designations are useful in creating an accurate model of API methods and types.
These specific 'number' subtypes are used when describing types but the method parameter lists all ...
- 12.1k
2
votes
1
answer
89
views
Include range [1, 100] on pagesize
I see that "range" is being used to indicate valid range on most numeric parameters, e.g.
32-bit integer, range [0, 2,147,483,647]
32-bit integer, range [1, 2,147,483,647]
The smaller valid range ...
- 12.1k
1
vote
2
answers
62
views
Meta Stack Overflow API Try-It form sends request to Stack Overflow API instead of Meta API
Meta Stack Overflow API Try-It form sends request to Stack Overflow API instead of Meta API
- 5,022
1
vote
1
answer
64
views
CDN redirect for the API's JavaScript SDK is incorrect
The API's JavaScript SDK is listed as https://api.stackexchange.com/js/2.0/all.js.
However, GET request produces the following response:
Status Code: 301 Moved Permanently
Location: https://api-...
- 175
1
vote
1
answer
38
views
Minor typo in /tags/{tag}/top-askers/{period}
The discussion for the above method says "Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days." It should be corrected as askers.
- 111
1
vote
1
answer
36
views
Documentation of /users/{id}/top-answer-tags conflicts with implementation.
According to the documentation:
/users/{id}/top-answer-tags or /me/top-answer-tags – Get the top 30 tags (by score) a single user has posted answers in.
However in practice, when retrieving data ...
- 23.3k
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
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
1
vote
1
answer
47
views
There is a typo in the authentication documentation
There is a typo on this documentation page.
It says "The explcit OAuth 2.0 flow" but it should say "The explicit OAuth 2.0 flow".
user451
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
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