Lazy Diary @ Hatena Blog

PowerShell / Java / miscellaneous things about software development, Tips & Gochas. CC BY-SA 4.0/Apache License 2.0

Meanings of :owner, :repo, ... in GitHub API document

In GitHub API document (ex. https://developer.github.com/v3/repos/ ), examples of how to access API showed like GET /repos/:owner/:repo/contributors. Meanings of indicator variable-like valiables such as :owner, :repo are listed below:

# variable meanings
1 :owner username, or name of organization in GitHub Enterprise
2 :repo name of repository
3 :number sequence number of pull request or issue (the sequence is shared by pull requests and issues)
4 :id ID of comment, etc.
5 :sha SHA-1 hash of a commit
6 :ref Path to a reference (heads/BranchA for a branch named BranchA)