Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

30 questions with no upvoted or accepted answers
Filter by
Sorted by
Tagged with
10 votes
0 answers
275 views

Tell us that POST is required to write

While troubleshooting /posts/{id}/comments/add in order to answer Why am I getting a 404 when trying to post a comment?, it was noticed that the API path in question only responded to POST requests. ...
michaelb958--GoFundMonica's user avatar
8 votes
0 answers
158 views

Incomplete information in API documentation

I am struggling a little bit with the Stack Exchange API since there seems to be no formal specification for the individual endpoints of the API. Example: Endpoint: https://api.stackexchange.com/2.2/...
Besi's user avatar
  • 533
6 votes
0 answers
70 views

Docs say the API returns a user's age, but it doesn't (anymore)

The doc page says that the user object returns an age property (for those users that specified an age). But the API  no  longer  does.   (Plus spot checks of users that had age in ...
Brock Adams's user avatar
  • 12.9k
6 votes
0 answers
56 views

API docs for "stack overflow" still feature v1.0 docs

I guess I'd call this a doc bug. Currently the page http://api.stackoverflow.com redirects to http://api.stackoverflow.com/1.0/usage, which says at the top "Don't use 1.0, use 2.1". This URL ...
Leopd's user avatar
  • 161
5 votes
0 answers
120 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.
nicael's user avatar
  • 406
4 votes
0 answers
37 views

Link to applied_count leads to a 404

To Reproduce Run an API query on tag-synonyms, you will get a result that includes something like this: Issue(s) Click on the applied_count link and you get redirected to this page which is a 404. It ...
jmac's user avatar
  • 141
4 votes
0 answers
118 views

Parameter `tagged` in `search/advanced` seems to use `AND` instead of `OR`

It seems that search/advanced has the same problem as in "The tagged parameter does not work with multiple tags" question. When I select c#; .net I only get results tagged both c# and .net: http://...
Andrey Shchekin's user avatar
3 votes
0 answers
37 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 ...
NotTheDr01ds's user avatar
3 votes
0 answers
37 views

"users" link lands on the answer page

On the /users/moderators documentation site, the following link is wrong: This method returns a list of users. The users link mistakenly points to the answers object instead of to the users object....
Rakete1111's user avatar
3 votes
0 answers
53 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 :)
Rakete1111's user avatar
3 votes
0 answers
43 views

Types missing from the "Member Types" section

The following types are not listed on http://api.stackexchange.com/docs?tab=category#docs under the Member Types section: network_post closed_details original_question Note that it's a nonexhaustive ...
Stijn's user avatar
  • 263
3 votes
0 answers
44 views

'answer' type has "unchanged in unsafe filters" listed for the wrong field

http://api.stackexchange.com/docs/types/answer says the can_flag field is unchanged in unsafe filters. It's probably meant for the field above it: body_markdown.
Stijn's user avatar
  • 263
3 votes
0 answers
49 views

Incorrect link parameter on the "Complex Queries" documentation page

The "Complex Queries" documentation page has this link: Of these three posts on Server Fault, the one with the most recent activity where "the one with the most recent activity" links to https://...
ForkandBeard's user avatar
3 votes
0 answers
78 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 ...
Dan Lugg's user avatar
  • 131
3 votes
0 answers
48 views

Always show console on API docs

This script stops you having to click the "show console" button to test an API call. Install - View Source
Gelatin's user avatar
  • 796
3 votes
0 answers
51 views

API Help Suggestion: /search - can we make tagged,nottagged description consistent with other list params

on most other params that accept a semi-colon delimited list we see list of tags questions must have, semicolon delimited A single primary key identifier or a vectorized, semicolon-delimited list of ...
Sky Sanders's user avatar
  • 12.1k
2 votes
0 answers
44 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?
Glorfindel's user avatar
  • 6,762
2 votes
0 answers
78 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 ...
Joe Moore's user avatar
  • 171
2 votes
0 answers
76 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 ...
Glorfindel's user avatar
  • 6,762
2 votes
0 answers
50 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 ...
Glorfindel's user avatar
  • 6,762
2 votes
0 answers
33 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): ...
Glorfindel's user avatar
  • 6,762
2 votes
0 answers
47 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 ...
ashleedawg's user avatar
2 votes
0 answers
22 views

'search_excerpt' type issues

On the search_excerpt page: community_owned_date should be marked as may be absent locked_date should be marked as may be absent search/excerpts should be listed in the Methods That Return This Type ...
Stijn's user avatar
  • 263
2 votes
0 answers
30 views

New line missing between 'notice' and 'related_site' member types

At the bottom of http://api.stackexchange.com/docs?tab=type#docs under the Member Types section, notice and related_site are on the same line. A <br> is missing between the items.
Stijn's user avatar
  • 263
2 votes
0 answers
61 views

Version used by StackExchange API if version is not specified in api calls

I have used some StackExchange API calls in my chrome extension - StackEye. With the release of API 2.0, I want to update the api calls so I wanted to know New things available in 2.0+ which were ...
Sachin Jain's user avatar
2 votes
0 answers
64 views

Clarification on related tags for a tag returned by API

I was assuming that the related tags API call, returns all the tags that co-occur with the input tag. But a closer look at the API documentation indicate the following: Returns the tags that are ...
appanponn's user avatar
  • 121
1 vote
0 answers
88 views

PLACEHOLDER - A post to register my app posting

PLACEHOLDER - Just a post to register my app.
Peter Pan's user avatar
1 vote
0 answers
34 views

Typo in API docs /numbers)

https://api.stackexchange.com/docs/numbers The motivation for this is to prevent any unpleasant floating point confusion, especially across technologies that offering different floating point ...
Lakshya Raj's user avatar
1 vote
0 answers
66 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, ...
Brock Adams's user avatar
  • 12.9k
1 vote
0 answers
64 views

Get Token button in "Try it" doesn't give me a key in IE11

When I visit for example the timeline docs to try that api I need to get a token first by clicking 'Get Token'. In IE11 (win 7/x64) this is broken. A window does pop-up but there is never a key ...
rene's user avatar
  • 2,482