This repository has been archived by the owner. It is now read-only.

Grammar, JSON, and status code corrections #90

Closed
wants to merge 5 commits into
from

Conversation

Projects
None yet
2 participants
Contributor

sigmavirus24 commented May 27, 2012

s/this/these on a couple lines in content/v3/orgs/teams.md

Also added a correction to the ORG json. The original url link was incorrect.

And finally, for editing a team, the status code that is actually returned is 200, not 201.

sigmavirus24 added some commits May 27, 2012

Correct ORG url.
$ curl "https://api.github.com/orgs/github"
{
  "public_gists": 0,
  "type": "Organization",
  "public_repos": 55,
  "url": "https://api.github.com/orgs/github",
  "blog": "https://github.com/about",
  "avatar_url": "https://secure.gravatar.com/avatar/...",
  "company": null,
  "login": "github",
  "email": "support@github.com",
  "followers": 674,
  "name": "GitHub",
  "created_at": "2008-05-11T04:37:31Z",
  "location": "San Francisco, CA",
  "id": 9919,
  "following": 0,
  "html_url": "https://github.com/github"
}

Note that url is not https://api.github.com/orgs/1 (or any numeral for that
matter). This holds the pattern of https://api.github.com/users/github

(I shortened the avatar_url link since it wasn't relevant.)
Wrong status code documented.
API actually returns status code 200.
Change commits based on my experience.
So far, just from looking at commits on Pull Requests, it seems as if the
'author' and 'committer' fields are returning USER like data structures instead
of the structure that was there previously.
Add Response section to "Create a Reference".
I'm not entirely sure yet that this is the response that is sent, but I'm
guessing that it is. I would have expected this to be documented, but I hope
this will get the attention of someone who can fix it if it isn't correct.
Contributor

sigmavirus24 commented May 30, 2012

820c3bd was wrong. I hadn't read the surrounding documentation well enough.

Member

technoweenie commented May 30, 2012

Yup, thanks! I'll just merge those commits manually and skip 820c3bd.

Contributor

sigmavirus24 commented May 30, 2012

No problem.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.