Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
147 questions
2
votes
1
answer
215
views
Documentation describing fields for api stack exchange
When I looked through the StackExchange documentation, I didn't find any documentation describing the fields. I have to study the request and response for a long time in order to understand why this ...
2
votes
0
answers
76
views
Improve design of the Documentation's 404 page
The 404 page of the documentation has a rather awkward design; for example, a different header than other pages, and no footer. Can it be updated?
- 6,965
2
votes
1
answer
121
views
Clarify read-only vs. write operations for Teams in documentation
The API page about Stack Overflow for Teams says (emphasis mine):
Starting with the release of Stack Overflow For Teams, the Stack Exchange API exposes read-only access to data stored in private ...
- 6,965
2
votes
1
answer
88
views
Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, incl. differences between them?
Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, including differences between them?
Basically, I'm looking for onboarding documentation ...
2
votes
0
answers
98
views
Update Teams API documentation to reflect dependency on tier
The documentation says (emphasis mine):
Starting with the release of Stack Overflow For Teams, the Stack Exchange API exposes read-only access to data stored in private Teams.
This is slightly ...
- 6,965
3
votes
0
answers
63
views
Browsing method documentation consumes 4 quota units per page
Is it my imagination (scratch that, it's definitely not), or does simply browsing method doc pages (without using the "Run" function) consume quota?
From Bash using httpie and jq (on a ...
- 249
20
votes
3
answers
209
views
Documentation or API method for `option_id` information, for the `/flags/options` API calls?
The Stack Exchange API has a couple of calls that return a list of flag_option objects.
These objects contain a couple of properties that can be used to identify the flag you need.
For example, when ...
- 331
3
votes
1
answer
4k
views
HTTP 400 "Bad Request" while using "access_token" in request Url
I registered an app, obtained a key and I have implemented the implicit OAuth 2.0 flow in a Windows 8 desktop app (as per the documentation available here). After receiving and storing the access ...
- 173
2
votes
1
answer
115
views
What happened to the links to a Stack App mentioned in the documentation about write access?
The documentation about write access states:
The application responsible for creating content via the API may be indicated with a link to an app's Stack Apps post. The exact manner of display is ...
- 6,965
2
votes
1
answer
122
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.
- 373
6
votes
1
answer
383
views
Where is the usage documentation?
I know this is probably a dumb question, but there's a bunch of documentation and I don't know what to do with this stuff. How do you use the API?
- 163
2
votes
0
answers
72
views
List /network-activity methods under Network Methods in the documentation
The API methods /users/{id}/network-activity and /me/network-activity, both return a summary of a user's activity across the Stack Exchange network and do not take a site parameter.
They are ...
- 6,965
1
vote
0
answers
79
views
The authentication doc gives a wrong domain for authentication
The authentication doc page now lists URL's like:
https://stackoverflow.com/oauth
https://stackoverflow.com/oauth/access_token
etc.
While these seem to work, the correct domain is stackexchange.com, ...
- 13k
3
votes
1
answer
211
views
Difference between `/inbox/unread` & `/me/inbox/unread`
I ran /inbox/unread & /me/inbox/unread.
What is the difference between the two? Also, the site parameter which we give in call to /me/inbox/unread is not required as inbox_item refers to global ...
- 834
2
votes
1
answer
197
views
How do I find all questions/answers per a tag?
Would also be good if I could also find the top questions/answers in a particular tag - i.e. questions tagged with Ruby or PHP.
Per the docs the only thing I can see that will return questions in a ...
- 143
3
votes
2
answers
364
views
What am I allowed/not permitted to do with the API?
I have a site that will offer technical help and assistance for a certain niche of computer users. I can either host my own forums, or tie in with stack... but I want to be able to make money off it ...
- 303
2
votes
0
answers
67
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:
- 256
12
votes
1
answer
415
views
How the /sites method is meant to be used
The /sites method is used to enumerate all sites in the network. If your [app] is meant to run against more than a single site (and many are) this method is how you should be discovering new sites in ...
5
votes
1
answer
154
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
3
votes
1
answer
138
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
9
votes
1
answer
1k
views
How to see which users upvoted a question?
I assume this information is tracked, since StackOverflow shows me the questions I have upvoted (when going to their question page, I can undo the upvote). I couldn't find any api call that gives this ...
- 1,079
5
votes
1
answer
161
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
136
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
2
votes
1
answer
95
views
Notice field on questions may be absent?
The notice type, that is a field of a question, appears to be optional, yet it is not marked as "may be absent"?
For example, when I request questions with a filter that has the notice field checked, ...
- 121
4
votes
0
answers
81
views
Authorization dialog shows wrong API version
If you go on this doc page and click on Get Token, you'll see this:
Minor bug, but still, I thought it would be nice to fix this inconsistency :)
- 265