Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
147 questions
2
votes
1
answer
231
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
80
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,975
2
votes
0
answers
135
views
Uncaught channelUrl must be under the current domain
I'm developing a Stack Chrome extension that will make use of the API. I'm following the instructions on the API docs here.
My OAuth and host websites are set to stackexchange.com in my Stack Apps ...
- 171
2
votes
1
answer
134
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,975
2
votes
1
answer
102
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 ...
3
votes
0
answers
72
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
2
votes
0
answers
106
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,975
3
votes
1
answer
278
views
Unable to post a comment using the interactive API documentation
I'm trying to to integrate the Stack Exchange API in my application. I'm trying the authentication but when I got the token and used it it gave a write_access issue. That issue was resolved when I ...
- 133
1
vote
1
answer
116
views
Wrong sorting parameter in documentation for question/{ids}/answers
It looks like that in the question/{ids}/answers documentation, there is a mistake:
votes – score
Shouldn't this be
votes – votes
- 111
2
votes
1
answer
136
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,975
2
votes
0
answers
80
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,975
1
vote
0
answers
85
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
2
votes
1
answer
134
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
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,975
2
votes
0
answers
57
views
.wrapper not sorted correctly in filter edit popup
When editing the filter, e.g. on this API documentation page, all types are sorted alphabetically except for .wrapper which is always shown below answer, instead of above it (or at the end):
Obviously,...
- 6,975