Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Append default API endpoint to docs for GHE #27

Merged
merged 1 commit into from
Sep 5, 2017

Conversation

drielsma
Copy link
Contributor

Enterprise instances have a default API endpoint of the hostname with the suffix /api/v3. Add this to the docs for n00bs like me.

@drielsma
Copy link
Contributor Author

This is kinda buried in the GitHub API docs. I think adding this would be helpful.

@tarsius tarsius self-assigned this Aug 23, 2017
@tarsius
Copy link
Member

tarsius commented Aug 23, 2017

Some major changes are coming soon, see #25. I'll keep this in mind when I write the documentation for that.

This is kinda buried in the GitHub API docs.

Could you please point me there?

@vermiculus
Copy link
Contributor

vermiculus commented Aug 24, 2017

Could you please point me there?

See Enterprise – Endpoint URLs.

I don't think ghub should really worry about supporting Management Console stuff, so I think this is fine.

@tarsius
Copy link
Member

tarsius commented Sep 3, 2017

I don't think ghub should really worry about supporting Management Console stuff, so I think this is fine.

But the non- management console stuff is at /api/v3, so I think we should mention that (especially because that is weird and therefore unexpected.)

@vermiculus
Copy link
Contributor

we should mention that

Definitely agree.

Enterprise instances have a default API endpoint of the hostname with
the suffix `/api/v3`. Add this to the docs for n00bs like me.
@tarsius
Copy link
Member

tarsius commented Sep 5, 2017

I have applied your commit after filling the body of the commit message. Thanks!

I am pretty sure you created the commit on Github because not only was the body not properly filled, additionally the message also did not end with a newline. Creating such a commit message is impossible when using the git porcelain (though it is possible when using git plumbing commands and git does not choke on a missing newline). When using Github however it is the default behavior. So I recommend that you don't commit on Github (or remember to always add an explicit newline at the end) and keep hoping that they eventually fix this embarrassing issue (probably a one-line fix would do (which is what makes it embarrassing, things like this can happen, but not fixing it for years?)). /rant

@drielsma
Copy link
Contributor Author

drielsma commented Sep 7, 2017

Point taken. Sorry about that. 😬

@tarsius
Copy link
Member

tarsius commented Sep 7, 2017

Well, it's not your fault 😜

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants