- $ curl foobar - .... -+The generated files will end up in *json-dump/*. -This isn't a `curl` tutorial though, I'm not sure every API call needs -to show how to access it with `curl`. - -## Development - -Nanoc compiles the site into static files living in `./output`. It's -smart enough not to try to compile unchanged files: +### Terminal blocks - $ nanoc compile - Loading site data... - Compiling site... - identical [0.00s] output/css/960.css - identical [0.00s] output/css/pygments.css - identical [0.00s] output/css/reset.css - identical [0.00s] output/css/styles.css - identical [0.00s] output/css/uv_active4d.css - update [0.28s] output/index.html - update [1.31s] output/v3/gists/comments/index.html - update [1.92s] output/v3/gists/index.html - update [0.25s] output/v3/issues/comments/index.html - update [0.99s] output/v3/issues/labels/index.html - update [0.49s] output/v3/issues/milestones/index.html - update [0.50s] output/v3/issues/index.html - update [0.05s] output/v3/index.html +You can specify terminal blocks by using the `command-line` syntax highlighting. - Site compiled in 5.81s. + ``` command-line + $ curl foobar + ``` -You can setup whatever you want to view the files. If you have the adsf -gem, however (I hope so, it was in the Gemfile), you can start Webrick: +You can use certain characters, like `$` and `#`, to emphasize different parts +of commands. - $ nanoc view - $ open http://localhost:3000 + ``` command-line + # call foobar + $ curl foobar + .... + ``` -Compilation times got you down? Use `autocompile`! +For more information, see [the reference documentation](https://github.com/gjtorikian/extended-markdown-filter#command-line-highlighting). - $ nanoc autocompile +## Licenses -This starts a web server too, so there's no need to run `nanoc view`. -One thing: remember to add trailing slashes to all nanoc links! +The code to generate the site (everything excluding the assets, content, +and layouts directories) as well as the code samples on the site are +licensed under +[CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode). +CC0 waives all copyright restrictions but does not grant you any trademark +permissions. -## Deploy +Site content (everything in the assets, content, and layouts directories, +excluding files under open source licenses individually marked) is licensed +under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0 +gives you permission to use content for almost any purpose but does not grant +you any trademark permissions, so long as you note the license and give credit, +such as follows: - $ rake publish +> Content based on +> developer.github.com +> used under the +> CC-BY-4.0 +> license. -## TODO +This means you can use the code and content in this repository except for +GitHub trademarks in your own projects. -* Integrate through a simple hurl.it app for live API calls. -* Maybe add a nice TOC at the top of each page. -* Write a task for verifying JSON Resource examples against the actual - API. +When you contribute to this repository you are doing so under the above +licenses. diff --git a/Rakefile b/Rakefile index e936202c3a..066f1ab736 100644 --- a/Rakefile +++ b/Rakefile @@ -1,34 +1,111 @@ -require 'nanoc3/tasks' +require_relative 'lib/resources' +require 'tmpdir' -desc "Compile the site" -task :compile do - `nanoc compile` +Dir.glob('tasks/**/*.rake').each { |r| load r } + +task :default => [:test] + +desc 'Builds the site' +task :build do + if ENV['RACK_ENV'] == 'test' + begin + sh 'node_modules/gulp/bin/gulp.js build > build.txt' + rescue StandardError => e + puts 'uh oh' + $stderr.puts `cat build.txt` + raise e + end + else + sh 'node_modules/gulp/bin/gulp.js build' + end end -desc "Publish to http://developer.github.com" -task :publish => [:clean] do +desc "Test the output" +task :test => [:remove_tmp_dir, :remove_output_dir, :build] do + Rake::Task['spec'].invoke + Rake::Task['run_proofer'].invoke +end + +desc "Run Rspec" +task :spec do + require 'rspec/core/rake_task' + RSpec::Core::RakeTask.new(:rspec) + Rake::Task['rspec'].invoke +end + +desc "Run the HTML-Proofer" +task :run_proofer do + require 'html-proofer' + ignored_links = [%r{www.w3.org}, /api\.github\.com/, /import\.github\.com/] + # swap versionless Enterprise articles with versioned paths + url_swap = { + %r{help.github.com/enterprise/admin/} => "help.github.com/enterprise/#{config[:versions][0]}/admin/", + %r{help.github.com/enterprise/user/} => "help.github.com/enterprise/#{config[:versions][0]}/user/" + } + proofer_opts = { + :url_ignore => ignored_links, + :url_swap => url_swap, + :parallel => { :in_processes => 5 } + } + HTMLProofer.check_directory("./output", proofer_opts).run +end + +desc "Remove the tmp dir" +task :remove_tmp_dir do + FileUtils.rm_r('tmp') if File.exist?('tmp') +end + +desc "Remove the output dir" +task :remove_output_dir do FileUtils.rm_r('output') if File.exist?('output') +end - sh "nanoc compile" - - ENV['GIT_DIR'] = File.expand_path(`git rev-parse --git-dir`.chomp) - old_sha = `git rev-parse refs/remotes/origin/gh-pages`.chomp - Dir.chdir('output') do - ENV['GIT_INDEX_FILE'] = gif = '/tmp/dev.gh.i' - ENV['GIT_WORK_TREE'] = Dir.pwd - File.unlink(gif) if File.file?(gif) - `git add -A` - tsha = `git write-tree`.strip - puts "Created tree #{tsha}" - if old_sha.size == 40 - csha = `echo 'boom' | git commit-tree #{tsha} -p #{old_sha}`.strip - else - csha = `echo 'boom' | git commit-tree #{tsha}`.strip - end - puts "Created commit #{csha}" - puts `git show #{csha} --stat` - puts "Updating gh-pages from #{old_sha}" - `git update-ref refs/heads/gh-pages #{csha}` - `git push origin gh-pages` +# Prompt user for a commit message; default: P U B L I S H :emoji: +def commit_message(no_commit_msg = false) + publish_emojis = [':boom:', ':rocket:', ':metal:', ':bulb:', ':zap:', + ':sailboat:', ':gift:', ':ship:', ':shipit:', ':sparkles:', ':rainbow:'] + default_message = "P U B L I S H #{publish_emojis.sample}" + + unless no_commit_msg + print "Enter a commit message (default: '#{default_message}'): " + STDOUT.flush + mesg = STDIN.gets.chomp.strip end + + mesg = default_message if mesg.nil? || mesg == '' + mesg << "\nGenerated from #{ENV['BUILD_SHA']}" if ENV['BUILD_SHA'] + mesg.gsub(/'/, '') # Allow this to be handed off via -m '#{message}' +end + +namespace :assets do + task :precompile => [:build] do + sh 'mv output _site/' + end +end + +desc "Publish to http://developer.github.com" +task :publish, [:no_commit_msg] => [:remove_tmp_dir, :remove_output_dir, :build] do |t, args| + message = commit_message(args[:no_commit_msg]) + + Dir.mktmpdir do |tmp| + system "mv output/* #{tmp}" + system "cp .gitignore #{tmp}" + system 'git checkout gh-pages' + system "rsync -av #{tmp}/ ." + system 'git add .' + system "git commit -am #{message.shellescape}" + system 'git push origin gh-pages --force' + system 'git checkout master' + end +end + +desc "Generate JSON from the sample responses" +task :generate_json_from_responses do + Dir[File.join(File.dirname(__FILE__), 'lib', 'responses', '*.rb')].each { |file| load file } + FileUtils.mkdir_p(File.join(File.dirname(__FILE__), 'json-dump')) + GitHub::Resources::Responses.constants.each { |constant| + File.open('json-dump/' + constant.to_s + '.json', 'w') { |file| + file.write(JSON.pretty_generate(GitHub::Resources::Helpers.get_resource(constant))) + } + } end diff --git a/Rules b/Rules old mode 100644 new mode 100755 index 07124fa513..c04b63886d --- a/Rules +++ b/Rules @@ -4,36 +4,88 @@ # # * The order of rules is important: for each item, only the first matching # rule is applied. -# -# * Item identifiers start and end with a slash (e.g. “/about/” for the file -# “content/about.html”). To select all children, grandchildren, … of an -# item, use the pattern “/about/*/”; “/about/*” will also select the parent, -# because “*” matches zero or more characters. -compile '/static/*' do +preprocess do + add_created_at_attribute + add_kind_attribute + create_individual_blog_pages + generate_redirects(config[:redirects]) + @items.each do |item| + ConrefFS.apply_attributes(@config, item, :default) + end end -compile '/CNAME/' do +passthrough '/CNAME' + +compile '/changes.atom' do + filter :erb end -compile '*' do +compile '/integrations-directory/*' do + filter :'conref-fs-filter' filter :erb - filter :kramdown - filter :colorize_syntax, - :colorizers => {:javascript => :pygmentsrb} - layout 'default' + filter :html_pipeline, @config[:pipeline_config] + layout item[:layout] || '/integrations-directory.*' +end + +compile '/v3{.*,/**/*}' do + filter :'conref-fs-filter' + filter :erb + filter :html_pipeline, @config[:pipeline_config] + layout(item[:layout] ? "/#{item[:layout]}.*" : '/api.*') +end + +compile "/changes/20*" do + filter :'conref-fs-filter' + filter :erb + filter :html_pipeline, @config[:pipeline_config] + layout '/changes.*' + layout(item[:layout] ? "/#{item[:layout]}.*" : '/blog.*') +end + +compile '/guides/**/*' do + filter :'conref-fs-filter' + filter :html_pipeline, @config[:pipeline_config] + filter :erb + layout(item[:layout] ? "/#{item[:layout]}.*" : '/guides.*') +end + +compile '/webhooks/**/*' do + filter :'conref-fs-filter' + filter :erb + filter :html_pipeline, @config[:pipeline_config] + layout(item[:layout] ? "/#{item[:layout]}.*" : '/webhooks.*') +end + +compile '/search/search-index.json' do + filter :erb +end + +compile '/**/*' do + filter :'conref-fs-filter' + filter :erb + filter :html_pipeline, @config[:pipeline_config] + layout(item[:layout] ? "/#{item[:layout]}.*" : '/default.*') +end + +route '/changes.atom' do + '/changes.atom' +end + +route '/search/search-index.json' do + item.identifier.to_s end -route '/static/*' do - item.identifier[7..-2] +route '/**/index.*' do + item.identifier.without_ext + '.html' end -route '/CNAME/' do - '/CNAME' +route '/404.html' do + '/404.html' end -route '*' do - item.identifier + 'index.html' +route '/**/*' do + item.identifier.without_ext + '/index.html' end -layout '*', :erb +layout '/**/*', :erb diff --git a/assets/favicon.ico b/assets/favicon.ico new file mode 100644 index 0000000000..cedb6140f4 Binary files /dev/null and b/assets/favicon.ico differ diff --git a/assets/images/add_github_autodeploy_service.png b/assets/images/add_github_autodeploy_service.png new file mode 100644 index 0000000000..0a09f51f54 Binary files /dev/null and b/assets/images/add_github_autodeploy_service.png differ diff --git a/assets/images/add_heroku_autodeploy_service.png b/assets/images/add_heroku_autodeploy_service.png new file mode 100644 index 0000000000..389b3942c6 Binary files /dev/null and b/assets/images/add_heroku_autodeploy_service.png differ diff --git a/assets/images/callout-earth-static.png b/assets/images/callout-earth-static.png new file mode 100644 index 0000000000..f20e9e6d30 Binary files /dev/null and b/assets/images/callout-earth-static.png differ diff --git a/assets/images/cancel.png b/assets/images/cancel.png new file mode 100644 index 0000000000..a4742556fa Binary files /dev/null and b/assets/images/cancel.png differ diff --git a/assets/images/cancel@2x.png b/assets/images/cancel@2x.png new file mode 100644 index 0000000000..ca95b36109 Binary files /dev/null and b/assets/images/cancel@2x.png differ diff --git a/assets/images/deploy-keys.png b/assets/images/deploy-keys.png new file mode 100644 index 0000000000..5208ba9997 Binary files /dev/null and b/assets/images/deploy-keys.png differ diff --git a/assets/images/electrocat.png b/assets/images/electrocat.png new file mode 100644 index 0000000000..7a27fde088 Binary files /dev/null and b/assets/images/electrocat.png differ diff --git a/assets/images/electrocat@2x.png b/assets/images/electrocat@2x.png new file mode 100644 index 0000000000..563905bf69 Binary files /dev/null and b/assets/images/electrocat@2x.png differ diff --git a/assets/images/expand-arrows.png b/assets/images/expand-arrows.png new file mode 100644 index 0000000000..3c7c1a839b Binary files /dev/null and b/assets/images/expand-arrows.png differ diff --git a/assets/images/expand-arrows@2x.png b/assets/images/expand-arrows@2x.png new file mode 100644 index 0000000000..25273491b7 Binary files /dev/null and b/assets/images/expand-arrows@2x.png differ diff --git a/assets/images/feed-icon.png b/assets/images/feed-icon.png new file mode 100755 index 0000000000..428988e69b Binary files /dev/null and b/assets/images/feed-icon.png differ diff --git a/assets/images/feed-icon@2x.png b/assets/images/feed-icon@2x.png new file mode 100644 index 0000000000..90749098a7 Binary files /dev/null and b/assets/images/feed-icon@2x.png differ diff --git a/assets/images/gdp-callout-static.png b/assets/images/gdp-callout-static.png new file mode 100644 index 0000000000..f20e9e6d30 Binary files /dev/null and b/assets/images/gdp-callout-static.png differ diff --git a/assets/images/gundamcat.png b/assets/images/gundamcat.png new file mode 100644 index 0000000000..512d0ae921 Binary files /dev/null and b/assets/images/gundamcat.png differ diff --git a/assets/images/gundamcat@2x.png b/assets/images/gundamcat@2x.png new file mode 100644 index 0000000000..bf8e8ad414 Binary files /dev/null and b/assets/images/gundamcat@2x.png differ diff --git a/assets/images/header-animation-short-loop.gif b/assets/images/header-animation-short-loop.gif new file mode 100644 index 0000000000..5238585ecd Binary files /dev/null and b/assets/images/header-animation-short-loop.gif differ diff --git a/assets/images/header-animation.gif b/assets/images/header-animation.gif new file mode 100644 index 0000000000..7b20d910d8 Binary files /dev/null and b/assets/images/header-animation.gif differ diff --git a/assets/images/header.png b/assets/images/header.png new file mode 100644 index 0000000000..6a0a4cc1f1 Binary files /dev/null and b/assets/images/header.png differ diff --git a/assets/images/header@2x.png b/assets/images/header@2x.png new file mode 100644 index 0000000000..266eeaf94c Binary files /dev/null and b/assets/images/header@2x.png differ diff --git a/assets/images/logo_developer.png b/assets/images/logo_developer.png new file mode 100644 index 0000000000..b93dc932a9 Binary files /dev/null and b/assets/images/logo_developer.png differ diff --git a/assets/images/logo_developer@2x.png b/assets/images/logo_developer@2x.png new file mode 100644 index 0000000000..8a42891292 Binary files /dev/null and b/assets/images/logo_developer@2x.png differ diff --git a/assets/images/mark@2x.png b/assets/images/mark@2x.png new file mode 100644 index 0000000000..ea6ff545a2 Binary files /dev/null and b/assets/images/mark@2x.png differ diff --git a/assets/images/oauth_prompt.png b/assets/images/oauth_prompt.png new file mode 100644 index 0000000000..387d022505 Binary files /dev/null and b/assets/images/oauth_prompt.png differ diff --git a/assets/images/pagination_sample.png b/assets/images/pagination_sample.png new file mode 100644 index 0000000000..de20437d35 Binary files /dev/null and b/assets/images/pagination_sample.png differ diff --git a/assets/images/payload_request_tab.png b/assets/images/payload_request_tab.png new file mode 100644 index 0000000000..2fddc6d189 Binary files /dev/null and b/assets/images/payload_request_tab.png differ diff --git a/assets/images/payload_response_tab.png b/assets/images/payload_response_tab.png new file mode 100644 index 0000000000..f2507841db Binary files /dev/null and b/assets/images/payload_response_tab.png differ diff --git a/assets/images/personal_token.png b/assets/images/personal_token.png new file mode 100644 index 0000000000..188873d592 Binary files /dev/null and b/assets/images/personal_token.png differ diff --git a/assets/images/posts/create-repo-init.png b/assets/images/posts/create-repo-init.png new file mode 100644 index 0000000000..8a47f73a32 Binary files /dev/null and b/assets/images/posts/create-repo-init.png differ diff --git a/assets/images/posts/default-branch.png b/assets/images/posts/default-branch.png new file mode 100644 index 0000000000..30712f2b68 Binary files /dev/null and b/assets/images/posts/default-branch.png differ diff --git a/assets/images/posts/submodule-links.png b/assets/images/posts/submodule-links.png new file mode 100644 index 0000000000..a1e6e8ce25 Binary files /dev/null and b/assets/images/posts/submodule-links.png differ diff --git a/assets/images/professorcat.png b/assets/images/professorcat.png new file mode 100644 index 0000000000..00739ad078 Binary files /dev/null and b/assets/images/professorcat.png differ diff --git a/assets/images/professorcat@2x.png b/assets/images/professorcat@2x.png new file mode 100644 index 0000000000..f8139c71fd Binary files /dev/null and b/assets/images/professorcat@2x.png differ diff --git a/assets/images/rocketship.png b/assets/images/rocketship.png new file mode 100644 index 0000000000..f6720a52a8 Binary files /dev/null and b/assets/images/rocketship.png differ diff --git a/assets/images/rocketship@2x.png b/assets/images/rocketship@2x.png new file mode 100644 index 0000000000..4055ede1b6 Binary files /dev/null and b/assets/images/rocketship@2x.png differ diff --git a/assets/images/search.png b/assets/images/search.png new file mode 100644 index 0000000000..9021936e33 Binary files /dev/null and b/assets/images/search.png differ diff --git a/assets/images/search@2x.png b/assets/images/search@2x.png new file mode 100644 index 0000000000..1c39a700cf Binary files /dev/null and b/assets/images/search@2x.png differ diff --git a/assets/images/status-icon-good.png b/assets/images/status-icon-good.png new file mode 100644 index 0000000000..6b216644c9 Binary files /dev/null and b/assets/images/status-icon-good.png differ diff --git a/assets/images/status-icon-good@2x.png b/assets/images/status-icon-good@2x.png new file mode 100644 index 0000000000..93f4cc8691 Binary files /dev/null and b/assets/images/status-icon-good@2x.png differ diff --git a/assets/images/status-icon-major.png b/assets/images/status-icon-major.png new file mode 100644 index 0000000000..67ee1fe8c2 Binary files /dev/null and b/assets/images/status-icon-major.png differ diff --git a/assets/images/status-icon-major@2x.png b/assets/images/status-icon-major@2x.png new file mode 100644 index 0000000000..a57070c61b Binary files /dev/null and b/assets/images/status-icon-major@2x.png differ diff --git a/assets/images/status-icon-minor.png b/assets/images/status-icon-minor.png new file mode 100644 index 0000000000..4372e3c5b0 Binary files /dev/null and b/assets/images/status-icon-minor.png differ diff --git a/assets/images/status-icon-minor@2x.png b/assets/images/status-icon-minor@2x.png new file mode 100644 index 0000000000..5b1bfa10b5 Binary files /dev/null and b/assets/images/status-icon-minor@2x.png differ diff --git a/assets/images/status-icon-unknown.png b/assets/images/status-icon-unknown.png new file mode 100644 index 0000000000..7df5bc94cd Binary files /dev/null and b/assets/images/status-icon-unknown.png differ diff --git a/assets/images/status-icon-unknown@2x.png b/assets/images/status-icon-unknown@2x.png new file mode 100644 index 0000000000..49a482876c Binary files /dev/null and b/assets/images/status-icon-unknown@2x.png differ diff --git a/assets/images/webhook_sample_url.png b/assets/images/webhook_sample_url.png new file mode 100644 index 0000000000..abf4083d6b Binary files /dev/null and b/assets/images/webhook_sample_url.png differ diff --git a/assets/images/webhook_secret_token.png b/assets/images/webhook_secret_token.png new file mode 100644 index 0000000000..6d2074b6ac Binary files /dev/null and b/assets/images/webhook_secret_token.png differ diff --git a/assets/images/webhooks_recent_deliveries.png b/assets/images/webhooks_recent_deliveries.png new file mode 100644 index 0000000000..3a742bfeae Binary files /dev/null and b/assets/images/webhooks_recent_deliveries.png differ diff --git a/assets/javascripts/dev_mode.js b/assets/javascripts/dev_mode.js new file mode 100644 index 0000000000..1996cb2614 --- /dev/null +++ b/assets/javascripts/dev_mode.js @@ -0,0 +1,9 @@ +// Init sidebar +$(function() { + $(window).keydown(function(e){ + // d + if (e.keyCode == 68) { + $("body.dev-mode").toggleClass('enterprise') + } + }); +}); diff --git a/assets/javascripts/documentation.js b/assets/javascripts/documentation.js new file mode 100644 index 0000000000..d006cd551e --- /dev/null +++ b/assets/javascripts/documentation.js @@ -0,0 +1,96 @@ +// Init sidebar +$(function() { + var activeItem, + helpList = $('#js-sidebar .js-topic'), + firstOccurance = true, + styleTOC = function() { + var pathRegEx = /\/\/[^\/]+([A-Za-z0-9-_./]+)/g, + docUrl = pathRegEx.exec(window.location.toString()) + if (docUrl){ + $('#js-sidebar .js-topic a').each(function(){ + if ($(this).parent('li').hasClass('disable')) + $(this).parent('li').removeClass('disable') + + var url = $(this).attr('href').toString() + var cleanDocUrl = docUrl[1] + if(url.indexOf(cleanDocUrl) >= 0 && url.length == cleanDocUrl.length){ + $(this).parent('li').addClass('disable') + var parentTopic = $(this).parentsUntil('div.sidebar-module > ul').last() + parentTopic.addClass('js-current') + parentTopic.find('.js-expand-btn').toggleClass('collapsed expanded') + } + }); + } + } + + // bind every href with a hash; take a look at v3/search/ for example + $('#js-sidebar .js-accordion-list .js-topic a[href*=#]').bind("click", function(e) { + if (window.location.toString().indexOf($(e.target).attr('href')) == -1) + setTimeout(styleTOC, 0); // trigger the window.location change, then stylize + }); + + // hide list items at startup + if($('body.api') && window.location){ + styleTOC(); + } + + $('#js-sidebar .js-topic').each(function(){ + if(($(this).find('.disable').length == 0 || firstOccurance == false) && + $(this).hasClass('js-current') != true){ + $(this).find('.js-guides').children().hide() + } else { + activeItem = $(this).index() + firstOccurance = false + } + }) + + // Toggle style list. Expanded items stay + // expanded when new items are clicked. + $('#js-sidebar .js-toggle-list .js-expand-btn').click(function(){ + var clickedTopic = $(this).parents('.js-topic'), + topicGuides = clickedTopic.find('.js-guides li') + $(this).toggleClass('collapsed expanded') + topicGuides.slideToggle(100) + return false + }) + + // Accordion style list. Expanded items + // collapse when new items are clicked. + $('#js-sidebar .js-accordion-list .js-topic h3 a').click(function(){ + var clickedTopic = $(this).parents('.js-topic'), + topicGuides = clickedTopic.find('.js-guides li') + + if(activeItem != clickedTopic.index()){ + if(helpList.eq(activeItem)){ + helpList.eq(activeItem).find('.js-guides li').slideToggle(100) + } + activeItem = clickedTopic.index() + topicGuides.slideToggle(100) + } else { + activeItem = undefined + topicGuides.slideToggle(100) + } + + return false + }) + + // Grab API status + $.getJSON('https://status.github.com/api/status.json?callback=?', function(data) { + if(data) { + var link = $("") + .attr("href", "https://status.github.com") + .addClass(data.status) + .attr("title", "API Status: " + data.status + ". Click for details.") + .text("API Status: " + data.status); + $('.api-status').html(link); + } + }); + + // Earth animation + if ($('.dev-program').length) { + setTimeout(function() { + $('.earth').fadeOut(); + $('.earth-short-loop').show(); + }, 19 * 1000); // Let first loop run through 19 seconds + } +}); diff --git a/assets/javascripts/images.js b/assets/javascripts/images.js new file mode 100644 index 0000000000..d335cfceb6 --- /dev/null +++ b/assets/javascripts/images.js @@ -0,0 +1,25 @@ +$(function() { + // copy Help's image show/hide functionality in OLs + var dismissFullImage; + + $('ol img').each(function(index, elem) { + return $(elem).parent().prepend(elem); + }); + + $(document).on('click', 'ol img', function(event) { + var $fullImg, $img; + dismissFullImage(); + $img = $(event.currentTarget).clone(); + $fullImg = $('
').prepend($img);
+ $(this).closest('li').append($fullImg);
+ return $(document).on('click', '.js-full-image', function() {
+ dismissFullImage();
+ return false;
+ });
+ });
+
+ dismissFullImage = function() {
+ $(document).off('click', '.js-full-image', dismissFullImage);
+ return $('.js-full-image').remove();
+ };
+});
diff --git a/assets/javascripts/initial.js b/assets/javascripts/initial.js
new file mode 100644
index 0000000000..be7d49d2fd
--- /dev/null
+++ b/assets/javascripts/initial.js
@@ -0,0 +1,18 @@
+// before anything happens, check if this is a versionless enterprise URL
+path = window.location.pathname;
+hash = window.location.hash;
+paths = path.split("/");
+if (paths[1] == "enterprise" && (paths[2].length === 0 || isNaN(paths[2]))) {
+ paths.splice(2, 0, String({{ site.version }}));
+ suffix = window.location.search || window.location.hash;
+ window.location.href = window.location.protocol + "//" + window.location.host + paths.join("/") + suffix;
+}
+if (path == "/v3/repos/" && hash == "#enabling-and-disabling-branch-protection") {
+ window.location.href = "/v3/repos/branches/#get-branch-protection";
+}
+if (path == "/v3/repos/" && hash == "#list-branches") {
+ window.location.href = "/v3/repos/branches/#list-branches";
+}
+if (path == "/v3/repos/" && hash == "#get-branch") {
+ window.location.href = "/v3/repos/branches/#get-branch";
+}
diff --git a/assets/javascripts/search.js b/assets/javascripts/search.js
new file mode 100644
index 0000000000..33755e348e
--- /dev/null
+++ b/assets/javascripts/search.js
@@ -0,0 +1,188 @@
+$(function() {
+ var searchIndex,
+ searchHits,
+ searchWorker = new Worker("/assets/javascripts/search_worker.js");
+
+ $('.help-search .search-box').focus(function(){
+ $(this).css('background-position','0px -25px')
+ });
+
+ $('.help-search .search-box').focusout(function(){
+ if($(this).val() == ''){
+ $(this).css('background-position','0px 0px')
+ }
+ });
+
+ // Load the JSON containing all pages
+ // Has it been loaded before (and stored with localstorage)?
+ if (localStorage['searchIndex']) {
+ searchIndex = JSON.parse(localStorage['searchIndex']);
+
+ if (localStorageHasExpired()) {
+ loadSearchIndex();
+ }
+ else {
+ searchIndex.type = "index";
+ searchWorker.postMessage(searchIndex);
+ }
+ } else {
+ loadSearchIndex();
+ }
+
+ function loadSearchIndex() {
+ $.getJSON('/search/search-index.json', function(data) {
+ data.type = { index: true };
+ searchWorker.postMessage(data);
+ searchIndex = data;
+ localStorage['searchIndex'] = JSON.stringify(searchIndex);
+ localStorage['updated'] = new Date().getTime();
+ });
+ }
+
+ function localStorageHasExpired() {
+ // Expires in one day (86400000 ms)
+ if (new Date().getTime() - parseInt(localStorage['updated'],10) > 86400000) {
+ return true;
+ }
+
+ return false;
+ }
+
+ // Expand and activate search if the page loaded with a value set for the search field
+ if ($("#searchfield").val().length > 0) {
+ $("#search-container").addClass("active");
+ searchForString($("#searchfield").val());
+ }
+
+ // On input change, update the search results
+ $("#searchfield").on("input", function(e) {
+ $(this).val().length > 0 ? $("#search-container").addClass("active") : $("#search-container").removeClass("active");
+
+ searchForString($(this).val());
+ });
+
+ // Global keyboard shortcuts
+ $("body").keyup(function(e) {
+ if (e.keyCode == 83) {
+ // S key
+ if ($("#searchfield").is(":focus"))
+ return;
+
+ e.preventDefault();
+ $("#searchfield").focus();
+ }
+ });
+
+ // Keyboard support for the search field
+ $("#searchfield").keyup(function(e) {
+ if (e.keyCode == 27) {
+ // ESC
+ e.preventDefault();
+ $("#searchfield").val().length > 0 ? cancelSearch() : $("#searchfield").blur();
+ } else if (e.keyCode == 13) {
+ // Return/enter
+ e.preventDefault();
+ goToSelectedSearchResult();
+ } else if (e.keyCode == 8 || e.keyCode == 46) {
+ // Update search if backspace/delete was pressed
+ // IE9 doesn't trigger the input event on backspace/delete,
+ // but they do trigger keyUp
+ $(this).val().length > 0 ? $("#search-container").addClass("active") : $("#search-container").removeClass("active");
+
+ searchForString($(this).val());
+ }
+ }).keydown(function(e) {
+ if (e.keyCode == 38) {
+ // Arrow up
+ e.preventDefault();
+ moveSearchSelectionUp();
+ } else if (e.keyCode == 40) {
+ // Arrow down
+ e.preventDefault();
+ moveSearchSelectionDown();
+ } else if (e.keyCode == 27) {
+ // Prevent default on ESC key
+ // IE inputs come with some native behaviors that will
+ // prevent the DOM from updating correctly unless prevented
+ e.preventDefault();
+ }
+ });
+
+ // Make clicking the label focus the input label
+ // for browsers (IE) that doesn't support pointer-events: none
+ $("#search-container .search-placeholder").click(function(e) {
+ $("#searchfield").focus();
+ });
+
+ $(".cancel-search").click(function(e) {
+ cancelSearch();
+ });
+
+ function cancelSearch() {
+ $("#searchfield").val("");
+ $("#search-container").removeClass("active");
+ }
+
+ function searchForString(searchString) {
+ searchHits = [];
+ searchString = searchString.toLowerCase();
+ searchWorker.postMessage({ query: searchString, type: "search" })
+ }
+
+ searchWorker.addEventListener("message", function (e) {
+ if (e.data.type.search) {
+ renderResultsForSearch(e.data.query, e.data.results);
+ }
+ });
+
+ // Update the UI representation of the search hits
+ function renderResultsForSearch(searchString, searchHits){
+ $("#search-results").empty();
+
+ // Check if there are any results. If not, show placeholder and exit
+ if (searchHits.length < 1) {
+ $('
+```
+
+The script will check your server to see if an alternative image exists at `/images/my_image@2x.png`
+
+However, if you have:
+
+```html
+
+```
+
+The script will use `http://example.com/my_image@2x.png` as the high-resolution image. No checks to the server will be performed.
+
+## How to use
+
+### JavaScript
+
+The JavaScript helper script automatically replaces images on your page with high-resolution variants (if they exist). To use it, download the script and include it at the bottom of your page.
+
+1. Place the retina.js file on your server
+2. Include the script on your page (put it at the bottom of your template, before your closing \ tag)
+
+``` html
+
+```
+
+### LESS
+
+The LESS CSS mixin is a helper for applying high-resolution background images in your stylesheet. You provide it with an image path and the dimensions of the original-resolution image. The mixin creates a media query specifically for Retina displays, changes the background image for the selector elements to use the high-resolution (@2x) variant and applies a background-size of the original image in order to maintain proper dimensions. To use it, download the mixin, import or include it in your LESS stylesheet, and apply it to elements of your choice.
+
+*Syntax:*
+
+``` less
+.at2x(@path, [optional] @width: auto, [optional] @height: auto);
+```
+
+*Steps:*
+
+1. Add the .at2x() mixin from retina.less to your LESS stylesheet (or reference it in an @import statement)
+2. In your stylesheet, call the .at2x() mixin anywhere instead of using background-image
+
+This:
+
+``` less
+.logo {
+ .at2x('/images/my_image.png', 200px, 100px);
+}
+```
+
+Will compile to:
+
+``` less
+.logo {
+ background-image: url('/images/my_image.png');
+}
+
+@media all and (-webkit-min-device-pixel-ratio: 1.5) {
+ .logo {
+ background-image: url('/images/my_image@2x.png');
+ background-size: 200px 100px;
+ }
+}
+```
+
+### Ruby on Rails 3.x
+
+...or any framework that embeds some digest/hash to the asset URLs based on the contents, e.g. `/images/image-{hash1}.jpg`.
+
+The problem with this is that the high-resolution version would have a different hash, and would not conform the usual pattern, i.e. `/images/image@2x-{hash2}.jpg`. So automatic detection would fail because retina.js would check the existence of `/images/image-{hash1}@2x.jpg`.
+
+There's no way for retina.js to know beforehand what the high-resolution image's hash would be without some sort of help from the server side. So in this case, the suggested method is to supply the high-resolution URLs using the `data-at2x` attributes as previously described in the How It Works section.
+
+In Rails, one way to automate this is using a helper, e.g.:
+
+```ruby
+# in app/helpers/some_helper.rb or app/helpers/application_helper.rb
+def image_tag_with_at2x(name_at_1x, options={})
+ name_at_2x = name_at_1x.gsub(%r{\.\w+$}, '@2x\0')
+ image_tag(name_at_1x, options.merge("data-at2x" => asset_path(name_at_2x)))
+end
+```
+
+And then in your views (templates), instead of using image_tag, you would use image_tag_with_at2x, e.g. for ERB:
+
+```erb
+<%= image_tag_with_at2x "logo.png" %>
+```
+
+It would generate something like:
+
+```html
+
+```
+
+## How to test
+
+We use [mocha](http://visionmedia.github.com/mocha/) for unit testing with [should](https://github.com/visionmedia/should.js) assertions. Install mocha and should by running `npm install`.
+
+To run the test suite:
+
+``` bash
+$ npm test
+```
+
+Use [http-server](https://github.com/nodeapps/http-server) for node.js to test it. To install, run `npm install -g http-server`.
+
+If you've updated `retina.js` be sure to copy it from `src/retina.js` to `test/functional/public/retina.js`.
+
+To start the server, run:
+
+``` bash
+$ cd test/functional && http-server
+```
+
+Then navigate your browser to [http://localhost:8080](http://localhost:8080)
+
+After that, open up `test/functional/public/index.html` in your editor, and try commenting out the line that spoofs retina support, and reloading it.
diff --git a/assets/vendor/retinajs/package.json b/assets/vendor/retinajs/package.json
new file mode 100644
index 0000000000..f35dc1796f
--- /dev/null
+++ b/assets/vendor/retinajs/package.json
@@ -0,0 +1,13 @@
+{
+ "name": "retina.js",
+ "version": "1.1.0",
+ "devDependencies": {
+ "mocha": "*",
+ "should": "*",
+ "less": "*"
+ },
+ "main": "./src/retina",
+ "scripts": {
+ "test": "mocha"
+ }
+}
diff --git a/assets/vendor/retinajs/src/retina.js b/assets/vendor/retinajs/src/retina.js
new file mode 100644
index 0000000000..c948b7f4f0
--- /dev/null
+++ b/assets/vendor/retinajs/src/retina.js
@@ -0,0 +1,143 @@
+(function() {
+
+ var root = (typeof exports == 'undefined' ? window : exports);
+
+ var config = {
+ // Ensure Content-Type is an image before trying to load @2x image
+ // https://github.com/imulus/retinajs/pull/45)
+ check_mime_type: true
+ };
+
+
+
+ root.Retina = Retina;
+
+ function Retina() {}
+
+ Retina.configure = function(options) {
+ if (options == null) options = {};
+ for (var prop in options) config[prop] = options[prop];
+ };
+
+ Retina.init = function(context) {
+ if (context == null) context = root;
+
+ var existing_onload = context.onload || new Function;
+
+ context.onload = function() {
+ var images = document.getElementsByTagName("img"), retinaImages = [], i, image;
+ for (i = 0; i < images.length; i++) {
+ image = images[i];
+ retinaImages.push(new RetinaImage(image));
+ }
+ existing_onload();
+ }
+ };
+
+ Retina.isRetina = function(){
+ var mediaQuery = "(-webkit-min-device-pixel-ratio: 1.5),\
+ (min--moz-device-pixel-ratio: 1.5),\
+ (-o-min-device-pixel-ratio: 3/2),\
+ (min-resolution: 1.5dppx)";
+
+ if (root.devicePixelRatio > 1)
+ return true;
+
+ if (root.matchMedia && root.matchMedia(mediaQuery).matches)
+ return true;
+
+ return false;
+ };
+
+
+ root.RetinaImagePath = RetinaImagePath;
+
+ function RetinaImagePath(path, at_2x_path) {
+ this.path = path;
+ if (typeof at_2x_path !== "undefined" && at_2x_path !== null) {
+ this.at_2x_path = at_2x_path;
+ this.perform_check = false;
+ } else {
+ this.at_2x_path = path.replace(/\.\w+$/, function(match) { return "@2x" + match; });
+ this.perform_check = true;
+ }
+ }
+
+ RetinaImagePath.confirmed_paths = [];
+
+ RetinaImagePath.prototype.is_external = function() {
+ return !!(this.path.match(/^https?\:/i) && !this.path.match('//' + document.domain) )
+ }
+
+ RetinaImagePath.prototype.check_2x_variant = function(callback) {
+ var http, that = this;
+ if (this.is_external()) {
+ return callback(false);
+ } else if (!this.perform_check && typeof this.at_2x_path !== "undefined" && this.at_2x_path !== null) {
+ return callback(true);
+ } else if (this.at_2x_path in RetinaImagePath.confirmed_paths) {
+ return callback(true);
+ } else {
+ http = new XMLHttpRequest;
+ http.open('HEAD', this.at_2x_path);
+ http.onreadystatechange = function() {
+ if (http.readyState != 4) {
+ return callback(false);
+ }
+
+ if (http.status >= 200 && http.status <= 399) {
+ if (config.check_mime_type) {
+ var type = http.getResponseHeader('Content-Type');
+ if (type == null || !type.match(/^image/i)) {
+ return callback(false);
+ }
+ }
+
+ RetinaImagePath.confirmed_paths.push(that.at_2x_path);
+ return callback(true);
+ } else {
+ return callback(false);
+ }
+ }
+ http.send();
+ }
+ }
+
+
+
+ function RetinaImage(el) {
+ this.el = el;
+ this.path = new RetinaImagePath(this.el.getAttribute('src'), this.el.getAttribute('data-at2x'));
+ var that = this;
+ this.path.check_2x_variant(function(hasVariant) {
+ if (hasVariant) that.swap();
+ });
+ }
+
+ root.RetinaImage = RetinaImage;
+
+ RetinaImage.prototype.swap = function(path) {
+ if (typeof path == 'undefined') path = this.path.at_2x_path;
+
+ var that = this;
+ function load() {
+ if (! that.el.complete) {
+ setTimeout(load, 5);
+ } else {
+ that.el.setAttribute('width', that.el.offsetWidth);
+ that.el.setAttribute('height', that.el.offsetHeight);
+ that.el.setAttribute('src', path);
+ }
+ }
+ load();
+ }
+
+
+
+
+ if (Retina.isRetina()) {
+ Retina.init(root);
+ }
+
+})();
+
diff --git a/assets/vendor/retinajs/src/retina.less b/assets/vendor/retinajs/src/retina.less
new file mode 100644
index 0000000000..3b96a416cd
--- /dev/null
+++ b/assets/vendor/retinajs/src/retina.less
@@ -0,0 +1,14 @@
+// retina.less
+// A helper mixin for applying high-resolution background images (http://www.retinajs.com)
+
+@highdpi: ~"(-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (-o-min-device-pixel-ratio: 3/2), (min-resolution: 1.5dppx)";
+
+.at2x(@path, @w: auto, @h: auto) {
+ background-image: url(@path);
+ @at2x_path: ~`@{path}.replace(/\.\w+$/, function(match) { return "@2x" + match; })`;
+
+ @media @highdpi {
+ background-image: url("@{at2x_path}");
+ background-size: @w @h;
+ }
+}
diff --git a/assets/vendor/retinajs/test/fixtures/desired_output.css b/assets/vendor/retinajs/test/fixtures/desired_output.css
new file mode 100644
index 0000000000..493c281363
--- /dev/null
+++ b/assets/vendor/retinajs/test/fixtures/desired_output.css
@@ -0,0 +1,18 @@
+body {
+ background-image: url('/path/to/image.png');
+}
+@media (-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (-o-min-device-pixel-ratio: 3/2), (min-resolution: 1.5dppx) {
+ body {
+ background-image: url("/path/to/image@2x.png");
+ background-size: 200px 100px;
+ }
+}
+header {
+ background-image: url("/path/to/header.png");
+}
+@media (-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (-o-min-device-pixel-ratio: 3/2), (min-resolution: 1.5dppx) {
+ header {
+ background-image: url("/path/to/header@2x.png");
+ background-size: 600px 50px;
+ }
+}
diff --git a/assets/vendor/retinajs/test/fixtures/image.js b/assets/vendor/retinajs/test/fixtures/image.js
new file mode 100644
index 0000000000..976b56be8f
--- /dev/null
+++ b/assets/vendor/retinajs/test/fixtures/image.js
@@ -0,0 +1,19 @@
+function Image() {
+ this.complete = true;
+ this.attributes = {
+ src : "/images/some_image.png",
+ offsetWidth : 500,
+ offsetHeight : 400
+ };
+}
+
+Image.prototype.setAttribute = function(name, value) {
+ this.attributes[name] = value;
+}
+
+Image.prototype.getAttribute = function(name) {
+ return this.attributes[name];
+}
+
+var root = (exports || window);
+root.Image = Image;
diff --git a/assets/vendor/retinajs/test/fixtures/test.less b/assets/vendor/retinajs/test/fixtures/test.less
new file mode 100644
index 0000000000..47e13f7533
--- /dev/null
+++ b/assets/vendor/retinajs/test/fixtures/test.less
@@ -0,0 +1,10 @@
+@import 'src/retina';
+
+// Single quoted
+body {
+ .at2x('/path/to/image.png', 200px, 100px);
+}
+// Double quoted
+header {
+ .at2x("/path/to/header.png", 600px, 50px);
+}
diff --git a/assets/vendor/retinajs/test/fixtures/xml_http_request.js b/assets/vendor/retinajs/test/fixtures/xml_http_request.js
new file mode 100644
index 0000000000..7c26b1cab7
--- /dev/null
+++ b/assets/vendor/retinajs/test/fixtures/xml_http_request.js
@@ -0,0 +1,24 @@
+function XMLHttpRequest() {
+ this.status = XMLHttpRequest.status;
+ this.contentType = XMLHttpRequest.contentType;
+ this.readyState = 4;
+ this.onreadystatechange = function() {}
+}
+
+XMLHttpRequest.status = 200;
+XMLHttpRequest.contentType = 'image/png';
+
+XMLHttpRequest.prototype.open = function() {
+ return true;
+}
+
+XMLHttpRequest.prototype.send = function() {
+ this.onreadystatechange();
+}
+
+XMLHttpRequest.prototype.getResponseHeader = function(contentType) {
+ return this.contentType;
+}
+
+var root = (exports || window);
+root.XMLHttpRequest = XMLHttpRequest;
diff --git a/assets/vendor/retinajs/test/functional/public/google.png b/assets/vendor/retinajs/test/functional/public/google.png
new file mode 100644
index 0000000000..533d2b2737
Binary files /dev/null and b/assets/vendor/retinajs/test/functional/public/google.png differ
diff --git a/assets/vendor/retinajs/test/functional/public/google@1x.png b/assets/vendor/retinajs/test/functional/public/google@1x.png
new file mode 100644
index 0000000000..533d2b2737
Binary files /dev/null and b/assets/vendor/retinajs/test/functional/public/google@1x.png differ
diff --git a/assets/vendor/retinajs/test/functional/public/google@2x.png b/assets/vendor/retinajs/test/functional/public/google@2x.png
new file mode 100644
index 0000000000..99b37d55bf
Binary files /dev/null and b/assets/vendor/retinajs/test/functional/public/google@2x.png differ
diff --git a/assets/vendor/retinajs/test/functional/public/index.html b/assets/vendor/retinajs/test/functional/public/index.html
new file mode 100644
index 0000000000..8dc85f57fd
--- /dev/null
+++ b/assets/vendor/retinajs/test/functional/public/index.html
@@ -0,0 +1,39 @@
+
+
+
+
+
+
+
+
+ 
+
+ 
+ 
+
+
+ 
+ 
+
+
+
+
+
+
+
+
+
diff --git a/assets/vendor/retinajs/test/functional/public/ipad_hero.jpeg b/assets/vendor/retinajs/test/functional/public/ipad_hero.jpeg
new file mode 100644
index 0000000000..40943cb679
Binary files /dev/null and b/assets/vendor/retinajs/test/functional/public/ipad_hero.jpeg differ
diff --git a/assets/vendor/retinajs/test/functional/public/ipad_hero@1x.jpeg b/assets/vendor/retinajs/test/functional/public/ipad_hero@1x.jpeg
new file mode 100644
index 0000000000..40943cb679
Binary files /dev/null and b/assets/vendor/retinajs/test/functional/public/ipad_hero@1x.jpeg differ
diff --git a/assets/vendor/retinajs/test/functional/public/ipad_hero@2x.jpeg b/assets/vendor/retinajs/test/functional/public/ipad_hero@2x.jpeg
new file mode 100644
index 0000000000..da7a1709d4
Binary files /dev/null and b/assets/vendor/retinajs/test/functional/public/ipad_hero@2x.jpeg differ
diff --git a/assets/vendor/retinajs/test/mocha.opts b/assets/vendor/retinajs/test/mocha.opts
new file mode 100644
index 0000000000..24d45f5902
--- /dev/null
+++ b/assets/vendor/retinajs/test/mocha.opts
@@ -0,0 +1,3 @@
+--require should
+--slow 20
+--growl
diff --git a/assets/vendor/retinajs/test/retina.test.js b/assets/vendor/retinajs/test/retina.test.js
new file mode 100644
index 0000000000..6dc3ad4934
--- /dev/null
+++ b/assets/vendor/retinajs/test/retina.test.js
@@ -0,0 +1,36 @@
+// Create a document object because we don't have one
+// in our Node test environment
+delete global.document;
+global.document = {};
+
+var Retina = require('../').Retina;
+
+describe('Retina', function() {
+
+ before(function(){
+ // stub out the getElementsByTagName method
+ global.document = {
+ getElementsByTagName : function(){
+ return [];
+ }
+ }
+ });
+
+ describe('init', function(){
+ it('stashes the existing onload and executes it later', function(){
+ var existingOnloadExecutions = 0;
+ var window = {
+ matchMedia : function() {
+ return { matches: false }
+ },
+ onload : function() {
+ existingOnloadExecutions++;
+ }
+ };
+ Retina.init(window);
+ window.onload();
+ existingOnloadExecutions.should.equal(1);
+ });
+ });
+
+});
diff --git a/assets/vendor/retinajs/test/retina_image_path.test.js b/assets/vendor/retinajs/test/retina_image_path.test.js
new file mode 100644
index 0000000000..439d711b4a
--- /dev/null
+++ b/assets/vendor/retinajs/test/retina_image_path.test.js
@@ -0,0 +1,195 @@
+// Create a document object because we don't have one
+// in our Node test environment
+delete global.document;
+global.document = {};
+global.Image = require('./fixtures/image').Image;
+global.XMLHttpRequest = require('./fixtures/xml_http_request').XMLHttpRequest;
+
+global.exports = {
+ devicePixelRatio : 0.9,
+ matchMedia : function() {
+ return {
+ matches : false
+ }
+ }
+}
+
+var Retina = require('../').Retina;
+var RetinaImage = require('../').RetinaImage;
+var RetinaImagePath = require('../').RetinaImagePath;
+
+describe('RetinaImagePath', function() {
+ var path = null;
+
+ before(function(){
+ global.document = {domain: null};
+ });
+
+ describe('@at_2x_path', function(){
+ it('adds "@2x" before the extension', function(){
+ path = new RetinaImagePath("/path/to/image.png");
+ path.at_2x_path.should.equal("/path/to/image@2x.png");
+ });
+
+ it('uses data-@2x when supplied', function(){
+ path = new RetinaImagePath("/path/to/image-hash1.png", "/path/to/image@2x-hash2.png");
+ path.at_2x_path.should.equal("/path/to/image@2x-hash2.png");
+ });
+ });
+
+ describe('#is_external()', function() {
+ it('should return true when image path references a remote domain with www', function() {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("http://www.google.com/images/some_image.png");
+ path.is_external().should.equal(true);
+ });
+
+ it('should return true when image path references a remote domain without www', function() {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("http://google.com/images/some_image.png");
+ path.is_external().should.equal(true);
+ });
+
+ it('should return true when image path references a remote domain with https', function() {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("https://google.com/images/some_image.png");
+ path.is_external().should.equal(true);
+ });
+
+ it('should return true when image path is a remote domain with www and domain is localhost', function() {
+ document.domain = "localhost";
+ path = new RetinaImagePath("http://www.google.com/images/some_image.png");
+ path.is_external().should.equal(true);
+ });
+
+ it('should return true when image path is a remote domain without www and domain is localhost', function() {
+ document.domain = "localhost"
+ path = new RetinaImagePath("http://google.com/images/some_image.png")
+ path.is_external().should.equal(true);
+ });
+
+ it('should return true when image path has www and domain does not', function() {
+ document.domain = "apple.com";
+ path = new RetinaImagePath("http://www.apple.com/images/some_image.png");
+ path.is_external().should.equal(true);
+ });
+
+ it('should return true when image path does not have www and domain does', function() {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("http://apple.com/images/some_image.png");
+ path.is_external().should.equal(true);
+ });
+
+ it('should return false when image path is relative with www', function() {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("/images/some_image.png");
+ path.is_external().should.equal(false);
+ });
+
+ it('should return false when image path is relative without www', function() {
+ document.domain = "apple.com";
+ path = new RetinaImagePath("/images/some_image.png");
+ path.is_external().should.equal(false);
+ });
+
+ it('should return false when image path is relative to localhost', function() {
+ document.domain = "localhost";
+ path = new RetinaImagePath("/images/some_image.png");
+ path.is_external().should.equal(false);
+ });
+
+ it('should return false when image path has same domain as current site with www', function() {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("http://www.apple.com/images/some_image.png");
+ path.is_external().should.equal(false);
+ });
+ });
+
+ describe('#check_2x_variant()', function() {
+ it('should callback with false when #is_external() is true', function(done) {
+ document.domain = "www.apple.com";
+ path = new RetinaImagePath("http://google.com/images/some_image.png");
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(false);
+ done();
+ });
+ });
+
+ it('should callback with true when at2x is supplied', function(done) {
+ path = new RetinaImagePath("/images/some_image.png", "/images/some_image@100x.png");
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(true);
+ done();
+ });
+ });
+
+ it('should callback with false when remote at2x image does not exist', function(done) {
+ XMLHttpRequest.status = 404; // simulate a failing request
+ XMLHttpRequest.contentType = 'image/png'; // simulate a proper content type
+ path = new RetinaImagePath("/images/some_image.png");
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(false);
+ done();
+ });
+ });
+
+ it('should callback with false when content-type is not an image type', function(done) {
+ XMLHttpRequest.status = 200; // simulate a an image request that comes back OK
+ XMLHttpRequest.contentType = 'text/html'; // but is actually an improperly coded 404 page
+ path = new RetinaImagePath("/images/some_image.png");
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(false);
+ done();
+ });
+ });
+
+ it('should callback with true when content-type is wrong, but check_mime_type is false', function(done) {
+ XMLHttpRequest.status = 200; // simulate a proper request
+ XMLHttpRequest.contentType = 'text/html'; // but with an incorrect content type
+
+ Retina.configure({
+ check_mime_type: false // but ignore it
+ });
+
+ path = new RetinaImagePath("/images/some_image.png");
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(true);
+
+ Retina.configure({
+ check_mime_type: true
+ });
+
+ done();
+ });
+ });
+
+ it('should callback with true when remote at2x image exists', function(done) {
+ XMLHttpRequest.status = 200; // simulate a proper request
+ XMLHttpRequest.contentType = 'image/png'; // simulate a proper content type
+ path = new RetinaImagePath("/images/some_image.png");
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(true);
+ done();
+ });
+ });
+
+ it('should add path to cache when at2x image exists', function(done) {
+ XMLHttpRequest.status = 200; // simulate a proper request
+ XMLHttpRequest.contentType = 'image/png'; // simulate a proper content type
+ path = new RetinaImagePath("/images/some_image.png");
+ path.check_2x_variant(function(hasVariant) {
+ RetinaImagePath.confirmed_paths.should.include(path.at_2x_path);
+ done();
+ });
+ });
+
+ it('should return true when the at2x image path has already been checked and confirmed', function(done) {
+ RetinaImagePath.confirmed_paths = ['/images/some_image@2x.png']
+ path = new RetinaImagePath("/images/some_image.png")
+ path.check_2x_variant(function(hasVariant) {
+ hasVariant.should.equal(true);
+ done();
+ });
+ });
+ });
+});
diff --git a/assets/vendor/retinajs/test/retina_less.test.js b/assets/vendor/retinajs/test/retina_less.test.js
new file mode 100644
index 0000000000..7268ab14e4
--- /dev/null
+++ b/assets/vendor/retinajs/test/retina_less.test.js
@@ -0,0 +1,17 @@
+var fs = require('fs');
+var less = require('less');
+
+describe('retina.less', function() {
+
+ describe('.at2x()', function(){
+ it('compiles correctly', function(done){
+ var desired_output = fs.readFileSync('test/fixtures/desired_output.css', 'utf8');
+ var input = fs.readFileSync('test/fixtures/test.less', 'utf8');
+ less.render(input, function (e, actual_output) {
+ actual_output.should.equal(desired_output);
+ done();
+ });
+ });
+ });
+
+});
diff --git a/bower.json b/bower.json
new file mode 100644
index 0000000000..d2ddf6b081
--- /dev/null
+++ b/bower.json
@@ -0,0 +1,8 @@
+{
+ "name": "developer.github.com",
+ "dependencies": {
+ "lunr.js": "0.6.0",
+ "octicons": "3.0.1",
+ "retinajs": "1.1.0"
+ }
+}
diff --git a/config.ru b/config.ru
new file mode 100644
index 0000000000..6763c19b6b
--- /dev/null
+++ b/config.ru
@@ -0,0 +1,5 @@
+# This file is auto-generated by Jekyll Auth
+# It tells Heroku how to launch our site
+
+require "jekyll-auth"
+run JekyllAuth.site
diff --git a/config.yaml b/config.yaml
deleted file mode 100644
index 3962209e19..0000000000
--- a/config.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-# A list of file extensions that nanoc will consider to be textual rather than
-# binary. If an item with an extension not in this list is found, the file
-# will be considered as binary.
-text_extensions: [ 'css', 'erb', 'haml', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'php', 'rb', 'sass', 'scss', 'txt', 'xhtml', 'xml' ]
-
-# The path to the directory where all generated files will be written to. This
-# can be an absolute path starting with a slash, but it can also be path
-# relative to the site directory.
-output_dir: output
-
-# A list of index filenames, i.e. names of files that will be served by a web
-# server when a directory is requested. Usually, index files are named
-# “index.hml”, but depending on the web server, this may be something else,
-# such as “default.htm”. This list is used by nanoc to generate pretty URLs.
-index_filenames: [ 'index.html' ]
-
-# Whether or not to generate a diff of the compiled content when compiling a
-# site. The diff will contain the differences between the compiled content
-# before and after the last site compilation.
-enable_output_diff: false
-
-# The data sources where nanoc loads its data from. This is an array of
-# hashes; each array element represents a single data source. By default,
-# there is only a single data source that reads data from the “content/” and
-# “layout/” directories in the site directory.
-data_sources:
- -
- # The type is the identifier of the data source. By default, this will be
- # `filesystem_unified`.
- type: filesystem_unified
-
- # The path where items should be mounted (comparable to mount points in
- # Unix-like systems). This is “/” by default, meaning that items will have
- # “/” prefixed to their identifiers. If the items root were “/en/”
- # instead, an item at content/about.html would have an identifier of
- # “/en/about/” instead of just “/about/”.
- items_root: /
-
- # The path where layouts should be mounted. The layouts root behaves the
- # same as the items root, but applies to layouts rather than items.
- layouts_root: /
-
- -
- type: static
- items_root: /static
diff --git a/content/404.html b/content/404.html
new file mode 100644
index 0000000000..77bc3992f1
--- /dev/null
+++ b/content/404.html
@@ -0,0 +1,7 @@
+---
+title: GitHub Help • Article not found!
+exclude_from_search: true
+---
+
+
diff --git a/content/changes.atom b/content/changes.atom
new file mode 100644
index 0000000000..e80eaefb66
--- /dev/null
+++ b/content/changes.atom
@@ -0,0 +1,8 @@
+---
+title: GitHub API Changes
+is_hidden: true
+author_name: technoweenie
+author_uri: https://github.com/technoweenie
+layout: false
+---
+<%= atom_feed :limit => 30, :articles => api_changes %>
diff --git a/content/changes/2012-09-05-watcher-api.html b/content/changes/2012-09-05-watcher-api.html
new file mode 100644
index 0000000000..fd151bdc3c
--- /dev/null
+++ b/content/changes/2012-09-05-watcher-api.html
@@ -0,0 +1,123 @@
+---
+title: Upcoming Changes to Watcher and Star APIs
+author_name: technoweenie
+---
+
+We recently [changed the Watcher behavior][change-watching] on GitHub. What
+used to be known as "Watching" is now "Starring". Starring is basically a way
+to bookmark interesting repositories. Watching is a way to indicate that you
+want to receive email or web notifications on a Repository.
+
+[change-watching]: https://github.com/blog/1204-notifications-stars
+
+This works well on GitHub.com, but poses a problem for the GitHub API. How do
+we change this in a way that developers can gracefully upgrade their
+applications? We're currently looking at rolling out the changes in three
+phases over an extended period of time.
+
+## Current Status
+
+The current [Repository Starring][starring-api] methods look like this:
+
+* `/repos/:owner/:repo/watchers` - A list of users starring the repository.
+* `/users/:user/watched` - A list of repositories that a user has starred.
+* `/user/watched` - A list of repositories the current user has starred.
+
+[starring-api]: /v3/activity/starring/
+
+## Phase 1: Add Watchers as Subscriptions
+
+This phase exposes Watchers as "Subscriptions". This is to
+keep from clashing with the legacy endpoints. This phase will happen
+automatically Whoops, looks like that page doesn't exist.
+
+
+
+## + API v3 will continue to officially support the functionality described in + Phase 1 above. This functionality will remain intact for the lifetime of + API v3. +
++ API v3 will not include Phases 2 and 3 (below). Those phases will + likely be part of the next major version of the API. (We have not announced + a timeline for the next major version of the API.) +
+/watchers API Endpoint/user/starred to get a user's starred repositories, not
+/user/watched.application/vnd.github.v3+json
+# Accesses a user's watched repositories. +curl https://api.github.com/user/watched \ + -H "Accept: application/vnd.github.v3+json" ++
/subscribers API Endpoint.
+ <%= renderp '/includes/pagination_bar.html', :current_page => 1, :total_pages => total_pages %>
+
diff --git a/content/guides/automating-deployments-to-integrators.md b/content/guides/automating-deployments-to-integrators.md
new file mode 100644
index 0000000000..c5b7628c63
--- /dev/null
+++ b/content/guides/automating-deployments-to-integrators.md
@@ -0,0 +1,74 @@
+---
+title: Automating deployments to integrators
+---
+
+# Automating deployments to integrators
+
+{:toc}
+
+The "[Delivering deployments](/guides/delivering-deployments/)" guide describes how to build a server that uses the [Deployments API][deploy API] to easily get your code from GitHub into production. But what if you don't want to host a separate service for deploying code? What if you just want to merge code and have it deploy without thinking about maintaining another app?
+
+You can use the GitHub Auto-Deployment service to receive changes made to your repository and configure it to deliver a deployment to integrators. The Auto-Deployment service can deliver payloads based on two events: whenever a push is made and whenever [the CI status is passing](/guides/building-a-ci-server/).
+
+Here's a diagram demonstrating what the process might look like:
+
+```
++--------------------+ +--------+ +-----------+
+| GitHub Auto-Deploy | | GitHub | | Heroku |
+| Service | +--------+ +-----------+
++--------------------+ | |
+ | | |
+ | Create Deployment | |
+ |------------------------>| |
+ | | |
+ | | |
+ | | Deployment Event |
+ | |--------------------------------->|
+ | | |
+ | | Deployment Status (pending) |
+ | |<---------------------------------|
+ | | |
+ | | |
+ | | Deployment Status (success) |
+ | |<---------------------------------|
+ | | |
+```
+
+{{#tip}}
+
+Note that the Auto-Deployment service only picks up changes from your default branch, which is usually `master`.
+
+{{/tip}}
+
+## Sending deployments whenever you push to a repository
+
+The Auto-Deployment service will be responsible for creating deployments when a push is made to your default branch. Next, we'll set up a service to receive those deployment events and handle the deployment of your project.
+
+1. Navigate to the repository where you’re setting up your deployments.
+2. In your repository's right sidebar, click .
+3. On the left, click **Webhooks & Services**.
+
+4. Click **Add service**, then type "GitHub Auto-Deployment." 
+5. Under **GitHub token**, paste an access token you've created. It must have at least the `repo` scope. For more information, see "[Creating an access token for command-line use](https://help.github.com/articles/creating-an-access-token-for-command-line-use)."
+6. Under **Environments**, optionally provide a list of environments you'd like to send your deployments to. This can be [any string you define](https://developer.github.com/v3/repos/deployments/#parameters) to describe your environment. The default is "production."
+7. If you *only* want builds that successfully passed a continuous test suite, select **Deploy on status**.
+8. If you're running this service on GitHub Enterprise, you must pass in your appliance's [endpoint URL](https://developer.github.com/v3/enterprise/#endpoint-urls).
+9. Click **Add service**.
+
+## Hooking up an integrator to deployments
+
+To implement our deployments, we'll use Heroku as an example service.
+
+1. Navigate to the repository where you’re setting up your deployments.
+2. In your repository's right sidebar, click .
+3. On the left, click **Webhooks & Services**.
+
+4. Click **Add service**, then type "Heroku." 
+5. Type the name of the Heroku application your GitHub repository should deploy to.
+6. Enter in your [Heroku OAuth token](https://devcenter.heroku.com/articles/oauth#direct-authorization). You must generate this yourself following the instructions in Heroku's documentation.
+7. Under **GitHub token**, paste the same token you provided earlier.
+8. Click **Add service**.
+
+From now on, any commits made to your `master` branch--including those generated from merging pull requests--will automatically trigger a deployment to your Heroku application.
+
+[deploy API]: /v3/repos/deployments/
diff --git a/content/guides/basics-of-authentication.md b/content/guides/basics-of-authentication.md
new file mode 100644
index 0000000000..f67f9e8f0e
--- /dev/null
+++ b/content/guides/basics-of-authentication.md
@@ -0,0 +1,369 @@
+---
+title: Basics of Authentication
+---
+
+# Basics of Authentication
+
+{:toc}
+
+In this section, we're going to focus on the basics of authentication. Specifically,
+we're going to create a Ruby server (using [Sinatra][Sinatra]) that implements
+the [web flow][webflow] of an application in several different ways.
+
+{{#tip}}
+
+You can download the complete source code for this project [from the platform-samples repo](https://github.com/github/platform-samples/tree/master/api/).
+
+{{/tip}}
+
+## Registering your app
+
+First, you'll need to [register your application][new oauth app]. Every
+registered OAuth application is assigned a unique Client ID and Client Secret.
+The Client Secret should not be shared! That includes checking the string
+into your repository.
+
+You can fill out every piece of information however you like, except the
+**Authorization callback URL**. This is easily the most important piece to setting
+up your application. It's the callback URL that {{ site.data.variables.product.product_name }} returns the user to after
+successful authentication.
+
+Since we're running a regular Sinatra server, the location of the local instance
+is set to `http://localhost:4567`. Let's fill in the callback URL as `http://localhost:4567/callback`.
+
+## Accepting user authorization
+
+Now, let's start filling out our simple server. Create a file called _server.rb_ and paste this into it:
+
+``` ruby
+require 'sinatra'
+require 'rest-client'
+require 'json'
+
+CLIENT_ID = ENV['GH_BASIC_CLIENT_ID']
+CLIENT_SECRET = ENV['GH_BASIC_SECRET_ID']
+
+get '/' do
+ erb :index, :locals => {:client_id => CLIENT_ID}
+end
+```
+
+Your client ID and client secret keys come from [your application's configuration
+page][app settings]. You should **never, _ever_** store these values in
+{{ site.data.variables.product.product_name }}--or any other public place, for that matter. We recommend storing them as
+[environment variables][about env vars]--which is exactly what we've done here.
+
+Next, in _views/index.erb_, paste this content:
+
+``` erb
+
+
+
+
+ + Well, hello there! +
++ We're going to now talk to the GitHub API. Ready? + Click here to begin! +
++ If that link doesn't work, remember to provide your own Client ID! +
+ + +``` + +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra guide].) + +Also, notice that the URL uses the `scope` query parameter to define the +[scopes][oauth scopes] requested by the application. For our application, we're +requesting `user:email` scope for reading private email addresses. + +Navigate your browser to `http://localhost:4567`. After clicking on the link, you +should be taken to {{ site.data.variables.product.product_name }}, and presented with a dialog that looks something like this: + + +If you trust yourself, click **Authorize App**. Wuh-oh! Sinatra spits out a +`404` error. What gives?! + +Well, remember when we specified a Callback URL to be `callback`? We didn't provide +a route for it, so {{ site.data.variables.product.product_name }} doesn't know where to drop the user after they authorize +the app. Let's fix that now! + +### Providing a callback + +In _server.rb_, add a route to specify what the callback should do: + +``` ruby +get '/callback' do + # get temporary GitHub code... + session_code = request.env['rack.request.query_hash']['code'] + + # ... and POST it back to GitHub + result = RestClient.post('https://github.com/login/oauth/access_token', + {:client_id => CLIENT_ID, + :client_secret => CLIENT_SECRET, + :code => session_code}, + :accept => :json) + + # extract the token and granted scopes + access_token = JSON.parse(result)['access_token'] +end +``` + +After a successful app authentication, {{ site.data.variables.product.product_name }} provides a temporary `code` value. +You'll need to `POST` this code back to {{ site.data.variables.product.product_name }} in exchange for an `access_token`. +To simplify our GET and POST HTTP requests, we're using the [rest-client][REST Client]. +Note that you'll probably never access the API through REST. For a more serious +application, you should probably use [a library written in the language of your choice][libraries]. + +### Checking granted scopes + +In the future, users will be able to [edit the scopes you requested][edit scopes post], +and your application might be granted less access than you originally asked for. +So, before making any requests with the token, you should check the scopes that +were granted for the token by the user. + +The scopes that were granted are returned as a part of the response from +exchanging a token. + +``` ruby +get '/callback' do + # ... + # Get the access_token using the code sample above + # ... + + # check if we were granted user:email scope + scopes = JSON.parse(result)['scope'].split(',') + has_user_email_scope = scopes.include? 'user:email' +end +``` + +In our application, we're using `scopes.include?` to check if we were granted +the `user:email` scope needed for fetching the authenticated user's private +email addresses. Had the application asked for other scopes, we would have +checked for those as well. + +Also, since there's a hierarchical relationship between scopes, you should +check that you were granted the lowest level of required scopes. For example, +if the application had asked for `user` scope, it might have been granted only +`user:email` scope. In that case, the application wouldn't have been granted +what it asked for, but the granted scopes would have still been sufficient. + +Checking for scopes only before making requests is not enough since it's possible +that users will change the scopes in between your check and the actual request. +In case that happens, API calls you expected to succeed might fail with a `404` +or `401` status, or return a different subset of information. + +To help you gracefully handle these situations, all API responses for requests +made with valid tokens also contain an [`X-OAuth-Scopes` header][oauth scopes]. +This header contains the list of scopes of the token that was used to make the +request. In addition to that, the Authorization API provides an endpoint to +[check a token for validity][check token valid]. +Use this information to detect changes in token scopes, and inform your users of +changes in available application functionality. + +### Making authenticated requests + +At last, with this access token, you'll be able to make authenticated requests as +the logged in user: + +``` ruby +# fetch user information +auth_result = JSON.parse(RestClient.get('https://api.github.com/user', + {:params => {:access_token => access_token}})) + +# if the user authorized it, fetch private emails +if has_user_email_scope + auth_result['private_emails'] = + JSON.parse(RestClient.get('https://api.github.com/user/emails', + {:params => {:access_token => access_token}})) +end + +erb :basic, :locals => auth_result +``` + +We can do whatever we want with our results. In this case, we'll just dump them straight into _basic.erb_: + +``` erb +Hello, <%= login %>!
++ <% if !email.nil? && !email.empty? %> It looks like your public email address is <%= email %>. + <% else %> It looks like you don't have a public email. That's cool. + <% end %> +
++ <% if defined? private_emails %> + With your permission, we were also able to dig up your private email addresses: + <%= private_emails.map{ |private_email_address| private_email_address["email"] }.join(', ') %> + <% else %> + Also, you're a bit secretive about your private email addresses. + <% end %> +
+``` + +## Implementing "persistent" authentication + +It'd be a pretty bad model if we required users to log into the app every single +time they needed to access the web page. For example, try navigating directly to +`http://localhost:4567/basic`. You'll get an error. + +What if we could circumvent the entire +"click here" process, and just _remember_ that, as long as the user's logged into +{{ site.data.variables.product.product_name }}, they should be able to access this application? Hold on to your hat, +because _that's exactly what we're going to do_. + +Our little server above is rather simple. In order to wedge in some intelligent +authentication, we're going to switch over to using sessions for storing tokens. +This will make authentication transparent to the user. + +Also, since we're persisting scopes within the session, we'll need to +handle cases when the user updates the scopes after we checked them, or revokes +the token. To do that, we'll use a `rescue` block and check that the first API +call succeeded, which verifies that the token is still valid. After that, we'll +check the `X-OAuth-Scopes` response header to verify that the user hasn't revoked +the `user:email` scope. + +Create a file called _advanced_server.rb_, and paste these lines into it: + +``` ruby +require 'sinatra' +require 'rest_client' +require 'json' + +# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! +# Instead, set and test environment variables, like below +# if ENV['GITHUB_CLIENT_ID'] && ENV['GITHUB_CLIENT_SECRET'] +# CLIENT_ID = ENV['GITHUB_CLIENT_ID'] +# CLIENT_SECRET = ENV['GITHUB_CLIENT_SECRET'] +# end + +CLIENT_ID = ENV['GH_BASIC_CLIENT_ID'] +CLIENT_SECRET = ENV['GH_BASIC_SECRET_ID'] + +use Rack::Session::Pool, :cookie_only => false + +def authenticated? + session[:access_token] +end + +def authenticate! + erb :index, :locals => {:client_id => CLIENT_ID} +end + +get '/' do + if !authenticated? + authenticate! + else + access_token = session[:access_token] + scopes = [] + + begin + auth_result = RestClient.get('https://api.github.com/user', + {:params => {:access_token => access_token}, + :accept => :json}) + rescue => e + # request didn't succeed because the token was revoked so we + # invalidate the token stored in the session and render the + # index page so that the user can start the OAuth flow again + + session[:access_token] = nil + return authenticate! + end + + # the request succeeded, so we check the list of current scopes + if auth_result.headers.include? :x_oauth_scopes + scopes = auth_result.headers[:x_oauth_scopes].split(', ') + end + + auth_result = JSON.parse(auth_result) + + if scopes.include? 'user:email' + auth_result['private_emails'] = + JSON.parse(RestClient.get('https://api.github.com/user/emails', + {:params => {:access_token => access_token}, + :accept => :json})) + end + + erb :advanced, :locals => auth_result + end +end + +get '/callback' do + session_code = request.env['rack.request.query_hash']['code'] + + result = RestClient.post('https://github.com/login/oauth/access_token', + {:client_id => CLIENT_ID, + :client_secret => CLIENT_SECRET, + :code => session_code}, + :accept => :json) + + session[:access_token] = JSON.parse(result)['access_token'] + + redirect '/' +end +``` + +Much of the code should look familiar. For example, we're still using `RestClient.get` +to call out to the {{ site.data.variables.product.product_name }} API, and we're still passing our results to be rendered +in an ERB template (this time, it's called `advanced.erb`). + +Also, we now have the `authenticated?` method which checks if the user is already +authenticated. If not, the `authenticate!` method is called, which performs the +OAuth flow and updates the session with the granted token and scopes. + +Next, create a file in _views_ called _advanced.erb_, and paste this markup into it: + +``` erb + + + + +Well, well, well, <%= login %>!
++ <% if !email.empty? %> It looks like your public email address is <%= email %>. + <% else %> It looks like you don't have a public email. That's cool. + <% end %> +
++ <% if defined? private_emails %> + With your permission, we were also able to dig up your private email addresses: + <%= private_emails.map{ |private_email_address| private_email_address["email"] }.join(', ') %> + <% else %> + Also, you're a bit secretive about your private email addresses. + <% end %> +
+ + +``` + +From the command line, call `ruby advanced_server.rb`, which starts up your +server on port `4567` -- the same port we used when we had a simple Sinatra app. +When you navigate to `http://localhost:4567`, the app calls `authenticate!` +which redirects you to `/callback`. `/callback` then sends us back to `/`, +and since we've been authenticated, renders _advanced.erb_. + +We could completely simplify this roundtrip routing by simply changing our callback +URL in {{ site.data.variables.product.product_name }} to `/`. But, since both _server.rb_ and _advanced.rb_ are relying on +the same callback URL, we've got to do a little bit of wonkiness to make it work. + +Also, if we had never authorized this application to access our {{ site.data.variables.product.product_name }} data, +we would've seen the same confirmation dialog from earlier pop-up and warn us. + +If you'd like, you can play around with [yet another Sinatra-GitHub auth example][sinatra auth github test] +available as a separate project. + +[webflow]: /v3/oauth/#web-application-flow +[Sinatra]: http://www.sinatrarb.com/ +[about env vars]: http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables +[Sinatra guide]: https://github.com/sinatra/sinatra-book/blob/master/book/Introduction.markdown#hello-world-application +[REST Client]: https://github.com/archiloque/rest-client +[libraries]: /libraries/ +[sinatra auth github test]: https://github.com/atmos/sinatra-auth-github-test +[oauth scopes]: /v3/oauth/#scopes +[edit scopes post]: /changes/2013-10-04-oauth-changes-coming/ +[check token valid]: /v3/oauth_authorizations/#check-an-authorization +[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/basics-of-authentication +[new oauth app]: https://github.com/settings/applications/new +[app settings]: https://github.com/settings/developers diff --git a/content/guides/best-practices-for-integrators.md b/content/guides/best-practices-for-integrators.md new file mode 100644 index 0000000000..f0cd17c9b4 --- /dev/null +++ b/content/guides/best-practices-for-integrators.md @@ -0,0 +1,162 @@ +--- +title: Best practices for integrators +--- + +# Best practices for integrators + +Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API. + +{:toc} + +## Secure payloads delivered from GitHub + +It's very important that you secure [the payloads sent from GitHub][event-types]. Although no personal information (like passwords) is ever transmitted in a payload, leaking *any* information is not good. Some information that might be sensitive include committer email address or the names of private repositories. + +There are three steps you can take to secure receipt of payloads delivered by GitHub: + +1. Ensure that your receiving server is on an HTTPS connection. By default, GitHub will verify SSL certificates when delivering payloads. +2. You can whitelist [the IP address we use when delivering hooks](https://help.github.com/articles/what-ip-addresses-does-github-use-that-i-should-whitelist) to your server. To ensure that you're always checking the right IP address, you can [use the `/meta` endpoint](/v3/meta/#meta) to find the address we use. +3. Provide [a secret token](/webhooks/securing/) to ensure payloads are definitely coming from GitHub. By enforcing a secret token, you're ensuring that any data received by your server is absolutely coming from GitHub. Ideally, you should provide a different secret token *per user* of your service. That way, if one token is compromised, no other user would be affected. + +## Favor asynchronous work over synchronous + +GitHub expects that integrations respond within thirty seconds of receiving the webhook payload. If your service takes longer than that to complete, then GitHub terminates the connection and the payload is lost. + +Since it's impossible to predict how fast your service will complete, you should do all of "the real work" in a background job. [Resque](https://github.com/resque/resque/) (for Ruby), [RQ](http://python-rq.org/) (for Python), or [RabbitMQ](http://www.rabbitmq.com/) (for Java) are examples of libraries that can handle queuing and processing of background jobs. + +Note that even with a background job running, GitHub still expects your server to respond within thirty seconds. Your server simply needs to acknowledge that it received the payload by sending some sort of response. It's critical that your service to performs any validations on a payload as soon as possible, so that you can accurately report whether your server will continue with the request or not. + +## Use appropriate HTTP status codes when responding to GitHub + +Every webhook has its own "Recent Deliveries" section, which lists whether a deployment was successful or not. + + + +You should make use of proper HTTP status codes in order to inform users. You can use codes like `201` or `202` to acknowledge receipt of payload that won't be processed (for example, a payload delivered by a branch that's not the default). Reserve the `500` error code for catastrophic failures. + +## Provide as much information as possible to the user + +Users can dig into the server responses you send back to GitHub. Ensure that your messages are clear and informative. + + + +## Follow any redirects that the API sends you + +GitHub is explicit in telling you when a resource has moved by providing a redirect status code. You should follow these redirections. Every redirect response sets the `Location` header with the new URI to go to. If you receive a redirect, it's best to update your code to follow the new URI, in case you're requesting a deprecated path that we might remove. + +We've provided [a list of HTTP status codes](/v3/#http-redirects) to watch out for when designing your app to follow redirects. + +## Don't manually parse URLs + +Often, API responses contain data in the form of URLs. For example, when requesting a repository, we'll send a key called `clone_url` with a URL you can use to clone the repository. + +For the stability of your app, you shouldn't try to parse this data or try to guess and construct the format of future URLs. Your app is liable to break if we decide to change the URL. + +For example, when working with paginated results, it's often tempting to construct URLs that append `?page=Check this sweet data out:
+ + + + + +``` + +Phew! Again, don't worry about what most of this code is doing. The relevant part +here is a line way at the top--`var data = <%= languages %>;`--which indicates +that we're passing our previously created `languages` array into ERB for manipulation. + +As the "D3 for Mortals" guide suggests, this isn't necessarily the best use of +D3. But it does serve to illustrate how you can use the library, along with Octokit, +to make some really amazing things. + +## Combining different API calls + +Now it's time for a confession: the `language` attribute within repositories +only identifies the "primary" language defined. That means that if you have +a repository that combines several languages, the one with the most bytes of code +is considered to be the primary language. + +Let's combine a few API calls to get a _true_ representation of which language +has the greatest number of bytes written across all our code. A [treemap][D3 treemap] +should be a great way to visualize the sizes of our coding languages used, rather +than simply the count. We'll need to construct an array of objects that looks +something like this: + +``` json +[ { "name": "language1", "size": 100}, + { "name": "language2", "size": 23} + ... +] +``` + +Since we already have a list of repositories above, let's inspect each one, and +call [the language listing API method][language API]: + +``` ruby +repos.each do |repo| + repo_name = repo.name + repo_langs = octokit_client.languages("#{github_user.login}/#{repo_name}") +end +``` + +From there, we'll cumulatively add each language found to a "master list": + +``` ruby +repo_langs.each do |lang, count| + if !language_obj[lang] + language_obj[lang] = count + else + language_obj[lang] += count + end +end +``` + +After that, we'll format the contents into a structure that D3 understands: + +``` ruby +language_obj.each do |lang, count| + language_byte_count.push :name => "#{lang} (#{count})", :count => count +end + +# some mandatory formatting for D3 +language_bytes = [ :name => "language_bytes", :elements => language_byte_count] +``` + +(For more information on D3 tree map magic, check out [this simple tutorial][language API].) + +To wrap up, we pass this JSON information over to the same ERB template: + +``` ruby +erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_count => language_bytes.to_json} +``` + +Like before, here's a bunch of JavaScript that you can drop +directly into your template: + +``` html + + +``` + +Et voila! Beautiful rectangles containing your repo languages, with relative +proportions that are easy to see at a glance. You might need to +tweak the height and width of your treemap, passed as the first two +arguments to `drawTreemap` above, to get all the information to show up properly. + + +[D3.js]: http://d3js.org/ +[basics-of-authentication]: ../basics-of-authentication/ +[sinatra auth github]: https://github.com/atmos/sinatra_auth_github +[Octokit]: https://github.com/octokit/octokit.rb +[D3 mortals]: http://www.recursion.org/d3-for-mere-mortals/ +[D3 treemap]: http://bl.ocks.org/mbostock/4063582 +[language API]: https://developer.github.com/v3/repos/#list-languages +[simple tree map]: http://2kittymafiasoftware.blogspot.com/2011/09/simple-treemap-visualization-with-d3.html +[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/rendering-data-as-graphs +[new oauth application]: https://github.com/settings/applications/new diff --git a/content/guides/traversing-with-pagination.md b/content/guides/traversing-with-pagination.md new file mode 100644 index 0000000000..ff4d11cf0b --- /dev/null +++ b/content/guides/traversing-with-pagination.md @@ -0,0 +1,259 @@ +--- +title: Traversing with Pagination +--- + +# Traversing with Pagination + +{:toc} + +The {{ site.data.variables.product.product_name }} API provides a vast wealth of information for developers to consume. +Most of the time, you might even find that you're asking for _too much_ information, +and in order to keep our servers happy, the API will automatically [paginate the requested items][pagination]. + +In this guide, we'll make some calls to the {{ site.data.variables.product.product_name }} Search API, and iterate over +the results using pagination. You can find the complete source code for this project +in the [platform-samples][platform samples] repository. + +## Basics of Pagination + +To start with, it's important to know a few facts about receiving paginated items: + +1. Different API calls respond with different defaults. For example, a call to +[list GitHub's public repositories](https://developer.github.com/v3/repos/#list-all-public-repositories) +provides paginated items in sets of 30, whereas a call to the GitHub Search API +provides items in sets of 100 +2. You can specify how many items to receive (up to a maximum of 100); but, +3. For technical reasons, not every endpoint behaves the same. For example, +[events](https://developer.github.com/v3/activity/events/) won't let you set a maximum for items to receive. +Be sure to read the documentation on how to handle paginated results for specific endpoints. + +Information about pagination is provided in [the Link header](http://tools.ietf.org/html/rfc5988) +of an API call. For example, let's make a curl request to the search API, to find +out how many times Mozilla projects use the phrase `addClass`: + +``` command-line +$ curl -I "{{ site.data.variables.product.api_url_pre }}/search/code?q=addClass+user:mozilla" +``` + +The `-I` parameter indicates that we only care about the headers, not the actual +content. In examining the result, you'll notice some information in the Link header +that looks like this: + + Link:
+
+ Leverage the power of
+ 
+
+
+
+ Leverage the power of
+ GitHub in your app.
+
+ Get started with one of our guides, or jump straight into the API documentation.
+ Browse the documentation +
+
+
+
+
+
+Join the GitHub Developer Program.
+The best way to integrate with GitHub. Learn more.
+
+
diff --git a/content/integrations-directory/getting-listed.md b/content/integrations-directory/getting-listed.md
new file mode 100644
index 0000000000..7a96f11057
--- /dev/null
+++ b/content/integrations-directory/getting-listed.md
@@ -0,0 +1,86 @@
+---
+title: Getting listed in the Integrations Directory
+---
+
+# Getting your integration listed
+
+{:toc}
+
+## Listing requirements
+
+### Provide the right contacts
+
+We want to be sure GitHub can contact your team, if needed. Specifically, we're asking for:
+
+* A technical support contact
+* A security contact
+* An escalation contact
+
+All three are for GitHub-use only. If there's an urgent issue that needs your attention, we'll contact your escalation contact and expect a response within one business day. A delayed response from your escalation contact may result in temporary or permanent de-listing of your integration from the directory.
+
+### Provide standard links
+
+We'd like to have a minimum set of links to include in every integration listing, so that our users have all the information they need. These are:
+
+- Pricing - If your integration costs money or has differed priced tiers of service, please include this URL.
+- Documentation - Please provide a URL with more information on how to use your integration.
+- Terms of service - Please provide the Terms of Service URL for users using your integration.
+- Privacy Policy - If different than Terms of Service, please include the URL here.
+- Support - Please provide a URL or email address for users to contact you directly.
+- Status - You should provide us a URL that will be updated when your application is down or experiencing problems. This could be a status site, a blog, a Twitter account, or more. This URL should be publicly accessible.
+- Installation - Provide the URL for direct installation for users. Note the OAuth requirement below.
+
+### Provide updates to your listing
+
+We want GitHub users to have consistent messaging within the Integrations Directory and your
+marketing site. As your product changes, keep your Integration Directory listing up to date. We ask that you refresh the information at least once a year. Please send updates to [partnerships@github.com](mailto:partnerships@github.com).
+
+### Provide categories for your listing
+
+Help GitHub users find your integration faster with the appropriate categories. Please send us your suggested categories for the listing from those available in the [Integrations Directory](https://github.com/integrations). If you don't see a category that fits quite right, just let us know. We reserve the right to change categories associated with the listing. If we do so, we'll do our best to keep you informed.
+
+If your integration supports both GitHub.com and GitHub Enterprise, please let us know.
+
+## Technical requirements
+
+### Use TLS
+
+Anytime you display GitHub data in your integration, use TLS. If you also use [webhooks](https://developer.github.com/webhooks/) to receive updated data from GitHub, use SSL/TLS there too.
+
+### Delete GitHub data once you lose access to the information
+
+Once you realize you've lost access to a user, organization, repository, or its related objects,
+delete that information in your system within 60 days.
+
+## Choose your type of listing
+
+We offer two types of listings: OAuth installation listings and "learn more" listings.
+
+### OAuth installation listing
+
+{{#tip}}
+
+This is our preferred type of listing wherever possible.
+
+{{/tip}}
+
+The OAuth installation listings are used so customers can immediately install your integration directly
+within GitHub's UI. To use this type of listing, provide a URL that will immediately redirect to
+GitHub's OAuth authorization flow.
+
+We are happy to help you identify if your integration can already support this. If you'd like a direct installation from the Integrations Directory, your provided installation URL should always forward the user immediately to an OAuth authorization screen. You should never add interstitial pages within that flow.
+
+### "Learn more" listing
+
+The "learn more" listing is used when a user cannot use GitHub OAuth to sign up for an account within
+your integration. You will provide a URL that will link a "learn more" button within your
+listing to your website. This type of listing is *only used when OAuth is not available before
+account creation*.
+
+## Send us your information
+
+In addition to this checklist, please follow the [Marketing Guidelines](/integrations-directory/marketing-guidelines/) as well. The best format for delivery is Markdown (.md) or plain text (.txt).
+
+Please attach images at the proper resolution. We aren't able to extract photos from PDFs or Word docs.
+
+Once you're ready, just send the materials over email to [partnerships@github.com](mailto:partnerships@github.com). Thanks! We're looking forward to reviewing your listing.
diff --git a/content/integrations-directory/index.md b/content/integrations-directory/index.md
new file mode 100644
index 0000000000..04385850e7
--- /dev/null
+++ b/content/integrations-directory/index.md
@@ -0,0 +1,10 @@
+---
+title: Integrations Directory
+layout: /integrations-directory.*
+---
+
+# Overview
+
+As one of our integrators, we're excited to tell the world about your GitHub integration at [https://github.com/integrations](https://github.com/integrations). To ensure the GitHub community has the best experience finding and using your integrations, we've outlined a [short list of requirements](/integrations-directory/getting-listed/) to follow.
+
+We're happy to chat about these if you have any questions. Feel free to reach out to [partnerships@github.com](mailto:partnerships@github.com) for additional detail.
diff --git a/content/integrations-directory/marketing-guidelines.md b/content/integrations-directory/marketing-guidelines.md
new file mode 100644
index 0000000000..cc713af89b
--- /dev/null
+++ b/content/integrations-directory/marketing-guidelines.md
@@ -0,0 +1,74 @@
+---
+title: Integrations Directory marketing guidelines
+---
+
+# Marketing guidelines
+
+{:toc}
+
+This document will help you write compelling and well-structured marketing materials to help GitHub users understand the value of your integration. The sections below outline the document structure for integration pages.
+
+## One line blurb
+
+This is a short sentence (70 characters max), that'll show up right below your logo. It can be used for a tagline or quick summary of the integration.
+
+## Description
+
+Write a single paragraph that describes your integration clearly and speaks directly to the audience (think “you” and “your” over “we” and “our”). Answer the following questions in your description:
+
+- What does it do?
+- How does it integrate with GitHub?
+- How does it empower developers?
+
+Keep this section short and sweet.
+
+**Example**
+
+> Sample CI helps you deploy your code with confidence by continuously running your test suite. Avoid bugs and avert deployment disasters by catching bugs before they reach your users. Sample CI can update the build status on your pull requests as they progress and can deploy successful builds to production automatically.
+
+## Images
+
+Images are optional. Well curated images will help people get a sense for how your integration works with GitHub. Use multiple images as an opportunity to tell a story about your integration's workflow.
+
+### Image guidelines
+- Images should show your product in action
+- When possible, show how your product integrates with GitHub
+- Use no more than four images
+- Images must be 1290x728 pixels (will appear as 645x364 pixels)
+
+## Features
+
+List some features to give people a better sense of what your integration offers. An ideal number is between three and six—pick the great ones.
+
+### Feature guidelines
+- Each feature should have a heading.
+- Does the feature have a name? What is it?
+- What does the feature do?
+- How does it help people build better software?
+- Does it interact with any external services (e.g., can deploy to Heroku, Engine Yard Cloud, etc.)?
+- Does your feature require any setup?
+
+**Example**
+
+> **Deploy anywhere, with confidence**
+
+> Deploying to production after a successful build is as easy as setting up a bit of configuration, and we’ll deploy your code to Heroku, Engine Yard Cloud, Nodejitsu, cloudControl, OpenShift, CloudFoundry, AppFog, and Amazon OpsWorks.
+
+> Using a custom deployment? Customize the build to deploy to your servers!
+
+## General tips
+- Do not use `H1` level headings.
+- Use `H3` for section headings, `H4` for subsections.
+- Avoid italics. Use bold for emphasis instead.
+- Use sentence case for titles.
+- Do not write in all caps to provide emphasis.
+- Write in [GitHub Flavored markdown](https://help.github.com/articles/github-flavored-markdown/).
+
+## Logo
+- Provide your integration logo as a 128x128 pixel PNG.
+- Negative space must be transparent.
+- Do not stretch or squish your logo to fill the space.
+- You'll need to attach this logo to your GitHub Application, before the listing is published.
+
+## Samples
+Feel free to look at existing listings in the Integrations Directory, such as [Gitter](https://github.com/integrations/gitter) or [ZenHub](https://github.com/integrations/zenhub).
diff --git a/content/libraries.md b/content/libraries.md
new file mode 100644
index 0000000000..2958416746
--- /dev/null
+++ b/content/libraries.md
@@ -0,0 +1,199 @@
+---
+title: Libraries
+layout: libraries
+---
+
+-
+
-
+
+
Get Started
+New to the GitHub API? With these guides you’ll be up and running in a snap.
+
+ -
+
+
Libraries
+We’ve got you covered. Use the GitHub API in your favorite language.
+
+ -
+
+
Support
+Are you stuck? Already tried our troubleshooting guide? Talk to a supportocat.
+
+
+ Octokit comes in
+ 
+
+
+# Third-party libraries
+
+## Android
+
+* [GithubAndroidSDK][githubandroidsdk]
+
+[githubandroidsdk]: https://github.com/gitskarios/GithubAndroidSdk
+
+## .NET
+
+* [IronGithub][irongithub]
+* [CSharp GitHub API][csharp]
+* [FSharp.GitHubApi][fsharp]
+
+[irongithub]: https://github.com/in2bits/IronGitHub
+[csharp]: https://github.com/sgrassie/csharp-github-api
+[fsharp]: https://github.com/saxonmatt/FSharp.GitHubApi
+
+## Clojure
+
+* [Tentacles][tentacles]
+
+[tentacles]: https://github.com/Raynes/tentacles
+
+## Dart
+
+* [github.dart][github.dart]
+
+[github.dart]: https://github.com/DirectMyFile/github.dart
+
+## Emacs Lisp
+
+* [gh.el][gh.el]
+
+[gh.el]: https://github.com/sigma/gh.el
+
+## Erlang
+
+* [Erlang GitHub API][erlang]
+* [octo.erl][octo-erl]
+
+[erlang]: https://github.com/onlyshk/erlang-github-api
+[octo-erl]: https://github.com/sdepold/octo.erl
+
+## Go
+
+* [go-github][]
+
+[go-github]: https://github.com/google/go-github
+
+## Haskell
+
+* [github][haskell-github]
+* [Haskell GitHub API][haskell]
+
+[haskell-github]: https://github.com/fpco/GitHub
+[haskell]: https://github.com/dmnpignaud/haskell-github-api
+
+## Java
+
+* The [GitHub Java API (org.eclipse.egit.github.core)](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) library
+is part of the [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) and aims to support the entire
+GitHub v3 API. Builds are available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22).
+* [GitHub API for Java (org.kohsuke.github)](http://github-api.kohsuke.org/) defines an object oriented representation of the GitHub API.
+* [JCabi GitHub API](http://github.jcabi.com) is based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and
+covers the entire API.
+
+## JavaScript
+
+* [Node-GitHub][mikedeboer-node-github]
+* [NodeJS GitHub library][octonode]
+* [gh3 client-side API v3 wrapper][gh3]
+* [GitHub.js wrapper around the GitHub API][github]
+* [Promise-Based CoffeeScript library for the browser or NodeJS][github-client]
+
+[mikedeboer-node-github]: https://github.com/mikedeboer/node-github
+[octonode]: https://github.com/pksunkara/octonode
+[gh3]: https://github.com/k33g/gh3
+[github]: https://github.com/michael/github
+[github-client]: https://github.com/philschatz/github-client
+
+## Julia
+
+* [GitHub.jl][github.jl]
+
+[github.jl]: https://github.com/WestleyArgentum/GitHub.jl
+
+## Objective-C
+
+* [UAGithubEngine][uagithubengine]
+
+[uagithubengine]: http://github.com/owainhunt/uagithubengine
+
+## OCaml
+
+* [ocaml-github][ocaml-github]
+
+[ocaml-github]: https://github.com/mirage/ocaml-github
+
+## Perl
+
+* [Pithub][pithub-github] ([CPAN][pithub-cpan])
+* [Net::GitHub][net-github-github] ([CPAN][net-github-cpan])
+
+[net-github-github]: https://github.com/fayland/perl-net-github
+[net-github-cpan]: http://search.cpan.org/dist/Net-GitHub/
+[pithub-github]: https://github.com/plu/Pithub
+[pithub-cpan]: http://metacpan.org/module/Pithub
+
+## PHP
+
+* [GitHub PHP Client][github-php-client]
+* [PHP GitHub API][php-github-api]
+* [GitHub API][github-api]
+* [GitHub Kohana Module][kohana]
+* [GitHub Joomla! Package][joomla]
+* [Github Nette Extension][kdyby-github]
+* [GitHub API Easy Access][milo-github-api]
+* [GitHub bridge for Laravel][github-laravel]
+* [PHP5.6|PHP7 Client & WebHook wrapper][flexyproject-githubapi]
+
+[github-php-client]: https://github.com/tan-tan-kanarek/github-php-client
+[php-github-api]: https://github.com/KnpLabs/php-github-api
+[github-api]: https://github.com/yiiext/github-api
+[kohana]: https://github.com/acoulton/github_v3_api
+[joomla]: https://github.com/joomla-framework/github-api
+[kdyby-github]: https://github.com/kdyby/github
+[milo-github-api]: https://github.com/milo/github-api
+[github-laravel]: https://github.com/GrahamCampbell/Laravel-GitHub
+[flexyproject-githubapi]: https://github.com/FlexyProject/GitHubAPI
+
+## Python
+
+* [PyGithub][jacquev6_pygithub]
+* [Pygithub3][pygithub3-api]
+* [libsaas][libsaas]
+* [github3.py][github3py]
+* [sanction][sanction]
+* [agithub][agithub]
+* [githubpy][githubpy]
+* [octohub][octohub]
+* [Github-Flask][github-flask]
+* [torngithub][torngithub]
+
+[jacquev6_pygithub]: https://github.com/jacquev6/PyGithub
+[pygithub3-api]: https://github.com/copitux/python-github3
+[libsaas]: https://github.com/ducksboard/libsaas
+[github3py]: https://github.com/sigmavirus24/github3.py
+[sanction]: https://github.com/demianbrecht/sanction
+[agithub]: https://github.com/jpaugh/agithub "Agnostic GitHub"
+[githubpy]: https://github.com/michaelliao/githubpy
+[octohub]: https://github.com/turnkeylinux/octohub
+[github-flask]: http://github-flask.readthedocs.org
+[torngithub]: https://github.com/jkeylu/torngithub
+
+## Ruby
+
+* [GitHub API Gem][ghapi]
+* [GitHub v3 API][ruby1]
+* [GitHub API Client][ruby2]
+* [Ghee][ghee]
+
+[ghapi]: https://github.com/peter-murach/github
+[ruby1]: https://github.com/jwilger/github-v3-api
+[ruby2]: https://github.com/okonski/github-api-client
+[ghee]: https://github.com/rauhryan/ghee
+
+## Scala
+
+* [Dispatch GitHub][dispatchgithub]
+* [Hubcat][hubcat]
+* [Buhtig][buhtig]
+
+[dispatchgithub]: https://github.com/andreazevedo/dispatch-github
+[hubcat]: https://github.com/softprops/hubcat
+[buhtig]: https://github.com/mdread/buhtig
+
+## Shell
+
+* [ok.sh][ok.sh]
+
+[ok.sh]: https://github.com/whiteinge/ok.sh
diff --git a/content/program.md b/content/program.md
new file mode 100644
index 0000000000..f51bc21db1
--- /dev/null
+++ b/content/program.md
@@ -0,0 +1,58 @@
+---
+title: GitHub Developer
+layout: developers
+---
+
+Octokit comes in
+many flavors
+ Use the official Octokit library, or choose between any of the available third party libraries.
+-
+
- Rubyoctokit.rb +
- Obj-Coctokit.objc +
- .NEToctokit.net +
+
+
+
+
+ 
+ 
+
+It takes a community to design, build, and ship great software.
+Building an application that integrates with GitHub? Register for our Developer Program! The possibilities are endless, and you enjoy the kudos.
+ Register now +
+
+
+
+
+-
+
-
+
+
Stay in the know
+Be the first to know about API changes and try out new features before they launch.
+
+ -
+
+
Scratch an itch
+Build your own tools that seamlessly integrate with the place you push code every day.
+
+ -
+
+
Take on the enterprise
+Obtain developer licenses to build and test your application against GitHub Enterprise.
+
+
+
diff --git a/content/search/search-index.json b/content/search/search-index.json
new file mode 100644
index 0000000000..708851ff81
--- /dev/null
+++ b/content/search/search-index.json
@@ -0,0 +1,26 @@
+<%
+ #build the JSON tree
+ if @config[:audience]
+ @preface = "/enterprise/#{@config[:audience]}"
+ end
+ @output = []
+ @items.select { |item| !item.attributes[:hide_from_search] }.each do |item|
+ next if item[:filename].nil? || !item[:filename].end_with?('.md')
+ @path = item[:filename].split('/')[1..-1].join('/')[0..-4]
+ @path.chomp!('/index') if @path.end_with?('/index')
+
+ @output.push({
+ :title => "#{clean_for_json(item[:title])}",
+ :url => "#{@preface}/#{@path}/",
+ :body => "#{clean_for_json(item.compiled_content)}"
+ })
+ end
+%>
+<%=
+ #output the generated tree
+ if ENV['RACK_ENV'] == "production"
+ JSON.generate(@output.sort{|a, b| a[:title] <=> b[:title]})
+ else
+ JSON.pretty_generate(@output.sort{|a, b| a[:title] <=> b[:title]})
+ end
+%>
diff --git a/content/v3.md b/content/v3.md
index 3e0b86dfbf..a387737d67 100644
--- a/content/v3.md
+++ b/content/v3.md
@@ -2,44 +2,45 @@
title: GitHub API v3
---
-# API v3
-
-This describes the resources that make up the official GitHub API v3. If
-you have any problems or requests please contact
-[support](mailto:support@github.com?subject=APIv3).
-
-* Schema
-* Client Errors
-* HTTP Verbs
-* Authentication
-* Pagination
-* Rate Limiting
-* Conditional Requests
-* Cross Origin Resource Sharing
-* JSON-P Callbacks
+# Overview
+
+This describes the resources that make up the official {{ site.data.variables.product.product_name }} API v3. If you have any problems or requests please contact
+[support][].
+
+{:toc}
+
+## Current Version
+
+By default, all requests receive the **v3** [version](/v3/versions) of the API.
+We encourage you to [explicitly request this version via the `Accept` header](/v3/media/#request-specific-version).
+
+ Accept: application/vnd.github.v3+json
## Schema
-All API access is over HTTPS, and accessed from the `api.github.com`
-domain (or through `yourdomain.com/api/v3/` for enterprise). All data is
+All API access is over HTTPS, and accessed from the `{{ site.data.variables.product.api_url_code }}`. All data is
sent and received as JSON.
-
+
+
+
+ Have an integration that works with GitHub?
+Awesome! We'd love to have you be part of the program. Here’s how you can spread the word:
+-
+
- Let us know about your integration +
- Use the Octocat or GitHub logo to identify that your product works with GitHub +
- Post a video or a blog on your website about your integration +
+
+
+Ready to join the GitHub Developer Program?
+Membership is open to individual developers and companies who have:
+-
+
- A paid GitHub.com personal or organization plan +
- An integration in production or development using the GitHub API +
- An email address where GitHub users can contact you for support +
-$ curl -i https://api.github.com - -HTTP/1.1 302 Found -Server: nginx/1.0.12 -Date: Mon, 20 Feb 2012 11:15:49 GMT -Content-Type: text/html;charset=utf-8 -Connection: keep-alive -Status: 302 Found -X-RateLimit-Limit: 5000 -ETag: "d41d8cd98f00b204e9800998ecf8427e" -Location: http://developer.github.com -X-RateLimit-Remaining: 4999 -Content-Length: 0 - -+``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }}/users/octocat/orgs + +> HTTP/1.1 200 OK +> Server: nginx +> Date: Fri, 12 Oct 2012 23:33:14 GMT +> Content-Type: application/json; charset=utf-8 +> Connection: keep-alive +> Status: 200 OK +> ETag: "a00049ba79152d03380c34652f2cb612" +> X-GitHub-Media-Type: github.v3 +{% if page.version == 'dotcom' %} +> X-RateLimit-Limit: 5000 +> X-RateLimit-Remaining: 4987 +> X-RateLimit-Reset: 1350085394 +{% endif %} +> Content-Length: 5 +> Cache-Control: max-age=0, private, must-revalidate +> X-Content-Type-Options: nosniff +``` Blank fields are included as `null` instead of being omitted. @@ -47,6 +48,79 @@ All timestamps are returned in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ +### Summary Representations + +When you fetch a list of resources, the response includes a _subset_ of the +attributes for that resource. This is the "summary" representation of the +resource. (Some attributes are computationally expensive for the API to provide. +For performance reasons, the summary representation excludes those attributes. +To obtain those attributes, fetch the "detailed" representation.) + +**Example**: When you get a list of repositories, you get the summary +representation of each repository. Here, we fetch the list of repositories owned +by the [octokit](https://github.com/octokit) organization: + + GET /orgs/octokit/repos + +### Detailed Representations + +When you fetch an individual resource, the response typically includes _all_ +attributes for that resource. This is the "detailed" representation of the +resource. (Note that authorization sometimes influences the amount of detail +included in the representation.) + +**Example**: When you get an individual repository, you get the detailed +representation of the repository. Here, we fetch the +[octokit/octokit.rb](https://github.com/octokit/octokit.rb) repository: + + GET /repos/octokit/octokit.rb + +The documentation provides an example response for each API method. The example +response illustrates all attributes that are returned by that method. + +## Parameters + +Many API methods take optional parameters. For GET requests, any parameters not +specified as a segment in the path can be passed as an HTTP query string +parameter: + +``` command-line +$ curl -i "{{ site.data.variables.product.api_url_pre }}/repos/vmg/redcarpet/issues?state=closed" +``` + +In this example, the 'vmg' and 'redcarpet' values are provided for the `:owner` +and `:repo` parameters in the path while `:state` is passed in the query +string. + +For POST, PATCH, PUT, and DELETE requests, parameters not included in the URL should be encoded as JSON +with a Content-Type of 'application/json': + +``` command-line +$ curl -i -u username -d '{"scopes":["public_repo"]}' {{ site.data.variables.product.api_url_pre }}/authorizations +``` + +## Root Endpoint + +You can issue a `GET` request to the root endpoint to get all the endpoint categories that the API supports: + +``` command-line +$ curl {{ site.data.variables.product.api_url_pre }} +``` + +{% if page.version != 'dotcom' %} + +{{#tip}} + +**Tip:** For GitHub Enterprise, [as with all other endpoints](https://developer.github.com/v3/enterprise/#endpoint-urls), you'll need to pass in your GitHub Enterprise endpoint as the hostname, *as well as your username and password*: + +``` command-line +$ curl https://hostname/api/v3/ -u username:password +``` + +{{/tip}} + +{% endif %} + ## Client Errors There are three possible types of client errors on API calls that @@ -65,7 +139,7 @@ receive request bodies: HTTP/1.1 400 Bad Request Content-Length: 40 - {"message":"Body should be a JSON Hash"} + {"message":"Body should be a JSON object"} 3. Sending invalid fields will result in a `422 Unprocessable Entity` response. @@ -89,95 +163,162 @@ can tell what the problem is. There's also an error code to let you know what is wrong with the field. These are the possible validation error codes: -missing -: This means a resource does not exist. -missing\_field -: This means a required field on a resource has not been set. +Error Name | Description +-----------|-----------| +`missing` | This means a resource does not exist. +`missing_field` | This means a required field on a resource has not been set. +`invalid` | This means the formatting of a field is invalid. The documentation for that resource should be able to give you more specific information. +`already_exists` | This means another resource has the same value as this field. This can happen in resources that must have some unique key (such as Label names). + +Resources may also send custom validation errors (where `code` is `custom`). Custom errors will always have a `message` field describing the error, and most errors will also include a `documentation_url` field pointing to some content that might help you resolve the error. + +## HTTP Redirects -invalid -: This means the formatting of a field is invalid. The documentation -for that resource should be able to give you more specific information. +API v3 uses HTTP redirection where appropriate. Clients should assume that any +request may result in a redirection. Receiving an HTTP redirection is *not* an +error and clients should follow that redirect. Redirect responses will have a +`Location` header field which contains the URI of the resource to which the +client should repeat the requests. -already\_exists -: This means another resource has the same value as this field. This -can happen in resources that must have some unique key (such as Label -names). +Status Code | Description +-----------|-----------| +`301` | Permanent redirection. The URI you used to make the request has been superseded by the one specified in the `Location` header field. This and all future requests to this resource should be directed to the new URI. +`302`, `307` | Temporary redirection. The request should be repeated verbatim to the URI specified in the `Location` header field but clients should continue to use the original URI for future requests. -If resources have custom validation errors, they will be documented with -the resource. +Other redirection status codes may be used in accordance with the HTTP 1.1 spec. ## HTTP Verbs Where possible, API v3 strives to use appropriate HTTP verbs for each action. -HEAD -: Can be issued against any resource to get just the HTTP header info. +Verb | Description +-----|----------- +`HEAD` | Can be issued against any resource to get just the HTTP header info. +`GET` | Used for retrieving resources. +`POST` | Used for creating resources. +`PATCH` | Used for updating resources with partial JSON data. For instance, an Issue resource has `title` and `body` attributes. A PATCH request may accept one or more of the attributes to update the resource. PATCH is a relatively new and uncommon HTTP verb, so resource endpoints also accept `POST` requests. +`PUT` | Used for replacing resources or collections. For `PUT` requests with no `body` attribute, be sure to set the `Content-Length` header to zero. +`DELETE` |Used for deleting resources. -GET -: Used for retrieving resources. +## Authentication -POST -: Used for creating resources, or performing custom actions (such as -merging a pull request). +There are three ways to authenticate through {{ site.data.variables.product.product_name }} API v3. Requests that +require authentication will return `404 Not Found`, instead of +`403 Forbidden`, in some places. This is to prevent the accidental leakage +of private repositories to unauthorized users. -PATCH -: Used for updating resources with partial JSON data. For instance, an -Issue resource has `title` and `body` attributes. A PATCH request may -accept one or more of the attributes to update the resource. PATCH is a -relatively new and uncommon HTTP verb, so resource endpoints also accept -POST requests. +### Basic Authentication -PUT -: Used for replacing resources or collections. For PUT requests -with no `body` attribute, be sure to set the `Content-Length` header to zero. +``` command-line +$ curl -u "username" {{ site.data.variables.product.api_url_pre }} +``` -DELETE -: Used for deleting resources. +### OAuth2 Token (sent in a header) -## Authentication +``` command-line +$ curl -H "Authorization: token OAUTH-TOKEN" {{ site.data.variables.product.api_url_pre }} +``` -There are two ways to authenticate through GitHub API v3: +### OAuth2 Token (sent as a parameter) -Basic Authentication: +``` command-line +$ curl {{ site.data.variables.product.api_url_pre }}/?access_token=OAUTH-TOKEN +``` -
-$ curl -u "username" https://api.github.com -+Read [more about OAuth2](/v3/oauth/). Note that OAuth2 tokens can be [acquired +programmatically](/v3/oauth_authorizations/#create-a-new-authorization), for applications that +are not websites. -OAuth2 Token (sent in a header): +### OAuth2 Key/Secret -
-$ curl -H "Authorization: token OAUTH-TOKEN" https://api.github.com -+``` command-line +$ curl '{{ site.data.variables.product.api_url_pre }}/users/whatever?client_id=xxxx&client_secret=yyyy' +``` -OAuth2 Token (sent as a parameter): +This should only be used in server to server scenarios. Don't leak your +OAuth application's client secret to your users. -
-$ curl https://api.github.com/?access_token=OAUTH-TOKEN -+{% if page.version == 'dotcom' %} -Read [more about OAuth2](/v3/oauth/). Note that OAuth2 tokens can be [acquired -programmatically](/v3/oauth/#create-a-new-authorization), for applications that -are not websites. +Read [more about unauthenticated rate limiting](#increasing-the-unauthenticated-rate-limit-for-oauth-applications). + +{% endif %} + +### Failed login limit + +Authenticating with invalid credentials will return `401 Unauthorized`: + +``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }} -u foo:bar +> HTTP/1.1 401 Unauthorized + +> { +> "message": "Bad credentials", +> "documentation_url": "https://developer.github.com/v3" +> } +``` -Requests that require authentication will return 404, instead of 403, in some places. -This is to prevent the accidental leakage of private repositories to unauthorized -users. +After detecting several requests with invalid credentials within a short period, +the API will temporarily reject all authentication attempts for that user +(including ones with valid credentials) with `403 Forbidden`: + +``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }} -u valid_username:valid_password +> HTTP/1.1 403 Forbidden + +> { +> "message": "Maximum number of login attempts exceeded. Please try again later.", +> "documentation_url": "https://developer.github.com/v3" +> } +``` + +## Hypermedia + +All resources may have one or more `*_url` properties linking to other +resources. These are meant to provide explicit URLs so that proper API clients +don't need to construct URLs on their own. It is highly recommended that API +clients use these. Doing so will make future upgrades of the API easier for +developers. All URLs are expected to be proper [RFC 6570][rfc] URI templates. + +You can then expand these templates using something like the [uri_template][uri] +gem: + + >> tmpl = URITemplate.new('/notifications{?since,all,participating}') + >> tmpl.expand + => "/notifications" + + >> tmpl.expand :all => 1 + => "/notifications?all=1" + + >> tmpl.expand :all => 1, :participating => 1 + => "/notifications?all=1&participating=1" + +[rfc]: http://tools.ietf.org/html/rfc6570 +[uri]: https://github.com/hannesg/uri_template ## Pagination Requests that return multiple items will be paginated to 30 items by -default. You can specify further pages with the `?page` parameter. For some +default. You can specify further pages with the `?page` parameter. For some resources, you can also set a custom page size up to 100 with the `?per_page` parameter. +Note that for technical reasons not all endpoints respect the `?per_page` parameter, +see [events](https://developer.github.com/v3/activity/events/) for example. + +``` command-line +$ curl '{{ site.data.variables.product.api_url_pre }}/user/repos?page=2&per_page=100' +``` + +Note that page numbering is 1-based and that omitting the `?page` +parameter will return the first page. -
-$ curl https://api.github.com/user/repos?page=2&per_page=100 -+For more information on pagination, check out our guide on [Traversing with Pagination][pagination-guide]. + +### Link Header The pagination info is included in [the Link -header](http://www.w3.org/Protocols/9707-link-header.html). It is important to +header](http://tools.ietf.org/html/rfc5988). It is important to follow these Link header values instead of constructing your own URLs. In some instances, such as in the [Commits API](/v3/repos/commits/), pagination is based on @@ -188,175 +329,299 @@ SHA1 and not on page number. _Linebreak is included for readability._ +This `Link` response header contains one or more [Hypermedia](/v3/#hypermedia) link relations, some of which may require expansion as [URI templates](http://tools.ietf.org/html/rfc6570). + The possible `rel` values are: -`next` -: Shows the URL of the immediate next page of results. +Name | Description +-----------|-----------| +`next` |The link relation for the immediate next page of results. +`last` |The link relation for the last page of results. +`first` |The link relation for the first page of results. +`prev` |The link relation for the immediate previous page of results. -`last` -: Shows the URL of the last page of results. +{% if page.version == 'dotcom' %} -`first` -: Shows the URL of the first page of results. +## Rate Limiting -`prev` -: Shows the URL of the immediate previous page of results. +For requests using Basic Authentication or OAuth, you can make up to 5,000 +requests per hour. For unauthenticated requests, the rate limit allows you to +make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, +and not the user making requests. Note that [the Search API has custom rate limit +rules](/v3/search/#rate-limit). + +You can check the returned HTTP headers of any API request to see your current +rate limit status: + +``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }}/users/whatever +> HTTP/1.1 200 OK +> Date: Mon, 01 Jul 2013 17:27:06 GMT +> Status: 200 OK +> X-RateLimit-Limit: 60 +> X-RateLimit-Remaining: 56 +> X-RateLimit-Reset: 1372700873 +``` + +The headers tell you everything you need to know about your current rate limit status: + +Header Name | Description +-----------|-----------| +`X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per hour. +`X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. +`X-RateLimit-Reset` | The time at which the current rate limit window resets in [UTC epoch seconds](http://en.wikipedia.org/wiki/Unix_time). + +If you need the time in a different format, any modern programming language can get the job done. For example, if you open up the console on your web browser, you can easily get the reset time as a JavaScript Date object. + +``` javascript +new Date(1372700873 * 1000) +// => Mon Jul 01 2013 13:47:53 GMT-0400 (EDT) +``` + +Once you go over the rate limit you will receive an error response: + +``` command-line +> HTTP/1.1 403 Forbidden +> Date: Tue, 20 Aug 2013 14:50:41 GMT +> Status: 403 Forbidden +> X-RateLimit-Limit: 60 +> X-RateLimit-Remaining: 0 +> X-RateLimit-Reset: 1377013266 + +> { +> "message": "API rate limit exceeded for xxx.xxx.xxx.xxx. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)", +> "documentation_url": "https://developer.github.com/v3/#rate-limiting" +> } +``` + +You can also [check your rate limit status](/v3/rate_limit) without incurring an +API hit. +
-## Rate Limiting +### Increasing the unauthenticated rate limit for OAuth applications -We limit requests to API v3 to 5000 per hour. This is keyed off either your -login, your OAuth token, or request IP. You can check the returned HTTP -headers of any API request to see your current status: +If your OAuth application needs to make unauthenticated calls with a higher rate limit, you can pass your app's client ID and secret as part of the query string. -
-$ curl -i https://api.github.com/users/whatever
+``` command-line
+$ curl -i '{{ site.data.variables.product.api_url_pre }}/users/whatever?client_id=xxxx&client_secret=yyyy'
+> HTTP/1.1 200 OK
+> Date: Mon, 01 Jul 2013 17:27:06 GMT
+> Status: 200 OK
+> X-RateLimit-Limit: 5000
+> X-RateLimit-Remaining: 4966
+> X-RateLimit-Reset: 1372700873
+```
-HTTP/1.1 200 OK
-Status: 200 OK
-X-RateLimit-Limit: 5000
-X-RateLimit-Remaining: 4966
-
+This method should only be used for server-to-server calls. You should never
+share your client secret with anyone or include it in client-side browser code.
-You can also check your rate limit status without incurring an API hit.
+### Staying within the rate limit
- GET /rate_limit
+If you are using Basic Authentication or OAuth, and you are exceeding
+your rate limit, you can likely fix the issue by caching API responses
+and using [conditional requests](#conditional-requests).
-### Rate limit
+If you're using conditional requests and still exceeding your rate
+limit, please [contact us][support] to request a
+higher rate limit for your OAuth application.
-<%= headers 200 %>
-<%= json :rate => {:remaining => 4999, :limit => 5000} %>
+### Abuse Rate Limits
-+To protect the quality of service from GitHub, additional rate limits may apply to some actions. +For example, rapidly creating content, polling aggressively instead of using webhooks, +making API calls with a high concurrency, or repeatedly requesting data that is computationally expensive +may result in abuse rate limiting. -#### Unauthenticated rate limited requests +It is not intended for this rate limit to interfere with any legitimate use of +the API. Your normal [rate limits](/v3/#rate-limiting) should be the only +limit you target. Please [contact support][abuse-support] if your use is affected by +this rate limit. To ensure you're acting as a good API citizen, check out our +[Best Practices guidelines](/guides/best-practices-for-integrators/). -If you need to make unauthenticated calls but need to use a higher rate limit -associated with your OAuth application, you can send over your client ID and -secret in the query string. +If your application triggers this rate limit, you'll receive an informative +response: -
-$ curl -i https://api.github.com/users/whatever?client_id=xxxxxxxxxxxxxx&client_secret=yyyyyyyyyyyyyyyyyyyyy +``` command-line +> HTTP/1.1 403 Forbidden +> Content-Type: application/json; charset=utf-8 +> Connection: close -HTTP/1.1 200 OK -Status: 200 OK -X-RateLimit-Limit: 12500 -X-RateLimit-Remaining: 11966 -+> { +> "message": "You have triggered an abuse detection mechanism and have been temporarily blocked from content creation. Please retry your request again later.", +> "documentation_url": "https://developer.github.com/v3#abuse-rate-limits" +> } +``` -This method should only be used for server-to-server calls. You should never -share your client secret with anyone or include it in client-side browser code. +{% endif %} + +## User Agent Required -Please [contact us](https://github.com/contact) to request white listed access -for your application. We prefer sites that setup OAuth applications for their - users. +All API requests MUST include a valid `User-Agent` header. Requests with no `User-Agent` +header will be rejected. We request that you use your {{ site.data.variables.product.product_name }} username, or the name of your +application, for the `User-Agent` header value. This allows us to contact you if there are problems. -## Conditional Requests +Here's an example: -Most responses return `Last-Modified` and `Etag` headers. You can use the values +``` command-line +User-Agent: Awesome-Octocat-App +``` + +If you provide an invalid `User-Agent` header, you will receive a `403 Forbidden` response: + +``` command-line +$ curl -iH 'User-Agent: ' {{ site.data.variables.product.api_url_pre }}/meta +> HTTP/1.0 403 Forbidden +> Connection: close +> Content-Type: text/html + +> Request forbidden by administrative rules. +> Please make sure your request has a User-Agent header. +> Check https://developer.github.com for other possible causes. +``` + +## Conditional requests + +Most responses return an `ETag` header. Many responses also return a `Last-Modified` header. You can use the values of these headers to make subsequent requests to those resources using the -`If-Modified-Since` and `If-None-Match` headers, respectively. If the resource -has not changed, the server will return a `304 Not Modified`. Also note: making -a conditional request and receiving a 304 response does not count against your -[Rate Limit](#rate-limiting), so we encourage you to use it whenever possible. - -
-$ curl -i https://api.github.com/user -HTTP/1.1 200 OK -Cache-Control: private, max-age=60 -ETag: "644b5b0155e6404a9cc4bd9d8b1ae730" -Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT -Status: 200 OK -Vary: Accept, Authorization, Cookie -X-RateLimit-Limit: 5000 -X-RateLimit-Remaining: 4996 - -$ curl -i https://api.github.com/user -H "If-Modified-Since: Thu, 05 Jul 2012 15:31:30 GMT" -HTTP/1.1 304 Not Modified -Cache-Control: private, max-age=60 -Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT -Status: 304 Not Modified -Vary: Accept, Authorization, Cookie -X-RateLimit-Limit: 5000 -X-RateLimit-Remaining: 4996 - -$ curl -i https://api.github.com/user -H 'If-None-Match: "644b5b0155e6404a9cc4bd9d8b1ae730"' -HTTP/1.1 304 Not Modified -Cache-Control: private, max-age=60 -ETag: "644b5b0155e6404a9cc4bd9d8b1ae730" -Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT -Status: 304 Not Modified -Vary: Accept, Authorization, Cookie -X-RateLimit-Limit: 5000 -X-RateLimit-Remaining: 4996 -+`If-None-Match` and `If-Modified-Since` headers, respectively. If the resource +has not changed, the server will return a `304 Not Modified`. + +{% if page.version == 'dotcom' %} + +{{#tip}} + +**Note**: Making a conditional request and receiving a 304 response does not +count against your [Rate Limit](#rate-limiting), so we encourage you to use it +whenever possible. + +{{/tip}} + +{% endif %} + +``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }}/user +> HTTP/1.1 200 OK +> Cache-Control: private, max-age=60 +> ETag: "644b5b0155e6404a9cc4bd9d8b1ae730" +> Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT +> Status: 200 OK +> Vary: Accept, Authorization, Cookie +{% if page.version == 'dotcom' %} +> X-RateLimit-Limit: 5000 +> X-RateLimit-Remaining: 4996 +> X-RateLimit-Reset: 1372700873 +{% endif %} + +$ curl -i {{ site.data.variables.product.api_url_pre }}/user -H 'If-None-Match: "644b5b0155e6404a9cc4bd9d8b1ae730"' +> HTTP/1.1 304 Not Modified +> Cache-Control: private, max-age=60 +> ETag: "644b5b0155e6404a9cc4bd9d8b1ae730" +> Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT +> Status: 304 Not Modified +> Vary: Accept, Authorization, Cookie +{% if page.version == 'dotcom' %} +> X-RateLimit-Limit: 5000 +> X-RateLimit-Remaining: 4996 +> X-RateLimit-Reset: 1372700873 +{% endif %} + +$ curl -i {{ site.data.variables.product.api_url_pre }}/user -H "If-Modified-Since: Thu, 05 Jul 2012 15:31:30 GMT" +> HTTP/1.1 304 Not Modified +> Cache-Control: private, max-age=60 +> Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT +> Status: 304 Not Modified +> Vary: Accept, Authorization, Cookie +{% if page.version == 'dotcom' %} +> X-RateLimit-Limit: 5000 +> X-RateLimit-Remaining: 4996 +> X-RateLimit-Reset: 1372700873 +{% endif %} +``` ## Cross Origin Resource Sharing -The API supports Cross Origin Resource Sharing (CORS) for AJAX requests. -you can read the [CORS W3C working draft](http://www.w3.org/TR/cors), or +The API supports Cross Origin Resource Sharing (CORS) for AJAX requests from +any origin. +You can read the [CORS W3C Recommendation](http://www.w3.org/TR/cors/), or [this intro](http://code.google.com/p/html5security/wiki/CrossOriginRequestSecurity) from the HTML 5 Security Guide. Here's a sample request sent from a browser hitting -`http://some-site.com`: - - $ curl -i https://api.github.com -H "Origin: http://some-site.com" - HTTP/1.1 302 Found +`http://example.com`: -Any domain that is registered as an OAuth Application is accepted. -Here's a sample request for a browser hitting [Calendar About Nothing](http://calendaraboutnothing.com/): - - $ curl -i https://api.github.com -H "Origin: http://calendaraboutnothing.com" - HTTP/1.1 302 Found - Access-Control-Allow-Origin: http://calendaraboutnothing.com - Access-Control-Expose-Headers: Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes - Access-Control-Allow-Credentials: true +``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }} -H "Origin: http://example.com" +HTTP/1.1 302 Found +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, {% if page.version == 'dotcom' %}X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,{% endif %} X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval +Access-Control-Allow-Credentials: true +``` This is what the CORS preflight request looks like: - $ curl -i https://api.github.com -H "Origin: http://calendaraboutnothing.com" -X OPTIONS - HTTP/1.1 204 No Content - Access-Control-Allow-Origin: http://calendaraboutnothing.com - Access-Control-Allow-Headers: Authorization, X-Requested-With - Access-Control-Allow-Methods: GET, POST, PATCH, PUT, DELETE - Access-Control-Expose-Headers: Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes - Access-Control-Max-Age: 86400 - Access-Control-Allow-Credentials: true +``` command-line +$ curl -i {{ site.data.variables.product.api_url_pre }} -H "Origin: http://example.com" -X OPTIONS +HTTP/1.1 204 No Content +Access-Control-Allow-Origin: * +Access-Control-Allow-Headers: Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, X-GitHub-OTP, X-Requested-With +Access-Control-Allow-Methods: GET, POST, PATCH, PUT, DELETE +Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, {% if page.version == 'dotcom' %}X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,{% endif %} X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval +Access-Control-Max-Age: 86400 +Access-Control-Allow-Credentials: true +``` ## JSON-P Callbacks You can send a `?callback` parameter to any GET call to have the results wrapped in a JSON function. This is typically used when browsers want -to embed GitHub content in web pages by getting around cross domain +to embed {{ site.data.variables.product.product_name }} content in web pages by getting around cross domain issues. The response includes the same data output as the regular API, plus the relevant HTTP Header information. -
+``` command-line
$ curl https://api.github.com?callback=foo
-foo({
- "meta": {
- "status": 200,
- "X-RateLimit-Limit": "5000",
- "X-RateLimit-Remaining": "4966",
- "Link": [ // pagination headers and other links
- ["https://api.github.com?page=2", {"rel": "next"}]
- ]
- },
- "data": {
- // the data
- }
-})
-
-
-You can write a javascript handler to process the callback like this:
-
-function foo(response) {
- var meta = response.meta
- var data = response.data
- console.log(meta)
- console.log(data)
-}Open up your browser's console.
+ + All of the headers are the same String value as the HTTP Headers with one notable exception: Link. Link headers are pre-parsed for you and come @@ -372,3 +637,47 @@ A link that looks like this: ["url1", {:rel => "next"}], ["url2", {:rel => "foo", :bar => "baz"}]] %> +## Timezones + +Some requests allow for specifying timestamps or generate timestamps with time +zone information. We apply the following rules, in order of priority, to +determine timezone information for API calls. + +#### Explicitly provide an ISO 8601 timestamp with timezone information + +For API calls that allow for a timestamp to be specified, we use that exact +timestamp. An example of this is the [Commits API](/v3/git/commits). + +These timestamps look something like `2014-02-27T15:05:06+01:00`. Also see +[this example](https://developer.github.com/v3/git/commits/#example-input) for +how these timestamps can be specified. + +#### Using the `Time-Zone` header + +It is possible to supply a `Time-Zone` header which defines a timezone according +to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + +``` command-line +$ curl -H "Time-Zone: Europe/Amsterdam" -X POST {{ site.data.variables.product.api_url_pre }}/repos/github/linguist/contents/new_file.md +``` + +This means that we generate a timestamp for the moment your API call is made in +the timezone this header defines. For example, the [Contents API](/v3/repos/contents/) +generates a git commit for each addition or change and uses the current time +as the timestamp. This header will determine the timezone used for generating +that current timestamp. + +#### Using the last known timezone for the user + +If no `Time-Zone` header is specified and you make an authenticated call to the +API, we use the last known timezone for the authenticated user. The last known +timezone is updated whenever you browse the {{ site.data.variables.product.product_name }} website. + +#### UTC + +If the steps above don't result in any information, we use UTC as the timezone +to create the git commit. + +[support]: https://github.com/contact?form[subject]=APIv3 +[abuse-support]: https://github.com/contact?form[subject]=API+Abuse+Rate+Limits +[pagination-guide]: /guides/traversing-with-pagination diff --git a/content/v3/activity.md b/content/v3/activity.md new file mode 100644 index 0000000000..cdac1ca8a7 --- /dev/null +++ b/content/v3/activity.md @@ -0,0 +1,39 @@ +--- +title: Activity +--- +# Activity + +Serving up the 'social' in Social Coding, the Activity APIs provide access to +notifications, subscriptions, and timelines. + +## [Events][] + +The [Events API][Events] is a read-only interface to all the [event +types][types] that power the various activity streams on {{ site.data.variables.product.product_name }}. + +## [Feeds][] + +List of [Atom feeds][Feeds] available for the authenticated user. + +## [Notifications][] + +Notifications of new comments are delivered to users. [The Notifications +API][Notifications] lets you view these notifications and mark them as read. + +## [Starring][] + +[Repository Starring][Starring] is a feature that lets users bookmark repositories. Stars +are shown next to repositories to show an approximate level of interest. Stars +have no effect on notifications or the activity feed. + +## [Watching][] + +[Watching a Repository][Watching] registers the user to receive notifications on new +discussions, as well as events in the user's activity feed. + +[Events]: /v3/activity/events/ +[types]: /v3/activity/events/types/ +[Feeds]: /v3/activity/feeds/ +[Notifications]: /v3/activity/notifications/ +[Starring]: /v3/activity/starring/ +[Watching]: /v3/activity/watching/ diff --git a/content/v3/activity/events.md b/content/v3/activity/events.md new file mode 100644 index 0000000000..5541291631 --- /dev/null +++ b/content/v3/activity/events.md @@ -0,0 +1,95 @@ +--- +title: Events +--- + +# Events + +This is a read-only API to the {{ site.data.variables.product.product_name }} events. These events power the +various activity streams on the site. + +{:toc} + +Events are optimized for polling with the "ETag" header. If no new events have +been triggered, you will see a "304 Not Modified" response, and your current +rate limit will be untouched. There is also an "X-Poll-Interval" header that +specifies how often (in seconds) you are allowed to poll. In times of high +server load, the time may increase. Please obey the header. + +``` command-line +$ curl -I {{ site.data.variables.product.api_url_pre }}/users/tater/events +> HTTP/1.1 200 OK +> X-Poll-Interval: 60 +> ETag: "a18c3bded88eb5dbb5c849a489412bf3" + +# The quotes around the ETag value are important +$ curl -I {{ site.data.variables.product.api_url_pre }}/users/tater/events \ +$ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' +> HTTP/1.1 304 Not Modified +> X-Poll-Interval: 60 +``` + +Events support [pagination](/v3/#pagination), +however the `per_page` option is unsupported. The fixed page size is 30 items. +Fetching up to ten pages is supported, for a total of 300 events. + +Only events created within the past 90 days will be included in timelines. Events +older than 90 days will not be included (even if the total number of events +in the timeline is less than 300). + +All Events have the same response format: + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:event) { |h| [h] } %> + +## List public events + + GET /events + +## List repository events + + GET /repos/:owner/:repo/events + +## List issue events for a repository + +Repository issue events have a different format than other events, +as documented in the [Issue Events API](https://developer.github.com/v3/issues/events/). + + GET /repos/:owner/:repo/issues/events + +## List public events for a network of repositories + + GET /networks/:owner/:repo/events + +## List public events for an organization + + GET /orgs/:org/events + +## List events that a user has received + +These are events that you've received by watching repos and following +users. If you are authenticated as the given user, you will see private +events. Otherwise, you'll only see public events. + + GET /users/:username/received_events + +## List public events that a user has received + + GET /users/:username/received_events/public + +## List events performed by a user + +If you are authenticated as the given user, you will see your private +events. Otherwise, you'll only see public events. + + GET /users/:username/events + +## List public events performed by a user + + GET /users/:username/events/public + +## List events for an organization + +This is the user's organization dashboard. You must be authenticated as +the user to view this. + + GET /users/:username/events/orgs/:org diff --git a/content/v3/activity/events/types.md b/content/v3/activity/events/types.md new file mode 100644 index 0000000000..9504e2de89 --- /dev/null +++ b/content/v3/activity/events/types.md @@ -0,0 +1,558 @@ +--- +title: Event Types & Payloads +--- + +# Event Types & Payloads + +Each event has a similar JSON schema, but a unique `payload` object that is +determined by its event type. + +Event names are used by [repository webhooks](/v3/repos/hooks/) to specify +which events the webhook should receive. The included payloads below are from webhook deliveries but +match events returned by the [Events API](/v3/activity/events/) (except where noted). The Events API uses the CamelCased name (e.g. `CommitCommentEvent`) in the `type` field of an event object and does not include the `repository` or `sender` fields in the event payload object. + + +**Note:** Some of these events may not be rendered in timelines, they're only +created for various internal and webhook purposes. + +{:toc} + +## CommitCommentEvent + +Triggered when a [commit comment](/v3/repos/comments/#list-commit-comments-for-a-repository) is created. + +### Events API payload + +Key | Type | Description +----|------|------------- +`comment`|`object` | The [comment](/v3/repos/comments/#list-commit-comments-for-a-repository) itself. + +### Webhook event name + +`commit_comment` + +### Webhook payload example + +<%= webhook_payload "commit_comment" %> + +## CreateEvent + +Represents a created repository, branch, or tag. + +Note: webhooks will not receive this event for created repositories. Additionally, webhooks will not receive this event for tags if more than three tags are pushed at once. + +### Events API payload + +Key | Type | Description +----|------|------------- +`ref_type`|`string` | The object that was created. Can be one of "repository", "branch", or "tag" +`ref`|`string` | The git ref (or `null` if only a repository was created). +`master_branch`|`string` | The name of the repository's default branch (usually `master`). +`description`|`string` | The repository's current description. + +### Webhook event name + +`create` + +### Webhook payload example + +<%= webhook_payload "create" %> + +## DeleteEvent + +Represents a [deleted branch or tag](/v3/git/refs/#delete-a-reference). + +Note: webhooks will not receive this event for tags if more than three tags are deleted at once. + +### Events API payload + +Key | Type | Description +----|------|------------- +`ref_type`|`string` | The object that was deleted. Can be "branch" or "tag". +`ref`|`string` | The full git ref. + +### Webhook event name + +`delete` + +### Webhook payload example + +<%= webhook_payload "delete" %> + +## DeploymentEvent + +Represents a [deployment](/v3/repos/deployments/#list-deployments). + +Events of this type are not visible in timelines. These events are only used to trigger hooks. + +### Events API payload + +Key | Type | Description +----|------|------------- +`deployment` |`object` | The [deployment](/v3/repos/deployments/#list-deployments). +`deployment`[`"sha"`] |`string` | The commit SHA for which this deployment was created. +`deployment`[`"payload"`] |`string` | The optional extra information for this deployment. +`deployment`[`"environment"`] |`string` | The optional environment to deploy to. Default: `"production"` +`deployment`[`"description"`] |`string` | The optional human-readable description added to the deployment. +`repository` |`object` | The [repository](/v3/repos/) for this deployment. + +### Webhook event name + +`deployment` + +### Webhook payload example + +<%= webhook_payload "deployment" %> + +## DeploymentStatusEvent + +Represents a [deployment status](/v3/repos/deployments/#list-deployment-statuses). + +Events of this type are not visible in timelines. These events are only used to trigger hooks. + +### Events API payload + +Key | Type | Description +----|------|------------- +`deployment_status` |`object` | The [deployment status](/v3/repos/deployments/#list-deployment-statuses). +`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. +`deployment_status["target_url"]` |`string` | The optional link added to the status. +`deployment_status["description"]`|`string` | The optional human-readable description added to the status. +`deployment` |`object` | The [deployment](/v3/repos/deployments/#list-deployments) that this status is associated with. +`repository` |`object` | The [repository](/v3/repos/) for this deployment. + +### Webhook event name + +`deployment_status` + +### Webhook payload example + +<%= webhook_payload "deployment_status" %> + +## DownloadEvent + +Triggered when a new [download](/v3/repos/downloads/) is created. + +Events of this type are **no longer created**, but it's possible that they exist in timelines of some users. + +### Events API payload + +Key | Type | Description +----|------|------------- +`download`|`object` | The [download](/v3/repos/downloads/) that was just created. + +### Webhook event name + +`download` + +## FollowEvent + +Triggered when a user [follows another user](/v3/users/followers/#follow-a-user). + +Events of this type are **no longer created**, but it's possible that they exist in timelines of some users. + +### Events API payload + +Key | Type | Description +----|------|------------- +`target`|`object` | The [user](/v3/users) that was just followed. + +### Webhook event name + +`follow` + +## ForkEvent + +Triggered when a user [forks a repository](/v3/repos/forks/#create-a-fork). + +### Events API payload + +Key | Type | Description +----|------|------------- +`forkee`|`object` | The created [repository](/v3/repos/). + +### Webhook event name + +`fork` + +### Webhook payload example + +<%= webhook_payload "fork" %> + +## ForkApplyEvent + +Triggered when a patch is applied in the Fork Queue. + +Events of this type are **no longer created**, but it's possible that they exist in timelines of some users. + +### Events API payload + +Key | Type | Description +----|------|------------- +`head`|`string` | The branch name the patch is applied to. +`before`|`string` | SHA of the repository state before the patch. +`after`|`string` | SHA of the repository state after the patch. + +### Webhook event name + +`fork_apply` + +## GistEvent + +Triggered when a [Gist](/v3/gists/) is created or updated. + +Events of this type are **no longer created**, but it's possible that they exist in timelines of some users. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Can be "create" or "update" +`gist`|`object` | The [gist](/v3/gists/) itself. + +### Webhook event name + +`gist` + +## GollumEvent + +Triggered when a Wiki page is created or updated. + +### Events API payload + +Key | Type | Description +----|------|------------- +`pages`|`array` | The pages that were updated. +`pages[][page_name]`|`string` | The name of the page. +`pages[][title]`|`string` | The current page title. +`pages[][action]`|`string` | The action that was performed on the page. Can be "created" or "edited". +`pages[][sha]`|`string` | The latest commit SHA of the page. +`pages[][html_url]`|`string` | Points to the HTML wiki page. + +### Webhook event name + +`gollum` + +### Webhook payload example + +<%= webhook_payload "gollum" %> + +## IssueCommentEvent + +{% if page.version == 'dotcom' or page.version > 2.6 %} +Triggered when an [issue comment](/v3/issues/comments/) is created, edited, or deleted. +{% else %} +Triggered when an [issue is commented on](/v3/issues/comments/). +{% endif %} + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed on the comment. {% if page.version == 'dotcom' or page.version > 2.6 %}Can be one of "created", "edited", or "deleted". +`changes`|`object` | The changes to the comment if the action was "edited". +`changes[body][from]` |`string` | The previous version of the body if the action was "edited".{% else %}Currently, can only be "created".{% endif %} +`issue`|`object` | The [issue](/v3/issues/) the comment belongs to. +`comment`|`object` | The [comment](/v3/issues/comments/) itself. + +### Webhook event name + +`issue_comment` + +### Webhook payload example + +<%= webhook_payload "issue_comment" %> + +## IssuesEvent + +Triggered when an [issue](/v3/issues) is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, or reopened. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", {% if page.version == 'dotcom' or page.version > 2.6 %}"edited", {% endif %}"closed", or "reopened". +`issue`|`object` | The [issue](/v3/issues) itself.{% if page.version == 'dotcom' or page.version > 2.6 %} +`changes`|`object`| The changes to the issue if the action was "edited". +`changes[title][from]`|`string` | The previous version of the title if the action was "edited". +`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% endif %} +`assignee`|`object` | The optional user who was assigned or unassigned from the issue. +`label`|`object` | The optional label that was added or removed from the issue. + +### Webhook event name + +`issues` + +### Webhook payload example + +<%= webhook_payload "issues" %> + +## MemberEvent + +Triggered when a user is [added as a collaborator](/v3/repos/collaborators/#add-user-as-a-collaborator) to a repository. + +### Events API payload + +Key | Type | Description +----|------|------------- +`member`|`object` | The [user](/v3/users/) that was added. +`action`|`string` | The action that was performed. Currently, can only be "added". + +### Webhook event name + +`member` + +### Webhook payload example + +<%= webhook_payload "member" %> + +## MembershipEvent + +Triggered when a user is added or removed from a team. + +Events of this type are not visible in timelines. These events are only used to trigger hooks. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action` |`string` | The action that was performed. Can be "added" or "removed". +`scope` |`string` | The scope of the membership. Currently, can only be "team". +`member` |`object` | The [user](/v3/users/) that was added or removed. +`team` |`object` | The [team](/v3/orgs/teams/) for the membership. + +### Webhook event name + +`membership` + +### Webhook payload example + +<%= webhook_payload "membership" %> + +## PageBuildEvent + +Represents an attempted build of a GitHub Pages site, whether successful or not. + +Triggered on push to a GitHub Pages enabled branch (`gh-pages` for project pages, `master` for user and organization pages). + +Events of this type are not visible in timelines. These events are only used to trigger hooks. + +### Events API payload + +Key | Type | Description +----|------|------------ +`build` | `object` | The [page build](https://developer.github.com/v3/repos/pages/#list-pages-builds) itself. + +### Webhook event name + +`page_build` + +### Webhook payload example + +<%= webhook_payload "page_build" %> + +## PublicEvent + +Triggered when a private repository is [open sourced](/v3/repos/#edit). Without a doubt: the best {{ site.data.variables.product.product_name }} event. + +### Events API payload + +### Webhook event name + +`public` + +### Webhook payload example + +<%= webhook_payload "public" %> + +## PullRequestEvent + +Triggered when a [pull request](/v3/pulls) is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, reopened, or synchronized. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", {% if page.version == 'dotcom' or page.version > 2.6 %}"edited", {% endif %}"closed", or "reopened", or "synchronize". If the action is "closed" and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is "closed" and the `merged` key is `true`, the pull request was merged. +`number`|`integer` | The pull request number.{% if page.version == 'dotcom' or page.version > 2.6 %} +`changes`|`object`| The changes to the comment if the action was "edited". +`changes[title][from]`|`string` | The previous version of the title if the action was "edited". +`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% endif %} +`pull_request`|`object` | The [pull request](/v3/pulls) itself. + +### Webhook event name + +`pull_request` + +### Webhook payload example + +<%= webhook_payload "pull_request" %> + +## PullRequestReviewCommentEvent + +{% if page.version == 'dotcom' or page.version > 2.6 %} +Triggered when a [comment on a Pull Request's unified diff](/v3/pulls/comments) is created, edited, or deleted (in the Files Changed tab). +{% else %} +Triggered when a [Pull Request's unified diff is commented on](/v3/pulls/comments) (in the Files Changed tab). +{% endif %} + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed on the comment. {% if page.version == 'dotcom' or page.version > 2.6 %}Can be one of "created", "edited", or "deleted". +`changes`|`object`| The changes to the comment if the action was "edited". +`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% else %}Currently, can only be "created".{% endif %} +`pull_request`|`object` | The [pull request](/v3/pulls/) the comment belongs to. +`comment`|`object` | The [comment](/v3/pulls/comments) itself. + +### Webhook event name + +`pull_request_review_comment` + +### Webhook payload example + +<%= webhook_payload "pull_request_review_comment" %> + +## PushEvent + +Triggered when a repository branch is pushed to. In addition to branch pushes, webhook [`push` events](/webhooks/#events) are also triggered when repository tags are pushed. + +{{#tip}} + +The Events API `PushEvent` payload is described in the table below. The example payload below that is from a webhook delivery and will differ from the Events API `PushEvent` payload. + +{{/tip}} + +### Events API payload + +Key | Type | Description +----|------|------------- +`ref`|`string` | The full Git ref that was pushed. Example: `"refs/heads/master"`. +`head`|`string` | The SHA of the most recent commit on `ref` after the push. +`before`|`string` | The SHA of the most recent commit on `ref` before the push. +`size`|`integer` | The number of commits in the push. +`distinct_size`|`integer` | The number of distinct commits in the push. +`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/v3/repos/commits/) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.) +`commits[][sha]`|`string` | The SHA of the commit. +`commits[][message]`|`string` | The commit message. +`commits[][author]`|`object` | The git author of the commit. +`commits[][author][name]`|`string` | The git author's name. +`commits[][author][email]`|`string` | The git author's email address. +`commits[][url]`|`url` | Points to the commit API resource. +`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. + +### Webhook event name + +`push` + +### Webhook payload example + +<%= webhook_payload "push" %> + +## ReleaseEvent + +Triggered when a [release](/v3/repos/releases/#get-a-single-release) is published. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Currently, can only be "published". +`release`|`object` | The [release](/v3/repos/releases/#get-a-single-release) itself. + +### Webhook event name + +`release` + +### Webhook payload example + +<%= webhook_payload "release" %> + +## RepositoryEvent + +Triggered when a repository is created{% if page.version == 'dotcom' or page.version > 2.6 %}, deleted, made public, or made private{% endif %}. + +Events of this type are not visible in timelines. These events are only used to trigger {% if page.version != 'dotcom' and page.version <= 2.6 %}organization {% endif %}hooks. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action` |`string` | The action that was performed. {% if page.version == 'dotcom' or page.version > 2.6 %}This can be one of "created", "deleted", "publicized", or "privatized".{% else %}Currently, can only be "created".{% endif %} +`repository`|`object` | The [repository](/v3/repos/) itself. + +### Webhook event name + +`repository` + +### Webhook payload example + +<%= webhook_payload "repository" %> + +## StatusEvent + +Triggered when the status of a Git commit changes. + +Events of this type are not visible in timelines. These events are only used to trigger hooks. + +### Events API payload + +Key | Type | Description +----|------|------------- +`sha`|`string` | The Commit SHA. +`state`|`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. +`description`|`string` | The optional human-readable description added to the status. +`target_url`|`string` | The optional link added to the status. +`branches`|`array` | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. + +### Webhook event name + +`status` + +### Webhook payload example + +<%= webhook_payload "status" %> + +## TeamAddEvent + +Triggered when a [repository is added to a team](/v3/orgs/teams/#add-or-update-team-repository). + +Events of this type are not visible in timelines. These events are only used to trigger hooks. + +### Events API payload + +Key | Type | Description +----|------|------------- +`team`|`object` | The [team](/v3/orgs/teams/) that was modified. Note: older events may not include this in the payload. +`repository`|`object` | The [repository](/v3/repos/) that was added to this team. + +### Webhook event name + +`team_add` + +### Webhook payload example + +<%= webhook_payload "team_add" %> + +## WatchEvent + +The WatchEvent is related to [starring a repository](/v3/activity/starring/#star-a-repository), not [watching](/v3/activity/watching/). +See [this API blog post](/changes/2012-09-05-watcher-api/) for an explanation. + +The event’s actor is the [user](/v3/users/) who starred a repository, and the +event’s repository is the [repository](/v3/repos/) that was starred. + +### Events API payload + +Key | Type | Description +----|------|------------- +`action`|`string` | The action that was performed. Currently, can only be `started`. + +### Webhook event name + +`watch` + +### Webhook payload example + +<%= webhook_payload "watch" %> diff --git a/content/v3/activity/feeds.md b/content/v3/activity/feeds.md new file mode 100644 index 0000000000..11c583fa9b --- /dev/null +++ b/content/v3/activity/feeds.md @@ -0,0 +1,34 @@ +--- +title: Feeds +--- + +# Feeds + +{:toc} + +## List Feeds + +{{ site.data.variables.product.product_name }} provides several timeline resources in [Atom][] format. The Feeds API +lists all the feeds available to the authenticated user: + +* **Timeline**: The {{ site.data.variables.product.product_name }} global public timeline +* **User**: The public timeline for any user, using [URI template][] +* **Current user public**: The public timeline for the authenticated user +* **Current user**: The private timeline for the authenticated user +* **Current user actor**: The private timeline for activity created by the authenticated user +* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + +**Note**: Private feeds are only returned when [authenticating via Basic +Auth][authenticating] since current feed URIs use the older, non revocable auth +tokens. + + GET /feeds + +### Response + +<%= headers 200 %> +<%= json :feeds %> + +[Atom]: http://en.wikipedia.org/wiki/Atom_(standard) +[authenticating]: /v3/#basic-authentication +[URI template]: https://developer.github.com/v3/#hypermedia diff --git a/content/v3/activity/notifications.md b/content/v3/activity/notifications.md new file mode 100644 index 0000000000..b09ec649a7 --- /dev/null +++ b/content/v3/activity/notifications.md @@ -0,0 +1,222 @@ +--- +title: Notifications +--- + +# Notifications + +{:toc} + +Users receive notifications for conversations in repositories they watch +including: + +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits + +Notifications are also sent for conversations in unwatched repositories when the +user is involved including: + +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates + +All Notification API calls require the `notifications` or +`repo` API scopes. Doing this will give read-only access to +some Issue/Commit content. You will still need the "repo" scope to access +Issues and Commits from their respective endpoints. + +Notifications come back as "threads". A Thread contains information about the +current discussion of an Issue/PullRequest/Commit. + +Notifications are optimized for polling with the "Last-Modified" header. If +there are no new notifications, you will see a "304 Not Modified" response, +leaving your current rate limit untouched. There is an "X-Poll-Interval" +header that specifies how often (in seconds) you are allowed to poll. In times +of high server load, the time may increase. Please obey the header. + +``` command-line +# Add authentication to your requests +$ curl -I {{ site.data.variables.product.api_url_pre }}/notifications +HTTP/1.1 200 OK +Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT +X-Poll-Interval: 60 + +# Pass the Last-Modified header exactly +$ curl -I {{ site.data.variables.product.api_url_pre }}/notifications +$ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" +> HTTP/1.1 304 Not Modified +> X-Poll-Interval: 60 +``` + +## Notification Reasons + +When retrieving responses from the Notifications API, each payload has a key titled +`reason`. These correspond to events that trigger a notification. + +Here's a list of potential `reason`s for receiving a notification: + +Reason Name | Description +------------|------------ +`subscribed` | The notification arrived because you're watching the repository +`manual` | The notification arrived because you've specifically decided to subscribe to the thread (via an Issue or Pull Request) +`author` | The notification arrived because you've created the thread +`comment` | The notification arrived because you've commented on the thread +`mention` | The notification arrived because you were specifically **@mentioned** in the content +`team_mention` | The notification arrived because you were on a team that was mentioned (like @org/team) +`state_change` | The notification arrived because you changed the thread state (like closing an Issue or merging a Pull Request) +`assign` | The notification arrived because you were assigned to the Issue + +Note that the `reason` is modified on a per-thread basis, and can change, if the +`reason` on a later notification is different. + +For example, if you are the author of an issue, subsequent notifications on that +issue will have a `reason` of `author`. If you're then **@mentioned** on the same +issue, the notifications you fetch thereafter will have a `reason` of `mention`. +The `reason` remains as `mention`, regardless of whether you're ever mentioned again. + +## List your notifications + +List all notifications for the current user, grouped by repository. + + GET /notifications + +### Parameters + +Name | Type | Description +-----|------|-------------- +`all`|`boolean` | If `true`, show notifications marked as read. Default: `false` +`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned. Default: `false` +`since`|`string` | Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now` +`before`|`string` | Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + +### Response + +{% if page.version == 'dotcom' or page.version > 2.5 %} +<%= headers 200, :pagination => default_pagination_rels %> +{% else %} +<%= headers 200 %> +{% endif %} +<%= json(:thread) { |h| [h] } %> + +## List your notifications in a repository + +List all notifications for the current user. + + GET /repos/:owner/:repo/notifications + +### Parameters + +Name | Type | Description +-----|------|-------------- +`all`|`boolean` | If `true`, show notifications marked as read. Default: `false` +`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned. Default: `false` +`since`|`string` | Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now` +`before`|`string` | Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + +### Response + +{% if page.version == 'dotcom' or page.version > 2.5 %} +<%= headers 200, :pagination => default_pagination_rels %> +{% else %} +<%= headers 200 %> +{% endif %} +<%= json(:thread) { |h| [h] } %> + +## Mark as read + +Marking a notification as "read" removes it from the [default view +on {{ site.data.variables.product.product_name }}](https://github.com/notifications). + + PUT /notifications + +### Parameters + +Name | Type | Description +-----|------|-------------- +`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now` + + +### Response + +<%= headers 205 %> + +## Mark notifications as read in a repository + +Marking all notifications in a repository as "read" removes them +from the [default view on {{ site.data.variables.product.product_name }}](https://github.com/notifications). + + PUT /repos/:owner/:repo/notifications + +### Parameters + +Name | Type | Description +-----|------|-------------- +`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now` + + +### Response + +<%= headers 205 %> + +## View a single thread + + GET /notifications/threads/:id + +### Response + +<%= headers 200 %> +<%= json(:thread) %> + +## Mark a thread as read + + PATCH /notifications/threads/:id + +### Response + +<%= headers 205 %> + +## Get a Thread Subscription + +This checks to see if the current user is subscribed to a thread. You can also +[get a Repository subscription](/v3/activity/watching/#get-a-repository-subscription). + +{{#tip}} + +Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mention**ed, or manually subscribe to a thread. + +{{/tip}} + + GET /notifications/threads/:id/subscription + +### Response + +<%= headers 200 %> +<%= json :subscription %> + +## Set a Thread Subscription + +This lets you subscribe or unsubscribe from a conversation. Unsubscribing from a conversation mutes all future notifications (until you comment or get **@mention**ed once more). + + PUT /notifications/threads/:id/subscription + +### Parameters + +Name | Type | Description +-----|------|-------------- +`subscribed`|`boolean`| Determines if notifications should be received from this thread +`ignored`|`boolean`| Determines if all notifications should be blocked from this thread + + +### Response + +<%= headers 200 %> +<%= json :subscription %> + +## Delete a Thread Subscription + + DELETE /notifications/threads/:id/subscription + +### Response + +<%= headers 204 %> diff --git a/content/v3/activity/starring.md b/content/v3/activity/starring.md new file mode 100644 index 0000000000..b32b1a7c0b --- /dev/null +++ b/content/v3/activity/starring.md @@ -0,0 +1,106 @@ +--- +title: Starring +--- + +# Starring + +{:toc} + +Repository Starring is a feature that lets users bookmark repositories. Stars +are shown next to repositories to show an approximate level of interest. Stars +have no effect on notifications or the activity feed. For that, see [Repository +Watching](/v3/activity/watching). + +### Starring vs. Watching + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {{ site.data.variables.product.product_name }}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). Check out the [Watcher API Change post](/changes/2012-09-05-watcher-api/) +for more details. + +## List Stargazers + + GET /repos/:owner/:repo/stargazers + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:user) { |h| [h] } %> + +### Alternative response with star creation timestamps + +You can also find out _when_ stars were created by passing the following custom [media type](/v3/media/) via the `Accept` header: + + Accept: application/vnd.github.v3.star+json + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:stargazer_with_timestamps) { |hash| [hash] } %> + +## List repositories being starred + +List repositories being starred by a user. + + GET /users/:username/starred + +List repositories being starred by the authenticated user. + + GET /user/starred + +### Parameters + +Name | Type | Description +-----|------|-------------- +`sort`|`string` | One of `created` (when the repository was starred) or `updated` (when it was last pushed to). Default: `created` +`direction`|`string` | One of `asc` (ascending) or `desc` (descending). Default: `desc` + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:repo) { |h| [h] } %> + +### Alternative response with star creation timestamps + +You can also find out _when_ stars were created by passing the following custom [media type](/v3/media/) via the `Accept` header: + + Accept: application/vnd.github.v3.star+json + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:starred_repo) { |hash| [hash] } %> + +## Check if you are starring a repository + +Requires for the user to be authenticated. + + GET /user/starred/:owner/:repo + +### Response if this repository is starred by you + +<%= headers 204 %> + +### Response if this repository is not starred by you + +<%= headers 404 %> + +## Star a repository + +Requires for the user to be authenticated. + + PUT /user/starred/:owner/:repo + +<%= fetch_content(:put_content_length) %> + +### Response + +<%= headers 204 %> + +## Unstar a repository + +Requires for the user to be authenticated. + + DELETE /user/starred/:owner/:repo + +### Response + +<%= headers 204 %> diff --git a/content/v3/activity/watching.md b/content/v3/activity/watching.md new file mode 100644 index 0000000000..40b39b87bd --- /dev/null +++ b/content/v3/activity/watching.md @@ -0,0 +1,132 @@ +--- +title: Watching +--- + +# Watching + +{:toc} + +Watching a Repository registers the user to receive notifications on new +discussions, as well as events in the user's activity feed. See [Repository +Starring](/v3/activity/starring) for simple repository bookmarks. + +### Watching vs. Starring + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on GitHub. At the time +of that change, many API clients were already using the existing "watcher" +endpoints to access starring data. To avoid breaking those applications, the +legacy "watcher" endpoints continue to provide starring data. + +To provide access to watching data, the v3 Watcher API uses the "subscription" +endpoints described below. Check out the [Watcher API Change +post](/changes/2012-09-05-watcher-api/) for more details. + +## List watchers + + GET /repos/:owner/:repo/subscribers + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:user) { |h| [h] } %> + +## List repositories being watched + +List repositories being watched by a user. + + GET /users/:username/subscriptions + +List repositories being watched by the authenticated user. + + GET /user/subscriptions + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:repo) { |h| [h] } %> + +## Get a Repository Subscription + + GET /repos/:owner/:repo/subscription + +### Response if you are subscribed to the repository + +<%= headers 200 %> +<%= json :repo_subscription %> + +### Response if you are not subscribed to the repository + +<%= headers 404 %> + +## Set a Repository Subscription + + PUT /repos/:owner/:repo/subscription + +### Parameters + +Name | Type | Description +-----|------|-------------- +`subscribed`|`boolean`| Determines if notifications should be received from this repository. +`ignored`|`boolean`| Determines if all notifications should be blocked from this repository. + +{{#tip}} + +If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](#delete-a-repository-subscription) completely. + +{{/tip}} + +### Response + +<%= headers 200 %> +<%= json :repo_subscription %> + +## Delete a Repository Subscription + +{{#tip}} + +This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](#set-a-repository-subscription). + +{{/tip}} + + DELETE /repos/:owner/:repo/subscription + +### Response + +<%= headers 204 %> + +## Check if you are watching a repository (LEGACY) + +Requires for the user to be authenticated. + + GET /user/subscriptions/:owner/:repo + +### Response if this repository is watched by you + +<%= headers 204 %> + +### Response if this repository is not watched by you + +<%= headers 404 %> + +## Watch a repository (LEGACY) + +Requires the user to be authenticated. + + PUT /user/subscriptions/:owner/:repo + +<%= fetch_content(:put_content_length) %> + +### Response + +<%= headers 204 %> + +## Stop watching a repository (LEGACY) + +Requires for the user to be authenticated. + + DELETE /user/subscriptions/:owner/:repo + +### Response + +<%= headers 204 %> diff --git a/content/v3/auth.md b/content/v3/auth.md new file mode 100644 index 0000000000..ca387bfaa0 --- /dev/null +++ b/content/v3/auth.md @@ -0,0 +1,72 @@ +--- +title: Other Authentication Methods +--- + +# Other Authentication Methods + +{:toc} + +While the API provides multiple methods for authentication, we strongly +recommend using [OAuth](/v3/oauth/) for production applications. The other +methods provided are intended to be used for scripts or testing (i.e., cases +where full OAuth would be overkill). Third party applications that rely on +{{ site.data.variables.product.product_name }} for authentication should not ask for or collect {{ site.data.variables.product.product_name }} credentials. +Instead, they should use the [OAuth web flow](/v3/oauth). + +## Basic Authentication + +The API supports Basic Authentication as defined in +[RFC2617](http://www.ietf.org/rfc/rfc2617.txt) with a few slight differences. +The main difference is that the RFC requires unauthenticated requests to be +answered with `401 Unauthorized` responses. In many places, this would disclose +the existence of user data. Instead, the {{ site.data.variables.product.product_name }} API responds with `404 Not Found`. +This may cause problems for HTTP libraries that assume a `401 Unauthorized` +response. The solution is to manually craft the `Authorization` header. + +### Via Username and Password + +To use Basic Authentication with the {{ site.data.variables.product.product_name }} API, simply send the username and +password associated with the account. + +For example, if you're accessing the API via [cURL][curl], the following command +would authenticate you if you replace `null object.
+
+{{/tip}}
+
+
### Response
<%= headers 200 %>
<%= json :full_gist %>
+
+## List gist commits
+
+ GET /gists/:id/commits
+
+### Response
+
+<%= headers 200, :pagination => { :next => 'https://api.github.com/resource?page=2' } %>
+<%= json(:gist_history) %>
+
## Star a gist
PUT /gists/:id/star
+<%= fetch_content(:put_content_length) %>
+
### Response
<%= headers 204 %>
@@ -146,13 +211,28 @@ including the filename with a null hash.
## Fork a gist
- POST /gists/:id/fork
+ POST /gists/:id/forks
+
+{{#tip}}
+
+**Note**: This was previously `/gists/:id/fork`.
+
+{{/tip}}
### Response
-<%= headers 201, :Location => "https://api.github.com/gists/2" %>
+<%= headers 201, :Location => get_resource(:gist)['url'] %>
<%= json(:gist) %>
+## List gist forks
+
+ GET /gists/:id/forks
+
+### Response
+
+<%= headers 200, :pagination => default_pagination_rels %>
+<%= json(:gist_forks) %>
+
## Delete a gist
DELETE /gists/:id
@@ -162,3 +242,11 @@ including the filename with a null hash.
<%= headers 204 %>
[1]: /v3/oauth/#scopes
+
+## Custom media types
+
+The following media types are supported when fetching gist contents. You can read more about the
+use of media types in the API [here](/v3/media/).
+
+ application/vnd.github.VERSION.raw
+ application/vnd.github.VERSION.base64
diff --git a/content/v3/gists/comments.md b/content/v3/gists/comments.md
index f1399ef732..91249c09f6 100644
--- a/content/v3/gists/comments.md
+++ b/content/v3/gists/comments.md
@@ -1,12 +1,14 @@
---
-title: Gist Comments | GitHub API
+title: Gist Comments
---
-# Gist Comments API
+# Comments
-Gist Comments leverage [these](#custom-mime-types) custom mime types.
-You can read more about the use of mime types in the API
-[here](/v3/mime/).
+{:toc}
+
+Gist Comments use [these custom media types](#custom-media-types).
+You can read more about the use of media types in the API
+[here](/v3/media/).
## List comments on a gist
@@ -14,12 +16,12 @@ You can read more about the use of mime types in the API
### Response
-<%= headers 200 %>
+<%= headers 200, :pagination => default_pagination_rels %>
<%= json(:gist_comment) { |h| [h] } %>
## Get a single comment
- GET /gists/comments/:id
+ GET /gists/:gist_id/comments/:id
### Response
@@ -30,27 +32,30 @@ You can read more about the use of mime types in the API
POST /gists/:gist_id/comments
-### Input
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`body`|`string` | **Required**. The comment text.
-body
-: _Required_ **string**
<%= json :body => 'Just commenting for the sake of commenting' %>
### Response
-<%= headers 201,
- :Location => "https://api.github.com/gists/comments/1" %>
+<%= headers 201, :Location => get_resource(:gist_comment)['url'] %>
<%= json :gist_comment %>
## Edit a comment
- PATCH /gists/comments/:id
+ PATCH /gists/:gist_id/comments/:id
### Input
-body
-: _Required_ **string**
+Name | Type | Description
+-----|------|--------------
+`body`|`string` | **Required**. The comment text.
+
<%= json :body => 'Just commenting for the sake of commenting' %>
@@ -61,16 +66,16 @@ body
## Delete a comment
- DELETE /gists/comments/:id
+ DELETE /gists/:gist_id/comments/:id
### Response
<%= headers 204 %>
-## Custom Mime Types
+## Custom media types
-These are the supported mime types for gist comments. You can read more about the
-use of mime types in the API [here](/v3/mime/).
+These are the supported media types for gist comments. You can read more about the
+use of media types in the API [here](/v3/media/).
application/vnd.github.VERSION.raw+json
application/vnd.github.VERSION.text+json
diff --git a/content/v3/git.md b/content/v3/git.md
index d542550529..a7ec1bd618 100644
--- a/content/v3/git.md
+++ b/content/v3/git.md
@@ -1,11 +1,11 @@
---
-title: Git | GitHub API
+title: Git Data
---
-# Git DB API
+# Git Data
The Git Database API gives you access to read and write raw Git objects
-to your Git database on GitHub and to list and update your references
+to your Git database on {{ site.data.variables.product.product_name }} and to list and update your references
(branch heads and tags).
This basically allows you to reimplement a lot of Git functionality over
@@ -13,14 +13,14 @@ our API - by creating raw objects directly into the database and updating
branch references you could technically do just about anything that Git
can do without having Git installed.
-Git DB API functions will return a 409 if the git repo for a Repository is empty
+Git DB API functions will return a `409 Conflict` if the git repository for a Repository is empty
or unavailable. This typically means it is being created still. [Contact
-Support](https://github.com/contact) if this response status persists.
+Support](https://github.com/contact?form[subject]=Commits API) if this response status persists.
For more information on the Git object database, please read the
-Git Internals chapter of
+[Git Internals](http://git-scm.com/book/en/v1/Git-Internals) chapter of
the Pro Git book.
As an example, if you wanted to commit a change to a file in your
diff --git a/content/v3/git/blobs.md b/content/v3/git/blobs.md
index 9bdd659a4c..df84b5c41f 100644
--- a/content/v3/git/blobs.md
+++ b/content/v3/git/blobs.md
@@ -1,20 +1,21 @@
---
-title: Git Blobs | GitHub API
+title: Git Blobs
---
-# Blobs API
+# Blobs
-Since blobs can be any arbitrary binary data, the input and responses
-for the blob API takes an encoding parameter that can be either `utf-8`
-or `base64`. If your data cannot be losslessly sent as a UTF-8 string,
-you can base64 encode it.
+{:toc}
-Blobs leverage [these](#custom-mime-types) custom mime types. You can
-read more about the use of mime types in the API [here](/v3/mime/).
+Blobs leverage [these custom media types](#custom-media-types). You can
+read more about the use of media types in the API [here](/v3/media/).
## Get a Blob
- GET /repos/:user/:repo/git/blobs/:sha
+ GET /repos/:owner/:repo/git/blobs/:sha
+
+The `content` in the response will always be Base64 encoded.
+
+*Note*: This API supports blobs up to 100 megabytes in size.
### Response
@@ -23,22 +24,28 @@ read more about the use of mime types in the API [here](/v3/mime/).
## Create a Blob
- POST /repos/:user/:repo/git/blobs
+ POST /repos/:owner/:repo/git/blobs
+
+### Parameters
+
+Name | Type | Description
+-----|------|-------------
+`content`|`string` | **Required**. The new blob's content.
+`encoding`|`string` | The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. Default: `"utf-8"`.
-### Input
+### Example Input
<%= json :content => "Content of the blob", :encoding => "utf-8" %>
### Response
-<%= headers 201,
- :Location => "https://api.github.com/git/:user/:repo/blob/:sha" %>
-<%= json :sha => "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" %>
+<%= headers 201, :Location => get_resource(:blob_after_create)['url'] %>
+<%= json :blob_after_create %>
-## Custom Mime Types
+## Custom media types
-These are the supported mime types for blobs. You can read more about the
-use of mime types in the API [here](/v3/mime/).
+These are the supported media types for blobs. You can read more about the
+use of media types in the API [here](/v3/media/).
application/json
application/vnd.github.VERSION.raw
diff --git a/content/v3/git/commits.md b/content/v3/git/commits.md
index dc812cf962..69a0da52fe 100644
--- a/content/v3/git/commits.md
+++ b/content/v3/git/commits.md
@@ -1,12 +1,14 @@
---
-title: Git Commits | GitHub API
+title: Git Commits
---
-# Commits API
+# Commits
+
+{:toc}
## Get a Commit
- GET /repos/:user/:repo/git/commits/:sha
+ GET /repos/:owner/:repo/git/commits/:sha
### Response
@@ -15,46 +17,34 @@ title: Git Commits | GitHub API
## Create a Commit
- POST /repos/:user/:repo/git/commits
+ POST /repos/:owner/:repo/git/commits
### Parameters
-message
-: _String_ of the commit message
-
-tree
-: _String_ of the SHA of the tree object this commit points to
+Name | Type | Description
+-----|------|--------------
+`message`|`string` | **Required**. The commit message
+`tree`|`string` | **Required**. The SHA of the tree object this commit points to
+`parents`|`array` of `string`s| **Required**. The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
-parents
-: _Array_ of the SHAs of the commits that were the parents of this
-commit. If omitted or empty, the commit will be written as a root
-commit. For a single parent, an array of one SHA should be provided,
-for a merge commit, an array of more than one should be provided.
### Optional Parameters
+You can provide an additional `committer` parameter, which is an object containing
+information about the committer. Or, you can provide an `author` parameter, which
+is an object containing information about the author.
+
The `committer` section is optional and will be filled with the `author`
data if omitted. If the `author` section is omitted, it will be filled
-in with the authenticated users information and the current date.
-
-
-author.name
-: _String_ of the name of the author of the commit
+in with the authenticated user's information and the current date.
-author.email
-: _String_ of the email of the author of the commit
+Both the `author` and `committer` parameters have the same keys:
-author.date
-: _Timestamp_ of when this commit was authored
-
-committer.name
-: _String_ of the name of the committer of the commit
-
-committer.email
-: _String_ of the email of the committer of the commit
-
-committer.date
-: _Timestamp_ of when this commit was committed
+Name | Type | Description
+-----|------|-------------
+`name`|`string` | The name of the author (or committer) of the commit
+`email`|`string` | The email of the author (or committer) of the commit
+`date`|`string` | Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
### Example Input
@@ -67,7 +57,61 @@ committer.date
### Response
-<%= headers 201,
- :Location => "https://api.github.com/git/:user/:repo/commit/:sha" %>
+<%= headers 201, :Location => get_resource(:new_commit)['url'] %>
<%= json :new_commit %>
+{% if page.version == 'dotcom' %}
+
+## Commit signature verification
+
+{{#tip}}
+
+Commit response objects including signature verification data are currently available for developers to preview.
+During the preview period, the object formats may change without advance notice.
+Please see the [blog post](/changes/2016-04-04-git-signing-api-preview) for full details.
+
+To receive signature verification data in commit objects you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+ application/vnd.github.cryptographer-preview
+
+{{/tip}}
+
+ GET /repos/:owner/:repo/git/commits/:sha
+
+### Response
+
+<%= headers 200 %>
+<%= json(:signed_git_commit) %>
+
+### The `verification` object
+
+The response will include a `verification` field whose value is an object describing the result of verifying the commit's signature. The following fields are included in the `verification` object:
+
+Name | Type | Description
+-----|------|--------------
+`verified`|`boolean` | Does GitHub consider the signature in this commit to be verified?
+`reason`|`string` | The reason for `verified` value. Possible values and their meanings are enumerated in the table below.
+`signature`|`string` | The signature that was extracted from the commit.
+`payload`|`string` | The value that was signed.
+
+#### The `reason` field
+
+The following are possible `reason`s that may be included in the `verification` object:
+
+Value | Description
+------|------------
+`expired_key` | The key that made the signature is expired.
+`not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature.
+`gpgverify_error` | There was an error communicating with the signature-verification service.
+`gpgverify_unavailable` | The signature-verification service is currently unavailable.
+`unsigned` | The object does not include a signature.
+`unknown_signature_type` | A non-PGP signature was found in the commit.
+`no_user` | No user was associated with the `committer` email address in the commit.
+`unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account.
+`bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
+`unknown_key` | The key that made the signature has not been registered with any user's account.
+`malformed_signature` | There was an error parsing the signature.
+`invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature.
+`valid` | None of the above errors applied, so the signature is considered to be verified.
+
+{% endif %}
diff --git a/content/v3/git/import.md b/content/v3/git/import.md
deleted file mode 100644
index a96d53173c..0000000000
--- a/content/v3/git/import.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-title: Git Import | GitHub API
----
-
-# Import API
-
-`git fast-import` input parser
-
-Would this be cool?
-
-See the [Pro Git book](http://git-scm.com/book/ch8-2.html#a_custom_importer) or the
-[fast-import man page](http://www.kernel.org/pub/software/scm/git/docs/git-fast-import.html)
-for more information about the fast-import syntax.
-
-It would be awesome if there was some way to open up a streaming
-listener and just stream this data to it in order to:
-
-* import directly into github from the fast-export scripts that exist
- for multiple VCS systems
-
-* be able to easily import multiple objects - for instance a series of
- commits without having to make multiple git calls
-
-even without streaming capability, this might be pretty interesting
-functionality.
-
diff --git a/content/v3/git/refs.md b/content/v3/git/refs.md
index 5319af3829..ef4a444d92 100644
--- a/content/v3/git/refs.md
+++ b/content/v3/git/refs.md
@@ -1,25 +1,42 @@
---
-title: Git Refs | GitHub API
+title: Git Refs
---
-# References API
+# References
+
+{:toc}
## Get a Reference
- GET /repos/:user/:repo/git/refs/:ref
+ GET /repos/:owner/:repo/git/refs/:ref
The `ref` in the URL must be formatted as `heads/branch`, not just `branch`. For example, the call to get the data for a branch named `skunkworkz/featureA` would be:
- GET /repos/:user/:repo/git/refs/heads/skunkworkz/featureA
-
-### Response
+ GET /repos/:owner/:repo/git/refs/heads/skunkworkz/featureA
<%= headers 200 %>
<%= json :ref %>
+If the `ref` doesn't exist in the repository, but existing refs start with `ref`
+they will be returned as an array. For example, a call to get the data for a
+branch named `feature`, which doesn't exist, would return head refs
+including `featureA` and `featureB` which do.
+
+ GET /repos/:owner/:repo/git/refs/heads/feature
+
+<%= headers 200 %>
+<%= json :refs_matching %>
+
+If the `ref` doesn't match an existing ref or any prefixes a 404 will be returned.
+
+ GET /repos/:owner/:repo/git/refs/heads/feature-branch-that-no-longer-exists
+
+<%= headers 404 %>
+<%= json :refs_not_found %>
+
## Get all References
- GET /repos/:user/:repo/git/refs
+ GET /repos/:owner/:repo/git/refs
This will return an array of all the references on the system, including
things like notes and stashes if they exist on the server. Anything in
@@ -29,50 +46,47 @@ most common.
You can also request a sub-namespace. For example, to get all the tag
references, you can call:
- GET /repos/:user/:repo/git/refs/tags
+ GET /repos/:owner/:repo/git/refs/tags
For a full refs listing, you'll get something that looks like:
-<%= headers 200 %>
+<%= headers 200, :pagination => default_pagination_rels %>
<%= json :refs %>
## Create a Reference
- POST /repos/:user/:repo/git/refs
+ POST /repos/:owner/:repo/git/refs
### Parameters
-ref
-: _String_ of the name of the fully qualified reference (ie: `refs/heads/master`).
- If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
+Name | Type | Description
+-----|------|--------------
+`ref`|`type`| **Required**. The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
+`sha`|`type`| **Required**. The SHA1 value to set this reference to
-sha
-: _String_ of the SHA1 value to set this reference to
### Input
-<%= json "ref"=>"refs/heads/master",\
- "sha"=>"827efc6d56897b048c772eb4087f854f46256132" %>
+<%= json "ref"=>"refs/heads/featureA",\
+ "sha"=>"aa218f56b14c9653891f9e74264a383fa43fefbd" %>
### Response
-<%= headers 201 %>
+<%= headers 201, :Location => get_resource(:ref)['url'] %>
<%= json :ref %>
## Update a Reference
- PATCH /repos/:user/:repo/git/refs/:ref
+ PATCH /repos/:owner/:repo/git/refs/:ref
### Parameters
-sha
-: _String_ of the SHA1 value to set this reference to
+Name | Type | Description
+-----|------|--------------
+`sha`|`type`| **Required**. The SHA1 value to set this reference to
+`force`|`boolean`| Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. Default: `false`
-force
-: _Boolean_ indicating whether to force the update or to make sure the
-update is a fast-forward update. The default is `false`, so leaving this
-out or setting it to `false` will make sure you're not overwriting work.
### Input
@@ -81,13 +95,12 @@ out or setting it to `false` will make sure you're not overwriting work.
### Response
-<%= headers 200, \
- :Location => "https://api.github.com/git/:user/:repo/commit/:sha" %>
+<%= headers 200 %>
<%= json :ref %>
## Delete a Reference
- DELETE /repos/:user/:repo/git/refs/:ref
+ DELETE /repos/:owner/:repo/git/refs/:ref
Example: Deleting a branch:
@@ -100,4 +113,3 @@ Example: Deleting a tag:
### Response
<%= headers 204 %>
-
diff --git a/content/v3/git/tags.md b/content/v3/git/tags.md
index 3906c4af94..b0605da270 100644
--- a/content/v3/git/tags.md
+++ b/content/v3/git/tags.md
@@ -1,15 +1,17 @@
---
-title: Git Tags | GitHub API
+title: Git Tags
---
-# Tags API
+# Tags
+
+{:toc}
This tags API only deals with tag objects - so only annotated tags, not
lightweight tags.
## Get a Tag
- GET /repos/:user/:repo/git/tags/:sha
+ GET /repos/:owner/:repo/git/tags/:sha
### Response
@@ -20,40 +22,100 @@ lightweight tags.
Note that creating a tag object does not create the reference that
makes a tag in Git. If you want to create an annotated tag in Git,
-you have to do this call to create the tag object, and then create
-the `refs/tags/[tag]` reference. If you want to create a lightweight
-tag, you simply have to create the reference - this call would be
-unnecessary.
+you have to do this call to create the tag object, and then
+[create](/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference.
+If you want to create a lightweight tag, you only have to
+[create](/v3/git/refs/#create-a-reference) the tag reference - this call
+would be unnecessary.
- POST /repos/:user/:repo/git/tags
+ POST /repos/:owner/:repo/git/tags
### Parameters
-tag
-: _String_ of the tag
-
-message
-: _String_ of the tag message
+Name | Type | Description
+-----|------|--------------
+`tag`|`string`| The tag
+`message`|`string`| The tag message
+`object`|`string`| The SHA of the git object this is tagging
+`type`|`string`| The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.
+`tagger`|`object`| An object with information about the individual creating the tag.
-object
-: _String_ of the SHA of the git object this is tagging
+The `tagger` object contains the following keys:
-type
-: _String_ of the type of the object we're tagging. Normally this is a
-`commit` but it can also be a `tree` or a `blob`.
+Name | Type | Description
+-----|------|--------------
+`name`|`string`| The name of the author of the tag
+`email`|`string`| The email of the author of the tag
+`date`|`string`| When this object was tagged. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
-tagger.name
-: _String_ of the name of the author of the tag
-tagger.email
-: _String_ of the email of the author of the tag
+### Example Input
-tagger.date
-: _Timestamp_ of when this object was tagged
+<%= json "tag"=> "v0.0.1", \
+ "message" => "initial version\n", \
+ "object" => "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", \
+ "type" => "commit", \
+ "tagger"=> \
+ {"name" => "Scott Chacon", "email" => "schacon@gmail.com", \
+ "date" => "2011-06-17T14:53:35-07:00"} %>
### Response
-<%= headers 201,
- :Location => "https://api.github.com/repos/:user/:repo/git/tags/:sha" %>
+<%= headers 201, :Location => get_resource(:gittag)['url'] %>
<%= json :gittag %>
+{% if page.version == 'dotcom' %}
+
+## Tag signature verification
+
+{{#tip}}
+
+Tag response objects including signature verification data are currently available for developers to preview.
+During the preview period, the object formats may change without advance notice.
+Please see the [blog post](/changes/2016-04-04-git-signing-api-preview) for full details.
+
+To receive signature verification data in tag objects you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+ application/vnd.github.cryptographer-preview
+
+{{/tip}}
+
+ GET /repos/:owner/:repo/git/tags/:sha
+
+### Response
+
+<%= headers 200 %>
+<%= json(:signed_gittag) %>
+
+### The `verification` object
+
+The response will include a `verification` field whose value is an object describing the result of verifying the tag's signature. The following fields are included in the `verification` object:
+
+Name | Type | Description
+-----|------|--------------
+`verified`|`boolean` | Does GitHub consider the signature in this tag to be verified?
+`reason`|`string` | The reason for `verified` value. Possible values and their meanings are enumerated in the table below.
+`signature`|`string` | The signature that was extracted from the tag.
+`payload`|`string` | The value that was signed.
+
+#### The `reason` field
+
+The following are possible `reason`s that may be included in the `verification` object:
+
+Value | Description
+------|------------
+`expired_key` | The key that made the signature is expired.
+`not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature.
+`gpgverify_error` | There was an error communicating with the signature-verification service.
+`gpgverify_unavailable` | The signature-verification service is currently unavailable.
+`unsigned` | The object does not include a signature.
+`unkown_signature_type` | A non-PGP signature was found in the tag.
+`no_user` | No user was associated with the `tagger` email address in the tag.
+`unverified_email` | The `tagger` email address in the tag was associated with a user, but the email address is not verified on her/his account.
+`bad_email` | The `tagger` email address in the tag is not included in the identities of the PGP key that made the signature.
+`unknown_key` | The key that made the signature has not been registered with any user's account.
+`malformed_signature` | There was an error parsing the signature.
+`invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature.
+`valid` | None of the above errors applied, so the signature is considered to be verified.
+
+{% endif %}
diff --git a/content/v3/git/trees.md b/content/v3/git/trees.md
index 9941c76e69..485e622ada 100644
--- a/content/v3/git/trees.md
+++ b/content/v3/git/trees.md
@@ -1,24 +1,38 @@
---
-title: Git Trees | GitHub API
+title: Git Trees
---
-# Trees API
+# Trees
+
+{:toc}
## Get a Tree
- GET /repos/:user/:repo/git/trees/:sha
+ GET /repos/:owner/:repo/git/trees/:sha
### Response
+{{#tip}}
+
+If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.
+
+{{/tip}}
+
<%= headers 200 %>
<%= json :tree %>
## Get a Tree Recursively
- GET /repos/:user/:repo/git/trees/:sha?recursive=1
+ GET /repos/:owner/:repo/git/trees/:sha?recursive=1
### Response
+{{#tip}}
+
+If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
+
+{{/tip}}
+
<%= headers 200 %>
<%= json :tree_extra %>
@@ -29,42 +43,37 @@ tree and a nested path modifying that tree are specified, it will
overwrite the contents of that tree with the new path contents and write
a new tree out.
- POST /repos/:user/:repo/git/trees
+ POST /repos/:owner/:repo/git/trees
### Parameters
-base_tree
-: optional _String_ of the SHA1 of the tree you want to update with new data
-
-tree
-: _Array_ of _Hash_ objects (of `path`, `mode`, `type` and `sha`) specifying a tree structure
-
-tree.path
-: _String_ of the file referenced in the tree
+Name | Type | Description
+-----|------|--------------
+`tree`|`array` of `object`s | **Required**. Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure
+`base_tree`| `string` | The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.
-tree.mode
-: _String_ of the file mode - one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit) or `120000` for a blob that specifies the path of a symlink
+The `tree` parameter takes the following keys:
-tree.type
-: _String_ of `blob`, `tree`, `commit`
+Name | Type | Description
+-----|------|--------------
+`path`|`string`| The file referenced in the tree
+`mode`|`string`| The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink
+`type`| `string`| Either `blob`, `tree`, or `commit`
+`sha`|`string`| The SHA1 checksum ID of the object in the tree
+`content`|`string` | The content you want this file to have. {{ site.data.variables.product.product_name }} will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.
-tree.sha
-: _String_ of SHA1 checksum ID of the object in the tree
-
-tree.content
-: _String_ of content you want this file to have - GitHub will write this blob out and use that SHA for this entry. Use either this or `tree.sha`
### Input
-<%= json "tree"=> \
- [{"path"=>"file.rb", \
- "mode"=>"100644", \
- "type"=>"blob", \
- "sha"=>"44b4fc6d56897b048c772eb4087f854f46256132"}] %>
+<%= json \
+ "base_tree" => "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", \
+ "tree"=> \
+ [{"path"=>"file.rb", \
+ "mode"=>"100644", \
+ "type"=>"blob", \
+ "sha"=>"44b4fc6d56897b048c772eb4087f854f46256132"}] %>
### Response
-<%= headers 201,
- :Location => "https://api.github.com/repos/:user/:repo/git/trees/:sha" %>
+<%= headers 201, :Location => get_resource(:tree_new)['url'] %>
<%= json :tree_new %>
-
diff --git a/content/v3/gitignore.md b/content/v3/gitignore.md
new file mode 100644
index 0000000000..66fc12632d
--- /dev/null
+++ b/content/v3/gitignore.md
@@ -0,0 +1,61 @@
+---
+title: Gitignore
+---
+
+# Gitignore
+
+{:toc}
+
+When you create a new {{ site.data.variables.product.product_name }} repository via the API, you can specify a
+[.gitignore template][what-is] to apply to the repository upon creation. The
+.gitignore Templates API lists and fetches templates from the [{{ site.data.variables.product.product_name }} .gitignore repository][templates-repo].
+
+## Listing available templates
+
+List all templates available to pass as an option when [creating a repository][create-repo].
+
+ GET /gitignore/templates
+
+### Response
+
+<%= headers 200 %>
+<%= json(:templates) %>
+
+## Get a single template
+
+The API also allows fetching the source of a single template.
+
+ GET /gitignore/templates/C
+
+### Response
+
+<%= headers 200 %>
+<%= json(:template) %>
+
+Use the raw [media type][media-type] to get the raw contents.
+
+<%= headers 200 %>
++# Object files +*.o + +# Libraries +*.lib +*.a + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app ++ +[what-is]: https://help.github.com/articles/ignoring-files +[templates-repo]: https://github.com/github/gitignore +[create-repo]: /v3/repos/#create +[media-type]: /v3/media/ diff --git a/content/v3/issues.md b/content/v3/issues.md index d91cc690c8..59e7f99a29 100644 --- a/content/v3/issues.md +++ b/content/v3/issues.md @@ -1,177 +1,281 @@ --- -title: Issues | GitHub API +title: Issues --- -# Issues API +# Issues -Issues leverage [these](#custom-mime-types) custom mime types. You can -read more about the use of mime types in the API [here](/v3/mime/). +{:toc} -## List your issues +Issues use [these custom media types](#custom-media-types). You can +read more about the use of media types in the API [here](/v3/media/). + +## List issues + +<%= fetch_content(:prs_as_issues) %> + +List all issues **assigned** to the authenticated user across all visible repositories +including owned repositories, member repositories, and organization +repositories: GET /issues -### Parameters +{{#tip}} -filter -: * `assigned`: Issues assigned to you (default) - * `created`: Issues created by you - * `mentioned`: Issues mentioning you - * `subscribed`: Issues you're subscribed to updates for +You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. See the table below for more information. -state -: `open`, `closed`, default: `open` +{{/tip}} -labels -: _String_ list of comma separated Label names. Example: -`bug,ui,@high` +List all issues across owned and member repositories assigned to the authenticated user: -sort -: `created`, `updated`, `comments`, default: `created`. + GET /user/issues -direction -: `asc` or `desc`, default: `desc`. +List all issues for a given organization assigned to the authenticated user: -since -: _Optional_ **string** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ + GET /orgs/:org/issues + +### Parameters + +Name | Type | Description +-----|------|-------------- +`filter`|`string`| Indicates which sorts of issues to return. Can be one of:
* `assigned`: Issues assigned to you
* `created`: Issues created by you
* `mentioned`: Issues mentioning you
* `subscribed`: Issues you're subscribed to updates for
* `all`: All issues the authenticated user can see, regardless of participation or creation
Default: `assigned` +`state`|`string`| Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. Default: `open` +`labels`|`string`| A list of comma separated label names. Example: `bug,ui,@high` +`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `comments`. Default: `created` +`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`. Default: `desc` +`since`|`string` | Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:issue) { |h| [h] } %> -## List issues for a repository +{% if page.version == 'dotcom' %} +#### Reactions summary - GET /repos/:user/:repo/issues +{{#tip}} -### Parameters + + + An additional `reactions` object in the issue payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. -milestone -: * _Integer_ Milestone number - * `none` for Issues with no Milestone. - * `*` for Issues with any Milestone. + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: -state -: `open`, `closed`, default: `open` + application/vnd.github.squirrel-girl-preview -assignee -: * _String_ User login - * `none` for Issues with no assigned User. - * `*` for Issues with any assigned User. + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. -mentioned -: _String_ User login. +{{/tip}} +<%= json :issue_reaction_summary %> +{% endif %} + +## List issues for a repository -labels -: _String_ list of comma separated Label names. Example: -`bug,ui,@high` +<%= fetch_content(:prs_as_issues) %> -sort -: `created`, `updated`, `comments`, default: `created` + GET /repos/:owner/:repo/issues -direction -: `asc` or `desc`, default: `desc`. +### Parameters -since -: _Optional_ **string** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ +Name | Type | Description +-----|------|-------------- +`milestone`|`integer` or `string`| If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. +`state`|`string`| Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. Default: `open` +`assignee`|`string`| Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. +`creator`|`string`| The user that created the issue. +`mentioned`|`string`| A user that's mentioned in the issue. +`labels`|`string`| A list of comma separated label names. Example: `bug,ui,@high` +`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `comments`. Default: `created` +`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`. Default: `desc` +`since`|`string` |Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:issue) { |h| [h] } %> +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the issue payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :issue_reaction_summary %> +{% endif %} + ## Get a single issue - GET /repos/:user/:repo/issues/:number +<%= fetch_content(:prs_as_issues) %> + + GET /repos/:owner/:repo/issues/:number ### Response <%= headers 200 %> -<%= json :issue %> +<%= json :full_issue %> -## Create an issue +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} - POST /repos/:user/:repo/issues + -### Input + An additional `reactions` object in the issue payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. -title -: _Required_ **string** + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: -body -: _Optional_ **string** + application/vnd.github.squirrel-girl-preview -assignee -: _Optional_ **string** - Login for the user that this issue should be -assigned to. + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :issue_reaction_summary %> +{% endif %} + +## Create an issue + +Any user with pull access to a repository can create an issue. + + POST /repos/:owner/:repo/issues + +### Parameters -milestone -: _Optional_ **number** - Milestone to associate this issue with. +Name | Type | Description +-----|------|-------------- +`title`|`string` | **Required**. The title of the issue. +`body`|`string` | The contents of the issue. +`assignee`|`string` | Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is [deprecated](https://developer.github.com/v3/versions/#v3-deprecations).**_ +`milestone`|`integer` | The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ +`labels`|`array` of `strings` | Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ +`assignees`|`array` of `strings` | Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ -labels -: _Optional_ **array** of **strings** - Labels to associate with this -issue. +#### Example <%= json \ :title => "Found a bug", :body => "I'm having a problem with this.", :assignee => "octocat", + :assignees => [get_resource(:user)], :milestone => 1, - :labels => %w(Label1 Label2) + :labels => %w(bug) %> ### Response -<%= headers 201, - :Location => -'https://api.github.com/repos/user/repo/issues/1' %> -<%= json :issue %> +<%= headers 201, :Location => get_resource(:full_issue)['url'] %> +<%= json :full_issue %> ## Edit an issue - PATCH /repos/:user/:repo/issues/:number +Issue owners and users with push access can edit an issue. -### Input + PATCH /repos/:owner/:repo/issues/:number -title -: _Optional_ **string** - -body -: _Optional_ **string** - -assignee -: _Optional_ **string** - Login for the user that this issue should be -assigned to. - -state -: _Optional_ **string** - State of the issue: `open` or `closed`. +### Parameters -milestone -: _Optional_ **number** - Milestone to associate this issue with. +Name | Type | Description +-----|------|-------------- +`title`|`string` | The title of the issue. +`body`|`string` | The contents of the issue. +`assignee`|`string` | Login for the user that this issue should be assigned to. **This field is [deprecated](https://developer.github.com/v3/versions/#v3-deprecations).** +`state`|`string` | State of the issue. Either `open` or `closed`. +`milestone`|`integer` | The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ +`labels`|`array` of `strings` | Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ +`assignees`|`array` of `strings` | Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. .Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ -labels -: _Optional_ **array** of **strings** - Labels to associate with this -issue. Pass one or more Labels to _replace_ the set of Labels on this -Issue. Send an empty array (`[]`) to clear all Labels from the Issue. +#### Example <%= json \ :title => "Found a bug", :body => "I'm having a problem with this.", :assignee => "octocat", + :assignees => [get_resource(:user)], :milestone => 1, :state => "open", - :labels => %w(Label1 Label2) + :labels => %w(bug) %> ### Response <%= headers 200 %> -<%= json :issue %> +<%= json :full_issue %> + +{% if page.version == 'dotcom' or page.version >= 2.6 %} +## Lock an issue + +{% if page.version == 2.6 %} +{{#tip}} + + + + The API to lock an issue is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2016-02-11-issue-locking-api) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.the-key-preview+json + +{{/tip}} +{% endif %} + +Users with push access can lock an issue's conversation. + + PUT /repos/:owner/:repo/issues/:number/lock + +<%= fetch_content(:put_content_length) %> + +### Response + +<%= headers 204 %> + +## Unlock an issue + +{% if page.version == 2.6 %} +{{#tip}} + + + + The API to unlock an issue is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2016-02-11-issue-locking-api) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.the-key-preview+json + +{{/tip}} +{% endif %} + +Users with push access can unlock an issue's conversation. + + DELETE /repos/:owner/:repo/issues/:number/lock + +### Response + +<%= headers 204 %> + +{% endif %} -## Custom Mime Types +## Custom media types -These are the supported mime types for issues. You can read more about the -use of mime types in the API [here](/v3/mime/). +These are the supported media types for issues. You can read more about the +use of media types in the API [here](/v3/media/). application/vnd.github.VERSION.raw+json application/vnd.github.VERSION.text+json diff --git a/content/v3/issues/assignees.md b/content/v3/issues/assignees.md index b5e55254b9..4d0c1a59a0 100644 --- a/content/v3/issues/assignees.md +++ b/content/v3/issues/assignees.md @@ -1,26 +1,27 @@ --- -title: Issue Assignees | GitHub API +title: Issue Assignees --- -# Assignees API +# Assignees + +{:toc} ## List assignees -This call lists all the available assignees (owner + collaborators) to which -issues may be assigned. +This call lists all the [available assignees][] to which issues may be assigned. - GET /repos/:user/:repo/assignees + GET /repos/:owner/:repo/assignees ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> ## Check assignee You may also check to see if a particular user is an assignee for a repository. - GET /repos/:user/:repo/assignees/:assignee + GET /repos/:owner/:repo/assignees/:assignee ### Response @@ -32,3 +33,35 @@ If the given `assignee` login belongs to an assignee for the repository, a Otherwise a `404` status code is returned. <%= headers 404 %> + +[available assignees]: https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/ + +## Add assignees to an Issue + +This call adds the users passed in the `assignees` key (as their logins) to the issue. + + POST /repos/:owner/:repo/issues/:number/assignees + +### Input + +<%= json({"assignees" => %w(hubot other_assignee)}) %> + +### Response + +<%= headers 201 %> +<%= json :issue_with_assignees %> + +## Remove assignees from an Issue + +This call removes the users passed in the `assignees` key (as their logins) from the issue. + + DELETE /repos/:owner/:repo/issues/:number/assignees + +### Input + +<%= json({"assignees" => %w(hubot other_assignee)}) %> + +### Response + +<%= headers 200 %> +<%= json :issue_with_assignees %> diff --git a/content/v3/issues/comments.md b/content/v3/issues/comments.md index dfabba27ff..b9d077b4a0 100644 --- a/content/v3/issues/comments.md +++ b/content/v3/issues/comments.md @@ -1,62 +1,157 @@ --- -title: Issue Comments | GitHub API +title: Issue Comments --- -# Issue Comments API +# Comments + +{:toc} The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests. -Issue Comments leverage [these](#custom-mime-types) custom mime types. -You can read more about the use of mime types in the API -[here](/v3/mime/). +Issue Comments use [these custom media types](#custom-media-types). +You can read more about the use of media types in the API +[here](/v3/media/). ## List comments on an issue - GET /repos/:user/:repo/issues/:number/comments + GET /repos/:owner/:repo/issues/:number/comments + +Issue Comments are ordered by ascending ID. + +### Parameters + +Name | Type | Description +-----|------|-------------- +`since`|`string` | Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:issue_comment) { |h| [h] } %> -## Get a single comment +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the issue comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :issue_comment_reaction_summary %> +{% endif %} + +## List comments in a repository + + GET /repos/:owner/:repo/issues/comments + +By default, Issue Comments are ordered by ascending ID. + +### Parameters + +Name | Type | Description +-----|------|-------------- +`sort`|`string` | Either `created` or `updated`. Default: `created` +`direction`|`string` | Either `asc` or `desc`. Ignored without the `sort` parameter. +`since`|`string` | Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - GET /repos/:user/:repo/issues/comments/:id ### Response <%= headers 200 %> +<%= json(:issue_comment) { |h| [h] } %> + +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the issue comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :issue_comment_reaction_summary %> +{% endif %} + +## Get a single comment + + GET /repos/:owner/:repo/issues/comments/:id + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> <%= json :issue_comment %> +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the issue comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :issue_comment_reaction_summary %> +{% endif %} + ## Create a comment - POST /repos/:user/:repo/issues/:number/comments + POST /repos/:owner/:repo/issues/:number/comments ### Input -body -: _Required_ **string** +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The contents of the comment. -<%= json :body => "a new comment" %> + +<%= json :body => "Me too" %> ### Response -<%= headers 201, - :Location => -"https://api.github.com/repos/user/repo/issues/comments/1" %> +<%= headers 201, :Location => get_resource(:issue_comment)['url'] %> <%= json :issue_comment %> ## Edit a comment - PATCH /repos/:user/:repo/issues/comments/:id + PATCH /repos/:owner/:repo/issues/comments/:id ### Input -body -: _Required_ **string** +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The contents of the comment. + -<%= json :body => "String" %> +<%= json :body => "Me too" %> ### Response @@ -65,16 +160,16 @@ body ## Delete a comment - DELETE /repos/:user/:repo/issues/comments/:id + DELETE /repos/:owner/:repo/issues/comments/:id ### Response <%= headers 204 %> -## Custom Mime Types +## Custom media types -These are the supported mime types for issue comments. You can read more -about the use of mime types in the API [here](/v3/mime/). +These are the supported media types for issue comments. You can read more +about the use of media types in the API [here](/v3/media/). application/vnd.github.VERSION.raw+json application/vnd.github.VERSION.text+json diff --git a/content/v3/issues/events.md b/content/v3/issues/events.md index a73cd12c55..2b40755155 100644 --- a/content/v3/issues/events.md +++ b/content/v3/issues/events.md @@ -1,75 +1,143 @@ --- -title: Issue Events | GitHub API +title: Issue Events --- -# Issue Events API +# Events -Records various events that occur around an Issue or Pull Request. This is +{:toc} + +Records various events that occur around an issue or pull request. This is useful both for display on issue/pull request information pages and also to determine who should be notified of comments. ### Attributes -actor -: Always the User that generated the event. +
-
+
- id +
- The Integer ID of the event. + +
- url +
- The API URL for fetching the event. + +
- actor +
- The User object that generated the event. + +
- commit_id +
- The String SHA of a commit that referenced this Issue + +
- commit_url +
- The GitHub API link to a commit that referenced this Issue + +
- event +
- Identifies the actual type of Event that occurred. -commit_id -: The String SHA of a commit that referenced this Issue +
- created_at +
- The timestamp indicating when the event occurred. -event -: Identifies the actual type of Event that occurred. +
- label +
- The Label object including `name` and `color` attributes. Only provided for `labeled` + and `unlabeled` events. + +
- assignee +
- The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' and 'unassigned' events. + + {% if page.version == 'dotcom' or page.version > 2.5 %} +
- assigner +
- The User object that performed the assignment (or unassignment) for this Issue. Only provided for 'assigned' and 'unassigned' events. + {% endif %} + +
- milestone +
- The Milestone object including a `title` attribute. Only provided for `milestoned` and + `demilestoned` events. + +
- rename +
- An object containing rename details including `from` and `to` attributes. Only + provided for `renamed` events. +
-
+
- closed +
- The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using "closes / fixes #NN" - syntax. + syntax. + -reopened -: The issue was reopened by the actor. +
- reopened +
- The issue was reopened by the actor. -subscribed -: The actor subscribed to receive notifications for an issue. +
- subscribed +
- The actor subscribed to receive notifications for an issue. -merged -: The issue was merged by the actor. The `commit_id` attribute is the SHA1 of - the HEAD commit that was merged. +
- merged +
- The issue was merged by the actor. The `commit_id` attribute is the SHA1 of + the HEAD commit that was merged. -referenced -: The issue was referenced from a commit message. The `commit_id` attribute is - the commit SHA1 of where that happened. +
- referenced +
- The issue was referenced from a commit message. The `commit_id` attribute is + the commit SHA1 of where that happened. -mentioned -: The actor was @mentioned in an issue body. +
- mentioned +
- The actor was @mentioned in an issue body. -assigned -: The issue was assigned to the actor. +
- assigned +
- The issue was assigned to the actor. + +
- unassigned +
- The actor was unassigned from the issue. + +
- labeled +
- A label was added to the issue. + +
- unlabeled +
- A label was removed from the issue. + +
- milestoned +
- The issue was added to a milestone. + +
- demilestoned +
- The issue was removed from a milestone. + +
- renamed +
- The issue title was changed. + +
- locked +
- The issue was locked by the actor. + +
- unlocked +
- The issue was unlocked by the actor. + +
- head_ref_deleted +
- The pull request's branch was deleted. + +
- head_ref_restored +
- The pull request's branch was restored. +
-
+
- id +
- The Integer ID of the event. + +
- url +
- The API URL for fetching the event. + +
- actor +
- The User object that generated the event. + +
- commit_id +
- The String SHA of a commit that referenced this Issue. + +
- event +
- Identifies the actual type of Event that occurred. + +
- created_at +
- The timestamp indicating when the event occurred. + +
- label +
- The Label object including `name` and `color` attributes. Only provided for `labeled` + and `unlabeled` events. + +
- assignee +
- The User object which was assigned to (or unassigned from) this Issue. Only provided for `assigned` and `unassigned` events. + +
- milestone +
- The Milestone object including a `title` attribute. Only provided for `milestoned` and + `demilestoned` events. + +
- source +
- The `id`, `actor`, and `url` for the source of a reference from +another issue. Only provided for `cross-referenced` events. + +
- rename +
- An object containing rename details including `from` and `to` attributes. Only + provided for `renamed` events. +
-
+
- assigned +
- The issue was assigned to the assignee. + +
- closed +
- The issue was closed by the actor. When the commit_id is present, it + identifies the commit that closed the issue using "closes / fixes #NN" + syntax. + +
- commented +
- A comment was added to the issue. + +
- committed +
- A commit was added to the pull request's `HEAD` branch. Only +provided for pull requests. + +
- cross-referenced +
- The issue was referenced from another issue. The `source` +attribute contains the `id`, `actor`, and `url` of the reference's +source. + +
- demilestoned +
- The issue was removed from a milestone. + +
- head_ref_deleted +
- The pull request's branch was deleted. + +
- head_ref_restored +
- The pull request's branch was restored. + +
- labeled +
- A label was added to the issue. + +
- locked +
- The issue was locked by the actor. + +
- mentioned +
- The actor was @mentioned in an issue body. + +
- merged +
- The issue was merged by the actor. The `commit_id` attribute is the SHA1 of + the HEAD commit that was merged. + +
- milestoned +
- The issue was added to a milestone. + +
- referenced +
- The issue was referenced from a commit message. The `commit_id` attribute is + the commit SHA1 of where that happened. + +
- renamed +
- The issue title was changed. + +
- reopened +
- The issue was reopened by the actor. + +
- subscribed +
- The actor subscribed to receive notifications for an issue. + +
- unassigned +
- The assignee was unassigned from the issue. + +
- unlabeled +
- A label was removed from the issue. + +
- unlocked +
- The issue was unlocked by the actor. + +
- unsubscribed +
- The actor unsubscribed to stop receiving notifications for an issue. +
* `markdown` to render a document as plain Markdown, just like README files are rendered.
* `gfm` to render a document as user-content, _e.g._ like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly.
Default: `markdown` +`context`|`string` | The repository context. Only taken into account when rendering as `gfm` -context -: _Optional_ **string** - The repository context, only taken into account when rendering as `gfm` +#### Example <%= json \ :text => "Hello world github/linguist#1 **cool**, and #1!", @@ -34,11 +32,11 @@ context %(
Hello world github/linguist#1 cool, and #1!
), 200 %> -# Render a Markdown document in raw mode +## Render a Markdown document in raw mode POST /markdown/raw -### Input +### Parameters The raw API is not JSON-based. It takes a Markdown document as plaintext (`text/plain` or `text/x-markdown`) and renders it as plain Markdown without a repository context (just like a README.md file is rendered -- this is the simplest way to preview a readme online). diff --git a/content/v3/media.md b/content/v3/media.md new file mode 100644 index 0000000000..539acc407c --- /dev/null +++ b/content/v3/media.md @@ -0,0 +1,164 @@ +--- +title: Media Types +--- +# Media Types + +{:toc} + +Custom media types are used in the API to let consumers choose the format +of the data they wish to receive. This is done by adding one or more of +the following types to the `Accept` header when you make a request. Media types +are specific to resources, allowing them to change independently and support +formats that other resources don't. + +All {{ site.data.variables.product.product_name }} media types look like this: + + application/vnd.github[.version].param[+json] + +The most basic media types the API supports are: + + application/json + application/vnd.github+json + +Neither of these specify a [version][versions], so you will always get the +current default JSON representation of resources. + +
+
+
+You can specify a version like so:
+
+ application/vnd.github.v3+json
+
+If you're specifying a property (such as full/raw/etc defined below),
+put the version before the property:
+
+ application/vnd.github.v3.raw+json
+
+You can check the current version through every response's headers. Look
+for the `X-GitHub-Media-Type` header:
+
+``` command-line
+$ curl {{ site.data.variables.product.api_url_pre }}/users/technoweenie -I
+> HTTP/1.1 200 OK
+> X-GitHub-Media-Type: github.v3
+
+$ curl {{ site.data.variables.product.api_url_pre }}/users/technoweenie -I \
+$ -H "Accept: application/vnd.github.full+json"
+> HTTP/1.1 200 OK
+> X-GitHub-Media-Type: github.v3; param=full; format=json
+
+$ curl {{ site.data.variables.product.api_url_pre }}/users/technoweenie -I \
+$ -H "Accept: application/vnd.github.v3.full+json"
+> HTTP/1.1 200 OK
+> X-GitHub-Media-Type: github.v3; param=full; format=json
+```
+
+## Comment Body Properties
+
+The body of a comment can be written in [GitHub Flavored Markdown][gfm].
+Issues, Issue Comments, Pull Request Comments, and Gist Comments all
+accept these same media types:
+
+### Raw
+
+ application/vnd.github.VERSION.raw+json
+
+Return the raw markdown body. Response will include `body`. This is the
+default if you do not pass any specific media type.
+
+### Text
+
+ application/vnd.github.VERSION.text+json
+
+Return a text only representation of the markdown body. Response will
+include `body_text`.
+
+### HTML
+
+ application/vnd.github.VERSION.html+json
+
+Return HTML rendered from the body's markdown. Response will include
+`body_html`.
+
+### Full
+
+ application/vnd.github.VERSION.full+json
+
+Return raw, text and HTML representations. Response will include `body`,
+`body_text`, and `body_html`:
+
+## Git Blob Properties
+
+The following media types are allowed when getting a blob:
+
+### JSON
+
+ application/vnd.github.VERSION+json
+ application/json
+
+Return JSON representation of the blob with `content` as a base64
+encoded string. This is the default if nothing is passed.
+
+### Raw
+
+ application/vnd.github.VERSION.raw
+
+Return the raw blob data.
+
+## Commits, Commit comparison, and Pull Requests
+
+The Commit, Commit Comparison, and Pull Request resources support
+[diff][git-diff] and [patch][git-patch] formats:
+
+### diff
+
+ application/vnd.github.VERSION.diff
+
+### patch
+
+ application/vnd.github.VERSION.patch
+
+### sha
+
+ application/vnd.github.VERSION.sha
+
+## Repository contents
+
+### Raw
+
+ application/vnd.github.VERSION.raw
+
+Return the raw contents of a file. This is the default if you do not pass any specific media type.
+
+### HTML
+
+ application/vnd.github.VERSION.html
+
+For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup).
+
+## Gists
+
+### Raw
+
+ application/vnd.github.VERSION.raw
+
+Return the raw contents of a gist. This is the default if you do not pass any specific media type.
+
+### base64
+
+ application/vnd.github.VERSION.base64
+
+The gist contents are base64-encoded before being sent out. This can be useful if your gist contains any invalid UTF-8 sequences.
+
+[gfm]:http://github.github.com/github-flavored-markdown/
+[git-diff]: http://git-scm.com/docs/git-diff
+[git-patch]: http://git-scm.com/docs/git-format-patch
+[hypermedia]: /v3/#hypermedia
+[versions]: /v3/versions
diff --git a/content/v3/meta.md b/content/v3/meta.md
new file mode 100644
index 0000000000..6ba388351d
--- /dev/null
+++ b/content/v3/meta.md
@@ -0,0 +1,33 @@
+---
+title: Meta
+---
+
+# Meta
+
+{% if page.version == 'dotcom' %}
+
+This endpoint provides information about GitHub.com, the service.
+
+{% else %}
+
+If you access this endpoint on your organization's [GitHub Enterprise](https://enterprise.github.com/) installation, this endpoint provides information about that installation.
+
+{% endif %}
+
+ GET /meta
+
+### Response
+
+<%= headers 200 %>
+<%= json :meta %>
+
+### Body
+
+Name | Type | Description
+-----|------|--------------
+`verifiable_password_authentication`|`boolean` | Whether authentication with username and password is supported. {% if page.version != 'dotcom' %}GitHub Enterprise instances using CAS or OAuth for authentication will return `false`. Features like [Basic Authentication with a username and password](/v3/auth/#via-username-and-password), [sudo mode](https://help.github.com/articles/sudo-mode), and [two-factor authentication](https://help.github.com/articles/about-two-factor-authentication) are not supported on these servers.{% endif %}
+`github_services_sha` | `string` | The currently-deployed SHA of [`github-services`](https://github.com/github/github-services).
+`hooks`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from on GitHub.com. Subscribe to the [API Changes blog](https://developer.github.com/changes/) or follow [@GitHubAPI](https://twitter.com/GitHubAPI) on Twitter to get updated when this list changes.
+`git`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the Git servers for GitHub.com.
+`pages`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the A records for [GitHub Pages](https://pages.github.com/).
+`importer`|`array` of `strings` | An Array of IP addresses specifying the addresses that source imports will originate from on GitHub.com.
diff --git a/content/v3/migration.md b/content/v3/migration.md
new file mode 100644
index 0000000000..5291cd5928
--- /dev/null
+++ b/content/v3/migration.md
@@ -0,0 +1,29 @@
+---
+title: Migration
+---
+
+# Migration
+
+These APIs help you move projects to or from {{ site.data.variables.product.product_name }}.
+
+{% if page.version == 'dotcom' %}
+
+## [Enterprise Migrations][migrations]
+
+The [Enterprise Migrations API][migrations] lets you move a repository from GitHub to GitHub Enterprise.
+
+## [Source Imports][source_imports]
+
+The [Source Imports API][source_imports] lets you import a source repository to
+{{ site.data.variables.product.product_name }}.
+
+{% else %}
+
+The migration APIs are only available on github.com. To learn more about migration,
+read the [API documentation on github.com](https://developer.github.com/v3/migration/)
+or check out the [Enterprise Migration Guide](https://help.github.com/enterprise/admin/guides/migrations/).
+
+{% endif %}
+
+[migrations]: /v3/migration/migrations/
+[source_imports]: /v3/migration/source_imports/
diff --git a/content/v3/migration/migrations.md b/content/v3/migration/migrations.md
new file mode 100644
index 0000000000..be76e44e2e
--- /dev/null
+++ b/content/v3/migration/migrations.md
@@ -0,0 +1,115 @@
+---
+title: Migrations
+---
+
+# Migrations
+
+{:toc}
+
+The Migrations API *is only available to [authenticated](https://developer.github.com/v3/#authentication) organization [owners](https://help.github.com/articles/permission-levels-for-an-organization/)*.
+
+{% if page.version != 'dotcom' %}
+
+{{#warning}}
+
+This API is not currently available on GitHub Enterprise.
+
+{{/warning}}
+
+{% endif %}
+
+{{#tip}}
+
+ To access the Migrations API, you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+ application/vnd.github.wyandotte-preview+json
+
+{{/tip}}
+
+## Start a migration
+
+Initiates the generation of a migration archive.
+
+ POST /orgs/:org/migrations
+
+### Parameters
+
+Name | Type | Description
+--------|---------|--------------
+`repositories` | `array` of `strings` | **Required**. A list of arrays indicating which repositories should be migrated.
+`lock_repositories`|`boolean` | Indicates whether repositories should be locked (to prevent manipulation) while migrating data. Default: `false`.
+`exclude_attachments`|`boolean` | Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). Default: `false`.
+
+### Example
+
+<%= json \
+ :repositories => ["octocat/Hello-World"],
+ :lock_repositories => true
+%>
+
+### Response
+
+<%= headers 201 %>
+<%= json(:migrations) %>
+
+## Get a list of migrations
+
+Lists the most recent migrations.
+
+ GET /orgs/:org/migrations
+
+### Response
+
+<%= headers 200, :pagination => default_pagination_rels %>
+<%= json(:migrations) { |h| [h] } %>
+
+## Get the status of a migration
+
+Fetches the status of a migration.
+
+ GET /orgs/:org/migrations/:id
+
+### Response
+
+The `state` of a migration can be one of the following values:
+
+* `pending`, which means the migration hasn't started yet.
+* `exporting`, which means the migration is in progress.
+* `exported`, which means the migration finished successfully.
+* `failed`, which means the migration failed.
+
+<%= headers 200 %>
+<%= json(:migrations) { |h| h['state'] = 'exported'; h } %>
+
+## Download a migration archive
+
+Fetches the URL to a migration archive.
+
+ GET /orgs/:org/migrations/:id/archive
+
+### Response
+
+<%= headers 302 %>
+
+ Important: The default version of the API may change in the
+ future. If you're building an application and care about the stability of
+ the API, be sure to request a specific version in the Accept
+ header as shown in the examples below.
+
+https://s3.amazonaws.com/github-cloud/migration/79/67?response-content-disposition=filename%3D0b989ba4-242f-11e5-81e1.tar.gz&response-content-type=application/x-gzip
++
+
+
+# OAuth Authorizations API
+
+{:toc}
+
+You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/v3/auth#basic-authentication) using your username and password, not tokens.
+
+Make sure you understand how to [work with two-factor authentication](/v3/auth/#working-with-two-factor-authentication) if you or your users have two-factor authentication enabled.
+
+{% if page.version == 'dotcom' or page.version > 2.6 %}
+
+## List your grants
+
+You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](/v3/oauth_authorizations/#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub][authorized-application-listing]. The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`.
+
+ GET /applications/grants
+
+### Response
+
+<%= headers 200, :pagination => default_pagination_rels %>
+<%= json(:oauth_authorization) { |h| [h] } %>
+
+## Get a single grant
+
+ GET /applications/grants/:id
+
+### Response
+
+<%= headers 200 %>
+<%= json(:oauth_authorization) %>
+
+## Delete a grant
+
+Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub][authorized-application-listing].
+
+ DELETE /applications/grants/:id
+
+### Response
+
+<%= headers 204 %>
+
+{% endif %}
+
+## List your authorizations
+
+ GET /authorizations
+
+### Response
+
+<%= headers 200, :pagination => default_pagination_rels %>
+<%= json(:oauth_access) { |h| [h.merge("token" => "")] } %>
+
+## Get a single authorization
+
+ GET /authorizations/:id
+
+### Response
+
+<%= headers 200 %>
+<%= json(:oauth_access) { |h| h.merge("token" => "") } %>
+
+## Create a new authorization
+
+If you need a small number of tokens, implementing the [web flow](/v3/oauth/#web-application-flow)
+can be cumbersome. Instead, tokens can be created using the OAuth Authorizations API using
+[Basic Authentication](/v3/auth#basic-authentication). To create tokens for a particular OAuth application, you
+must provide its client ID and secret, found on the OAuth application settings
+page, linked from your [OAuth applications listing on GitHub][app-listing]. If your OAuth application intends to create multiple tokens for one user you should use `fingerprint` to differentiate between them. OAuth tokens
+can also be created through the web UI via the [Personal access tokens settings][tokens-listing].
+Read more about these tokens on the [GitHub Help page](https://help.github.com/articles/creating-an-access-token-for-command-line-use).
+
+ POST /authorizations
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`scopes`|`array` | A list of scopes that this authorization is in.
+`note`|`string` | **Required**. A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.
+`note_url`|`string` | A URL to remind you what app the OAuth token is for.
+`client_id`|`string` | The 20 character OAuth app client key for which to create the token.
+`client_secret`|`string` | The 40 character OAuth app client secret for which to create the token.
+`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client ID and user.
+
+
+<%= json :scopes => ["public_repo"], :note => 'admin script' %>
+
+### Response
+
+<%= headers 201, :Location => get_resource(:oauth_access)['url'] %>
+<%= json(:oauth_access) { |h| h.merge("fingerprint" => "") } %>
+
+## Get-or-create an authorization for a specific app
+
+This method will create a new authorization for the specified OAuth application,
+only if an authorization for that application doesn't already exist for the
+user. The URL includes the 20 character client ID for the OAuth app that is
+requesting the token. It returns the user's existing authorization for the
+application if one is present. Otherwise, it creates and returns a new one.
+
+ PUT /authorizations/clients/:client_id
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`client_secret`|`string`| **Required**. The 40 character OAuth app client secret associated with the client ID specified in the URL.
+`scopes`|`array` | A list of scopes that this authorization is in.
+`note`|`string` | A note to remind you what the OAuth token is for.
+`note_url`|`string` | A URL to remind you what app the OAuth token is for.
+{% if page.version == 'dotcom' or page.version > 2.2 %}`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).{% endif %}
+
+
+<%= json :client_secret => "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd", :scopes => ["public_repo"], :note => 'admin script' %>
+
+### Response if returning a new token
+
+<%= headers 201, :Location => get_resource(:oauth_access)['url'] %>
+<%= json(:oauth_access) { |h| h.merge("fingerprint" => "") } %>
+
+### Response if returning an existing token
+
+<%= headers 200, :Location => get_resource(:oauth_access)['url'] %>
+<%= json(:oauth_access) { |h| h.merge("token" => "", "fingerprint" => "") } %>
+
+{% if page.version == 'dotcom' or page.version > 2.2 %}
+
+## Get-or-create an authorization for a specific app and fingerprint
+
+This method will create a new authorization for the specified OAuth application,
+only if an authorization for that application and fingerprint do not already
+exist for the user. The URL includes the 20 character client ID for the OAuth
+app that is requesting the token. `fingerprint` is a unique string to
+distinguish an authorization from others created for the same client ID and
+user. It returns the user's existing authorization for the application if one
+is present. Otherwise, it creates and returns a new one.
+
+ PUT /authorizations/clients/:client_id/:fingerprint
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`client_secret`|`string`| **Required**. The 40 character OAuth app client secret associated with the client ID specified in the URL.
+`scopes`|`array` | A list of scopes that this authorization is in.
+`note`|`string` | A note to remind you what the OAuth token is for.
+`note_url`|`string` | A URL to remind you what app the OAuth token is for.
+
+
+<%= json :client_secret => "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd", :scopes => ["public_repo"], :note => 'admin script' %>
+
+### Response if returning a new token
+
+<%= headers 201, :Location => get_resource(:oauth_access)['url'] %>
+<%= json :oauth_access %>
+
+### Response if returning an existing token
+
+<%= headers 200, :Location => get_resource(:oauth_access)['url'] %>
+<%= json(:oauth_access) { |h| h.merge("token" => "") } %>
+
+{% endif %}
+
+## Update an existing authorization
+
+ PATCH /authorizations/:id
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`scopes`|`array` | Replaces the authorization scopes with these.
+`add_scopes`|`array` | A list of scopes to add to this authorization.
+`remove_scopes`|`array` | A list of scopes to remove from this authorization.
+`note`|`string` | A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.
+`note_url`|`string` | A URL to remind you what app the OAuth token is for.
+`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client ID and user.
+
+
+You can only send one of these scope keys at a time.
+
+<%= json :add_scopes => ['repo'], :note => 'admin script' %>
+
+### Response
+
+<%= headers 200 %>
+<%= json(:oauth_access) { |h| h.merge("token" => "") } %>
+
+## Delete an authorization
+
+ DELETE /authorizations/:id
+
+### Response
+
+<%= headers 204 %>
+
+## Check an authorization
+
+OAuth applications can use a special API method for checking OAuth token
+validity without running afoul of normal rate limits for failed login attempts.
+Authentication works differently with this particular endpoint. You must use
+[Basic Authentication](/v3/auth#basic-authentication) when accessing it, where the username is the OAuth
+application `client_id` and the password is its `client_secret`. Invalid tokens
+will return `404 NOT FOUND`.
+
+ GET /applications/:client_id/tokens/:access_token
+
+### Response
+
+<%= headers 200 %>
+<%= json(:oauth_access_with_user) %>
+
+## Reset an authorization
+
+OAuth applications can use this API method to reset a valid OAuth token without
+end user involvement. Applications must save the "token" property in the
+response, because changes take effect immediately. You must use
+[Basic Authentication](/v3/auth#basic-authentication) when accessing it, where
+the username is the OAuth application `client_id` and the password is its
+`client_secret`. Invalid tokens will return `404 NOT FOUND`.
+
+ POST /applications/:client_id/tokens/:access_token
+
+### Response
+
+<%= headers 200 %>
+<%= json(:oauth_access_with_user) %>
+
+## Revoke an authorization for an application
+
+OAuth application owners can also revoke a single token for an OAuth
+application. You must use [Basic Authentication](/v3/auth#basic-authentication)
+for this method, where the username is the OAuth application `client_id` and
+ the password is its `client_secret`.
+
+ DELETE /applications/:client_id/tokens/:access_token
+
+### Response
+
+<%= headers 204 %>
+
+## More Information
+
+
+It can be a little tricky to get started with OAuth. Here are a few
+links that might be of help:
+
+* [OAuth 2 spec](http://tools.ietf.org/html/rfc6749)
+* [Facebook Login API](http://developers.facebook.com/docs/technical-guides/login/)
+* [Ruby OAuth2 lib](https://github.com/intridea/oauth2)
+* [Simple Ruby/Sinatra example](https://gist.github.com/9fd1a6199da0465ec87c)
+* [Python Flask example](https://gist.github.com/ib-lundgren/6507798) using [requests-oauthlib](https://github.com/requests/requests-oauthlib)
+* [Simple Python example](https://gist.github.com/e3fbd47fbb7ee3c626bb) using [python-oauth2](https://github.com/dgouldin/python-oauth2)
+* [Ruby OmniAuth example](https://github.com/intridea/omniauth)
+* [Ruby Sinatra extension](https://github.com/atmos/sinatra_auth_github)
+* [Ruby Warden strategy](https://github.com/atmos/warden-github)
+
+[app-listing]: https://github.com/settings/developers
+[tokens-listing]: https://github.com/settings/tokens
+[authorized-application-listing]: https://github.com/settings/applications#authorized
+[basics auth guide]: /guides/basics-of-authentication/
diff --git a/content/v3/orgs.md b/content/v3/orgs.md
index 5dcd67ff85..aa7419a031 100644
--- a/content/v3/orgs.md
+++ b/content/v3/orgs.md
@@ -1,25 +1,71 @@
---
-title: Organizations | GitHub API
+title: Organizations
---
-# Orgs API
+# Organizations
-## List
+{:toc}
-List all public organizations for a user.
+## List your organizations
- GET /users/:user/orgs
+List organizations for the authenticated user.
-List public and private organizations for the authenticated user.
+### OAuth scope requirements
+
+This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
GET /user/orgs
### Response
-<%= headers 200, :pagination => true %>
+<%= headers 200, :pagination => default_pagination_rels %>
+<%= json(:org) { |h| [h] } %>
+
+{% if page.version == 'dotcom' or page.version >= 2.3 %}
+
+## List all organizations
+
+Lists all organizations, in the order that they were created on {{ site.data.variables.product.product_name }}.
+
+Note: Pagination is powered exclusively by the `since` parameter.
+Use the [Link header](/v3/#link-header) to get the URL for the next page of
+organizations.
+
+ GET /organizations
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`since`|`string`| The integer ID of the last Organization that you've seen.
+
+### Response
+
+<%= headers 200, :pagination => { :next => 'https://api.github.com/organizations?since=135' } %>
+<%= json(:org) {|h| [h] } %>
+
+{% endif %}
+
+## List user organizations
+
+List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.
+
+This method only lists *public* memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List your organizations](#list-your-organizations) API instead.
+
+ GET /users/:username/orgs
+
+### Response
+
+<%= headers 200, :pagination => default_pagination_rels %>
<%= json(:org) { |h| [h] } %>
-## Get
+## Get an organization
+
+{% if page.version == 'dotcom' or page.version >= 2.8 %}
+Note: To receive values for `private_gists`, `disk_usage`, `collaborators`, and
+`billing_email` in the Organization response, the authenticated user must be an
+organization owner and have authorized the `admin:org` scope.
+{% endif %}
GET /orgs/:org
@@ -28,27 +74,22 @@ List public and private organizations for the authenticated user.
<%= headers 200 %>
<%= json(:full_org) %>
-## Edit
+## Edit an organization
PATCH /orgs/:org
### Input
-billing_email
-: _Optional_ **string** - Billing email address. This address is not
-publicized.
-
-company
-: _Optional_ **string**
-
-email
-: _Optional_ **string** - Publicly visible email address.
-
-location
-: _Optional_ **string**
+Name | Type | Description
+-----|------|--------------
+`billing_email`|`string` | Billing email address. This address is not publicized.
+`company`|`string` | The company name.
+`email`|`string` | The publicly visible email address.
+`location`|`string` | The location.
+`name`|`string` | The shorthand name of the company.
+`description`|`string` | The description of the company.
-name
-: _Optional_ **string**
+### Example
<%= json \
:billing_email => "support@github.com",
@@ -56,7 +97,8 @@ name
:company => "GitHub",
:email => "support@github.com",
:location => "San Francisco",
- :name => "github"
+ :name => "github",
+ :description => "GitHub, the company."
%>
### Response
diff --git a/content/v3/orgs/hooks.md b/content/v3/orgs/hooks.md
new file mode 100644
index 0000000000..a00c5c4836
--- /dev/null
+++ b/content/v3/orgs/hooks.md
@@ -0,0 +1,169 @@
+---
+title: Organization Webhooks
+---
+
+# Webhooks
+
+{:toc}
+
+{% if page.version != 'dotcom' and page.version <= 2.2 %}
+
+{{#tip}}
+
+The Organization Webhooks API is currently available for developers to preview.
+During the preview period, the API may change without advance notice.
+Please see the [blog post](/changes/2014-12-03-preview-the-new-organization-webhooks-api/) for full details.
+
+To access the API during the preview period, you must provide a custom [media type](/enterprise/{{ page.version }}/v3/media) in the `Accept` header:
+
+```
+application/vnd.github.sersi-preview+json
+```
+
+{{/tip}}
+
+{% endif %}
+
+Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to actions on GitHub.com. For more information on actions you can subscribe to, check out our [Events documentation][webhook-events].
+
+## Scopes & Restrictions
+
+All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require [the `admin:org_hook` scope](/v3/oauth/#scopes).
+
+In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules:
+
+- OAuth applications cannot list, view, or edit webhooks which they did not create.
+- Users cannot list, view, or edit webhooks which were created by OAuth applications.
+
+## List hooks
+
+ GET /orgs/:org/hooks
+
+### Response
+
+<%= headers 200, :pagination => default_pagination_rels %>
+<%= json(:org_hook) { |h| [h] } %>
+
+
+## Get single hook
+
+ GET /orgs/:org/hooks/:id
+
+### Response
+
+<%= headers 200 %>
+<%= json :org_hook %>
+
+
+## Create a hook
+
+ POST /orgs/:org/hooks
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`name`|`string` | **Required**. Must be passed as "web".
+`config`|`object` | **Required**. Key/value pairs to provide settings for this webhook. [These are defined below](#create-hook-config-params).
+`events`|`array` | Determines what [events][event-types] the hook is triggered for. Default: `["push"]`.
+`active`|`boolean` | Determines whether the hook is actually triggered on pushes.
+
+
+The `config` object can accept the following keys:
+
+<%= fetch_content(:org_hook_config_hash) %>
+
+#### Example
+
+Here's how you can create a hook that posts payloads in JSON format:
+
+<%= json \
+ :name => "web",
+ :active => true,
+ :events => ['push', 'pull_request'],
+ :config => {
+ :url => 'http://example.com/webhook',
+ :content_type => 'json'}
+%>
+
+### Response
+
+<%= headers 201, :Location => get_resource(:org_hook)['url'] %>
+<%= json :org_hook %>
+
+
+## Edit a hook
+
+ PATCH /orgs/:org/hooks/:id
+
+### Parameters
+
+Name | Type | Description
+-----|------|--------------
+`config`|`object` | **Required**. Key/value pairs to provide settings for this webhook. [These are defined below](#update-hook-config-params).
+`events`|`array` | Determines what [events][event-types] the hook is triggered for. Default: `["push"]`.
+`active`|`boolean` | Determines whether the hook is actually triggered on pushes.
+
+
+The `config` object can accept the following keys:
+
+<%= fetch_content(:org_hook_config_hash) %>
+
+
+#### Example
+
+<%= json \
+ :active => true,
+ :events => ['pull_request']
+%>
+
+### Response
+
+<%= headers 200 %>
+<%= json(:org_hook) { |h| h.merge "events" => %w(pull_request) } %>
+
+
+## Ping a hook
+
+This will trigger a [ping event][ping-event-url] to be sent to the hook.
+
+ POST /orgs/:org/hooks/:id/pings
+
+### Response
+
+<%= headers 204 %>
+
+
+## Delete a hook
+
+ DELETE /orgs/:org/hooks/:id
+
+### Response
+
+<%= headers 204 %>
+
+
+## Receiving Webhooks
+
+In order for {{ site.data.variables.product.product_name }} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS.
+
+For more best practices, [see our guide][best-integration-practices].
+
+### Webhook Headers
+
+{{ site.data.variables.product.product_name }} will send along several HTTP headers to differentiate between event types and payload identifiers.
+
+Name | Description
+-----|-----------|
+`X-GitHub-Event` | The [event type](/v3/activity/events/types/) that was triggered.
+`X-GitHub-Delivery` | A [guid][guid] to identify the payload and event being sent.
+`X-Hub-Signature` | The value of this header is computed as the HMAC hex digest of the body, using the `secret` config option as the key.
+
+
+[guid]: http://en.wikipedia.org/wiki/Globally_unique_identifier
+[ping-event-url]: /webhooks/#ping-event
+[webhook-events]: /webhooks/#events
+[event-types]: /v3/activity/events/types/
+[media-type]: /v3/media
+[best-integration-practices]: /guides/best-practices-for-integrators/
+[developer-blog-post]: /changes/2014-12-03-preview-the-new-organization-webhooks-api/
diff --git a/content/v3/orgs/members.md b/content/v3/orgs/members.md
index 38e2e9881d..6f1b79abe4 100644
--- a/content/v3/orgs/members.md
+++ b/content/v3/orgs/members.md
@@ -1,52 +1,103 @@
---
-title: Organization Members | GitHub API
+title: Organization Members
---
-# Org Members API
+# Members
-## List members
+{:toc}
-List all users who are members of an organization. A member is a user
-that belongs to at least 1 team in the organization. If the authenticated user is
-also a member of this organization then both concealed and public
-members will be returned. Otherwise only public members are returned.
+## Members list
+
+List all users who are members of an organization. If the authenticated user is
+also a member of this organization then both concealed and public members will
+be returned.
GET /orgs/:org/members
+
+
+### Parameters
+
+Name | Type | Description
+--------|---------|--------------
+`filter`|`string` | Filter members returned in the list. Can be one of:Deprecation Notice
+ +
+ The token attribute is deprecated in all
+ of the following OAuth Authorizations API responses:
+
-
+
- List your authorizations +
- Get a single authorization +
- Get-or-create an authorization for a specific app -
tokenis still returned for "create"
+ {% if page.version == 'dotcom' or page.version > 2.2 %}
+ - Get-or-create an authorization for a specific app and fingerprint -
tokenis still returned for "create"
+ {% endif %}
+ - Update an existing authorization +
+ To reduce the impact of removing the token value,
+ the OAuth Authorizations API now includes a new request attribute
+ (fingerprint), three new response attributes
+ (token_last_eight, hashed_token, and
+ fingerprint), and
+ one new endpoint.
+
+ To reduce the impact of removing the token value,
+ the OAuth Authorizations API now includes a new request attribute
+ (fingerprint) and three new response attributes
+ (token_last_eight, hashed_token, and
+ fingerprint).
+
+ This functionality became the default for all requests on April 20, 2015. Please see the blog post for full details. +
+* `2fa_disabled`: Members without [two-factor authentication][2fa-blog] enabled. Available for organization owners.
* `all`: All members the authenticated user can see.
Default: `all` +`role` |`string` | Filter members returned by their role. Can be one of:
* `all`: All members of the organization, regardless of role.
* `admin`: Organization owners.
* `member`: Non-owner organization members. {% if page.version != 'dotcom' and page.version == 2.4 %}This option requires a custom media type to be specified. Please see more in the alert below.**{% endif %}
Default: `all` + +[2fa-blog]: https://github.com/blog/1614-two-factor-authentication + +{% if page.version != 'dotcom' and page.version > 2.3 and page.version < 2.6 %} + +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Organization Permissions API. Please see [the blog post](/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions/) for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ironman-preview+json +``` + +{{/tip}} + +{% endif %} + ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> -## Get member +### Response if requester is not an organization member - GET /orgs/:org/members/:user +<%= headers 302, "Location" => "https://api.github.com/orgs/github/public_members" %> -### Response if user is a member +## Check membership + +Check if a user is, publicly or privately, a member of the organization. + + GET /orgs/:org/members/:username + +### Response if requester is an organization member and user is a member <%= headers 204 %> -### Response if user is not a member +### Response if requester is an organization member and user is not a member <%= headers 404 %> +### Response if requester is not an organization member and is inquiring about themselves + +<%= headers 404 %> + +### Response if requester is not an organization member + +<%= headers 302, :Location => "https://api.github.com/orgs/github/public_members/pezra" %> + ## Add a member -To add someone as a member to an org, you must add them to a -[team](/v3/orgs/teams/#add-team-member). +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +To add someone as a member to an organization, you must +[invite them to the organization](/v3/orgs/members/#add-or-update-organization-membership) +or [invite them to a team](/v3/orgs/teams/#add-team-membership). + +{% else %} + +To add someone as a member to an organization, you must add them to a [team](/v3/orgs/teams/#add-team-member). + +{% endif %} ## Remove a member Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - DELETE /orgs/:org/members/:user + DELETE /orgs/:org/members/:username ### Response <%= headers 204 %> -## List public members +## Public members list Members of an organization can choose to have their membership publicized or not. @@ -55,12 +106,12 @@ publicized or not. ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> -## Get if a user is a public member +## Check public membership - GET /orgs/:org/public_members/:user + GET /orgs/:org/public_members/:username ### Response if user is a public member @@ -72,7 +123,12 @@ publicized or not. ## Publicize a user's membership - PUT /orgs/:org/public_members/:user +The user can publicize their own membership. +(A user cannot publicize the membership for another user.) + + PUT /orgs/:org/public_members/:username + +<%= fetch_content(:put_content_length) %> ### Response @@ -80,8 +136,146 @@ publicized or not. ## Conceal a user's membership - DELETE /orgs/:org/public_members/:user + DELETE /orgs/:org/public_members/:username -## Response +### Response <%= headers 204 %> + +## Get organization membership + +{% if page.version == 'dotcom' or page.version >= 2.6 %} + +In order to get a user's membership with an organization, the authenticated user must be an organization member. + +{% elsif page.version >= 2.4 %} + +In order to get a user's membership with an organization, the authenticated user must be an organization owner. + +{% else %} + +In order to get a user's membership with an organization, the authenticated user must be an organization admin. + +{% endif %} + + GET /orgs/:org/memberships/:username + +### Response if user has an active admin membership with organization + +<%= headers 200 %> +<%= json(:active_admin_org_membership) %> + +### Response if user has an active membership with organization + +<%= headers 200 %> +<%= json(:active_limited_org_membership) %> + +### Response if user has a pending membership with organization + +<%= headers 200 %> +<%= json(:pending_limited_org_membership) %> + +## Add or update organization membership + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to create or update a user's membership with an organization, the authenticated user must be an organization owner. + +{% else %} + +In order to create or update a user's membership with an organization, the authenticated user must be an organization admin. + +{% endif %} + + PUT /orgs/:org/memberships/:username + +### Parameters + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +Name | Type | Description +------|--------|-------------- +`role`|`string`| **Required**. The role to give the user in the organization. Can be one of:
* `admin` - The user will become an owner of the organization.
* `member` - The user will become a non-owner member of the organization. + +{% else %} + +Name | Type | Description +------|--------|-------------- +`role`|`string`| **Required**. The role to give the user in the organization. Can be one of:
* `admin` - The user will become an administrator of the organization.
* `member` - The user will become a non-admin member of the organization. Use this only to demote an existing admin to a non-admin. + +{% endif %} + +### Response if user was previously unaffiliated with organization + +<%= headers 200 %> +<%= json(:pending_admin_org_membership) %> + +### Response if user already had membership with organization + +<%= headers 200 %> +<%= json(:active_admin_org_membership) %> + +## Remove organization membership + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + +{% else %} + +In order to remove a user's membership with an organization, the authenticated user must be an organization admin. + +{% endif %} + + DELETE /orgs/:org/memberships/:username + +If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. + +### Response + +<%= headers 204 %> + +## List your organization memberships + + GET /user/memberships/orgs + +### Input + +Name | Type | Description +-----|------|-------------- +`state`|`string`| Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, both active and pending memberships are returned. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:org_memberships) %> + +## Get your organization membership + + GET /user/memberships/orgs/:org + +### Response + +<%= headers 200 %> +<%= json(:pending_admin_org_membership) %> + +## Edit your organization membership + + PATCH /user/memberships/orgs/:org + +### Input + +Name | Type | Description +-----|------|-------------- +`state`|`string`| **Required**. The state that the membership should be in. Only `"active"` will be accepted. + +### Example + +<%= json \ + :state => "active" + %> + +### Response + +<%= headers 200 %> +<%= json(:active_admin_org_membership) %> diff --git a/content/v3/orgs/pre_receive_hooks.md b/content/v3/orgs/pre_receive_hooks.md new file mode 100644 index 0000000000..7d3afc0bd4 --- /dev/null +++ b/content/v3/orgs/pre_receive_hooks.md @@ -0,0 +1,83 @@ +--- +title: Organization Pre-receive Hooks +--- + +# Organization Pre-receive Hooks (Enterprise) + +{{#tip}} + + + + APIs for managing pre-receive hooks are currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.eye-scream-preview + +{{/tip}} + +{:toc} + +The Organization Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to an organization. + +Prefix all the endpoints for this API with the following URL: + +``` command-line +http(s)://hostname/api/v3 +``` + +## Object attributes + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this endpoint or this hook's global +configuration. Only site admins are able to access the global configuration. + +## List pre-receive hooks + +List all pre-receive hooks that are enabled or testing for this +organization as well as any disabled hooks that can be configured at the +organization level. Globally disabled pre-receive hooks that do not allow +downstream configuration are not listed. + + GET /orgs/:org/pre-receive-hooks + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json :pre_receive_hooks_org %> + +## Get a single pre-receive hook + + GET /orgs/:org:pre-receive-hooks/:id + +<%= headers 200 %> <%= json :pre_receive_hook_org %> + +## Update pre-receive hook enforcement + +For pre-receive hooks which are allowed to be configured at the org level, you can set +`enforcement` and `allow_downstream_configuration` + + PATCH /orgs/:org/pre-receive-hooks/:id + +<%= json :enforcement => "enabled", :allow_downstream_configuration => false %> + +### Response + +<%= headers 200 %><%= json :pre_receive_hook_org_update %> + +## Remove enforcment overrides for a pre-receive hook + +Removes any overrides for this hook at the org level for this org. + + DELETE /orgs/:org/pre-receive-hooks/:id + +<%= headers 200 %> <%= json :pre_receive_hook_org %> diff --git a/content/v3/orgs/teams.md b/content/v3/orgs/teams.md index f48e7cff1f..07a233bea9 100644 --- a/content/v3/orgs/teams.md +++ b/content/v3/orgs/teams.md @@ -1,12 +1,14 @@ --- -title: Organization Teams | GitHub API +title: Organization Teams --- -# Org Teams API +# Teams + +{:toc} All actions against teams require at a minimum an authenticated user who -is a member of the owner's team in the `:org` being managed. Additionally, -OAuth users require "user" [scope](/v3/oauth/#scopes). +is a member of the Owners team in the `:org` being managed. Additionally, +OAuth users require the "read:org" [scope](/v3/oauth/#scopes). ## List teams @@ -14,7 +16,7 @@ OAuth users require "user" [scope](/v3/oauth/#scopes). ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:team) { |h| [h] } %> ## Get team @@ -28,36 +30,74 @@ OAuth users require "user" [scope](/v3/oauth/#scopes). ## Create team -In order to create a team, the authenticated user must be an owner of -`:org`. +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to create a team, the authenticated user must be a member of `:org`. + +{% else %} + +In order to create a team, the authenticated user must be an owner of `:org`. + +{% endif %} POST /orgs/:org/teams -### Input +### Parameters + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. The name of the team. +`description`|`string` | The description of the team. +`repo_names`|`array` of `strings` | The full name (e.g., "organization-name/repository-name") of repositories to add the team to. +`privacy`|`string`| The level of privacy this team should have. Can be one of:
* `secret` - only visible to organization owners and members of this team.
* `closed` - visible to all members of this organization.
Default: `secret`
{% if page.version != 'dotcom' and page.version == 2.4 %}**This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} +`permission`|`string` | **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* `pull` - team members can pull, but not push to or administer newly-added repositories.
* `push` - team members can pull and push, but not administer newly-added repositories.
* `admin` - team members can pull, push and administer newly-added repositories.
Default: `pull` + +{% if page.version != 'dotcom' and page.version > 2.3 and page.version < 2.6 %} + +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Organization Permissions API. Please see the [blog post](/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions/) for full details. -name -: _Required_ **string** +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: -repo\_names -: _Optional_ **array** of **strings** +``` +application/vnd.github.ironman-preview+json +``` -permission -: _Optional_ **string** +**Warning:** If you specify the `privacy` attribute on an organization that hasn't had [improved organization permissions](https://github.com/blog/2020-improved-organization-permissions) enabled yet, you will get a `422` error response. - `pull` - team members can pull, but not push to or administer these - repositories. **Default** +{{/tip}} - `push` - team members can pull and push, but not administer these - repositories. +{% endif %} - `admin` - team members can pull, push and administer these - repositories. +#### Example <%= json \ :name => 'new team', + :description => 'team description', + :privacy => 'closed' %> + +{% else %} + +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. The name of the team. +`description`|`string` | The description of the team. +`repo_names`|`array` of `strings` | The full name (e.g., "organization-name/repository-name") of repositories to add the team to. +`permission`|`string` | The permission to grant the team. Can be one of:
* `pull` - team members can pull, but not push to or administer these repositories.
* `push` - team members can pull and push, but not administer these repositories.
* `admin` - team members can pull, push and administer these repositories.
Default: `pull` + +#### Example + +<%= json \ + :name => 'new team', + :description => 'team description', :permission => 'push', :repo_names => ['github/dotfiles'] %> +{% endif %} + ### Response <%= headers 201 %> @@ -65,23 +105,74 @@ permission ## Edit team -In order to edit a team, the authenticated user must be an owner of -the org that the team is associated with. +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to edit a team, the authenticated user must either be an owner of +the org that the team is associated with, or a maintainer of the team. + +{% else %} + +In order to edit a team, the authenticated user must be an owner of the org that the team is associated with. + +{% endif %} PATCH /teams/:id -### Input +{% if page.version == 'dotcom' or page.version >= 2.4 %} -name -: _Required_ **string** +### Parameters -permission -: _Optional_ **string** +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. The name of the team. +`description`|`string` | The description of the team. +`privacy`|`string`| The level of privacy this team should have. Can be one of:
* `secret` - only visible to organization owners and members of this team.
* `closed` - visible to all members of this organization.
Default: `secret`
{% if page.version != 'dotcom' and page.version == 2.4 %}**This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} +`permission`|`string` | **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* `pull` - team members can pull, but not push to or administer newly-added repositories.
* `push` - team members can pull and push, but not administer newly-added repositories.
* `admin` - team members can pull, push and administer newly-added repositories.
Default: `pull` + +{% if page.version != 'dotcom' and page.version > 2.3 and page.version < 2.6 %} + +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Organization Permissions API. Please see the [blog post](/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions/) for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ironman-preview+json +``` + +**Warning:** If you specify the `privacy` attribute on an organization that hasn't had [improved organization permissions](https://github.com/blog/2020-improved-organization-permissions) enabled yet, you will get a `422` error response. + +{{/tip}} + +{% endif %} + +#### Example + +<%= json \ + :name => 'new team name', + :description => 'new team description', + :privacy => 'closed' %> + +{% else %} + +### Parameters + +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. The name of the team. +`description`|`string` | The description of the team. +`permission`|`string` | The permission to grant the team. Can be one of:
* `pull` - team members can pull, but not push to or administer these repositories.
* `push` - team members can pull and push, but not administer these repositories.
* `admin` - team members can pull, push and administer these repositories. Default: `pull` + +#### Example <%= json \ :name => 'new team name', + :description => 'new team description', :permission => 'push' %> +{% endif %} + ### Response <%= headers 200 %> @@ -90,7 +181,7 @@ permission ## Delete team In order to delete a team, the authenticated user must be an owner of -the org that the team is associated with. +the org that the team is associated with{% if page.version == 'dotcom' or page.version >= 2.4 %}, or a maintainer of the team{% endif %}. DELETE /teams/:id @@ -100,22 +191,66 @@ the org that the team is associated with. ## List team members -In order to list members in a team, the authenticated user must be a -member of the team. +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to list members in a team, the team must be visible to the +authenticated user. + +{% else %} + +In order to list members in a team, the authenticated user must be a member of the team. + +{% endif %} + +{% if page.version != 'dotcom' and page.version >= 2.3 %} + +<%= fetch_content(:if_site_admin) %> +you will be able to list all members for the team. + +{% endif %} GET /teams/:id/members +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +Name | Type | Description +-----|------|-------------- +`role`|`string`| Filters members returned by their role in the team. Can be one of:
* `member` - normal members of the team.
* `maintainer` - team maintainers.
* `all` - all members of the team.
Default: `all` + +{% endif %} + ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> ## Get team member -In order to get if a user is a member of a team, the authenticated user -must be a member of the team. +### Deprecation notice + +{{#tip}} + +The "Get team member" API (described below) is +[deprecated](/v3/versions/#v3-deprecations) and is scheduled for +removal in the next major version of the API. + +We recommend using the +[Get team membership API](/v3/orgs/teams/#get-team-membership) +instead. It allows you to get both active and pending memberships. + +{{/tip}} - GET /teams/:id/members/:user +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to list members in a team, the team must be visible to the authenticated user. + +{% else %} + +In order to get if a user is a member of a team, the authenticated user must be a member of the team. + +{% endif %} + + GET /teams/:id/members/:username ### Response if user is a member @@ -127,11 +262,28 @@ must be a member of the team. ## Add team member +### Deprecation notice + +{{#tip}} + +The "Add team member" API (described below) is +[deprecated](/v3/versions/#v3-deprecations) and is scheduled for +removal in the next major version of the API. + +We recommend using the +[Add team membership API](/v3/orgs/teams/#add-team-membership) +instead. It allows you to invite new organization members to your teams. + +{{/tip}} + In order to add a user to a team, the authenticated user must have -'admin' permissions to the team or be an owner of the org that the team -is associated with. +'admin' permissions to the team or be an owner of the organization that the team +is associated with, and the user being added must already be a member of at +least one other team on the same organization. + + PUT /teams/:id/members/:username - PUT /teams/:id/members/:user +<%= fetch_content(:put_content_length) %> ### Response @@ -141,7 +293,7 @@ If you attempt to add an organization to a team, you will get this: <%= headers 422 %> <%= - json :message => "Validation Failed", + json :message => "Cannot add an organization as a member.", :errors => [{ :code => "org", :field => :user, @@ -149,14 +301,149 @@ If you attempt to add an organization to a team, you will get this: }] %> +If you attempt to add a user to a team and that user is not a member of at least +one other team on the same organization, you will get this: + +<%= headers 422 %> +<%= + json :message => "User isn't a member of this organization. Please invite them first.", + :errors => [{ + :code => "unaffiliated", + :field => :user, + :resource => :TeamMember + }] +%> + ## Remove team member +### Deprecation notice + +{{#tip}} + +The "Remove team member" API (described below) is +[deprecated](/v3/versions/#v3-deprecations) and is scheduled for +removal in the next major version of the API. + +We recommend using the +[Remove team membership API](/v3/orgs/teams/#remove-team-membership) +instead. It allows you to remove both active and pending memberships. + +{{/tip}} + In order to remove a user from a team, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. -NOTE: This does not delete the user, it just remove them from the team. +NOTE: This does not delete the user, it just removes them from the team. + + DELETE /teams/:id/members/:username + +### Response + +<%= headers 204 %> - DELETE /teams/:id/members/:user +## Get team membership + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to get a user's membership with a team, the team must be visible to the +authenticated user. + +{% else %} + +In order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization. + +{% endif %} + + GET /teams/:id/memberships/:username + +### Response if user has an active membership with team + +<%= headers 200 %> +<%= json(:active_team_membership) %> + +### Response if user has a pending membership with team + +<%= headers 200 %> +<%= json(:pending_team_membership) %> + +### Response if user has no membership with team + +<%= headers 404 %> + +## Add team membership + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +If the user is already a member of the team's organization, this endpoint will +add the user to the team. In order to add a membership between an organization +member and a team, the authenticated user must be an organization owner or a +maintainer of the team. + +If the user is unaffiliated with the team's organization, this endpoint will +send an invitation to the user via email. This newly-created membership will be +in the "pending" state until the user accepts the invitation, at which point the +membership will transition to the "active" state and the user will be added as a +member of the team. In order to add a membership between an unaffiliated user +and a team, the authenticated user must be an organization owner. + +{% else %} + +In order to add a membership between a user and a team, the authenticated user +must have 'admin' permissions to the team or be an owner of the organization +that the team is associated with. + +If the user is already a part of the team's organization (meaning they're on at +least one other team in the organization), this endpoint will add the user to +the team. + +If the user is completely unaffiliated with the team's organization (meaning +they're on none of the organization's teams), this endpoint will send an +invitation to the user via email. This newly-created membership will be in the +"pending" state until the user accepts the invitation, at which point the +membership will transition to the "active" state and the user will be added as a +member of the team. + +{% endif %} + + PUT /teams/:id/memberships/:username + +### Parameters + +Name | Type | Description +-----|------|-------------- +`role`|`string`| The role that this user should have in the team. Can be one of:
* `member` - a normal member of the team.
* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.
Default: `member` + +### Response if user's membership with team is now active + +<%= headers 200 %> +<%= json(:active_team_membership) %> + +### Response if user's membership with team is now pending + +<%= headers 200 %> +<%= json(:pending_team_membership) %> + +If you attempt to add an organization to a team, you will get this: + +<%= headers 422 %> +<%= + json :message => "Cannot add an organization as a member.", + :errors => [{ + :code => "org", + :field => :user, + :resource => :TeamMember + }] +%> + +## Remove team membership + +In order to remove a membership between a user and a team, the authenticated +user must have 'admin' permissions to the team or be an owner of the +organization that the team is associated with. +NOTE: This does not delete the user, it just removes their membership from the +team. + + DELETE /teams/:id/memberships/:username ### Response @@ -166,37 +453,98 @@ NOTE: This does not delete the user, it just remove them from the team. GET /teams/:id/repos +{% if page.version != 'dotcom' and page.version >= 2.3 %} + +<%= fetch_content(:if_site_admin) %> +you will be able to list all repositories for the team. + +{% endif %} + ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:repo) { |h| [h] } %> -## Get team repo +## Check if a team manages a repository - GET /teams/:id/repos/:user/:repo + GET /teams/:id/repos/:owner/:repo -### Response if repo is managed by this team +### Response if repository is managed by this team <%= headers 204 %> -### Response if repo is not managed by this team +### Response if repository is not managed by this team <%= headers 404 %> -## Add team repo +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +### Alternative response with extra repository information + +You can also get information about the specified repository, including what +permissions the team grants on it, by passing the following custom +[media type](/v3/media/) via the `Accept` header: + + Accept: application/vnd.github.v3.repository+json -In order to add a repo to a team, the authenticated user must be an -owner of the org that the team is associated with. Also, the repo must -be owned by the organization, or a direct for of a repo owned by the +{% endif %} + +<%= headers 200 %> +<%= json :repo %> + +## Add or update team repository + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization. + +{% else %} + +In order to add a repository to a team, the authenticated user must have admin +access to the repository, and must be able to see the team. Also, the repository +must be owned by the organization, or a direct fork of a repository owned by the organization. - PUT /teams/:id/repos/:user/:repo +{% endif %} + + PUT /teams/:id/repos/:org/:repo + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +### Parameters + +Name | Type | Description +-----|------|-------------- +`permission`|`string` | The permission to grant the team on this repository. Can be one of:
* `pull` - team members can pull, but not push to or administer this repository.
* `push` - team members can pull and push, but not administer this repository.
* `admin` - team members can pull, push and administer this repository.
If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + +<%= fetch_content(:optional_put_content_length) %> + +{% endif %} + + +{% if page.version != 'dotcom' and page.version > 2.3 and page.version < 2.6 %} + +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Organization Permissions API. Please see the [blog post](/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions/) for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ironman-preview+json +``` + +**Warning:** If you specify the `permission` attribute on an organization that hasn't had [improved organization permissions](https://github.com/blog/2020-improved-organization-permissions) enabled yet, you will get a `422` error response. + +{{/tip}} + +{% endif %} ### Response <%= headers 204 %> -If you attempt to add a repo to a team that is not owned by the +If you attempt to add a repository to a team that is not owned by the organization, you get: <%= headers 422 %> @@ -208,15 +556,40 @@ organization, you get: :resource => :TeamMember}] %> -## Remove team repo + -In order to remove a repo from a team, the authenticated user must be an -owner of the org that the team is associated with. -NOTE: This does not delete the repo, it just removes it from the team. +## Remove team repository - DELETE /teams/:id/repos/:user/:repo +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +In order to remove a repository from a team, the authenticated user must have +admin access to the repository or be a maintainer of the team. +NOTE: This does not delete the repository, it just removes it from the team. + +{% else %} + +In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. Also, since the Owners team always has access to all repositories in the organization, repositories cannot be removed from the Owners team. + +{% endif %} + + DELETE /teams/:id/repos/:owner/:repo ### Response <%= headers 204 %> +## List user teams + +List all of the teams across all of the organizations to which the +authenticated user belongs. This method requires `user`, `repo`, or +`read:org` [scope][] when authenticating via [OAuth][]. + + GET /user/teams + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:full_team) { |h| [h] } %> + +[OAuth]: /v3/oauth/ +[scope]: /v3/oauth/#scopes diff --git a/content/v3/pulls.md b/content/v3/pulls.md index 6faf4e7cb2..332c98ff3d 100644 --- a/content/v3/pulls.md +++ b/content/v3/pulls.md @@ -1,80 +1,97 @@ --- -title: Pull Requests | GitHub API +title: Pull Requests --- -# Pull Request API +# Pull Requests + +{:toc} The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/v3/issues/comments/). -Pull Requests leverage [these](#custom-mime-types) custom mime types. You -can read more about the use of mime types in the API -[here](/v3/mime/). +Pull Requests use [these custom media types](#custom-media-types). You +can read more about the use of media types in the API +[here](/v3/media/). ## Link Relations Pull Requests have these possible link relations: -`self` -: The API location of this Pull Request. - -`html` -: The HTML location of this Pull Request. - -`comments` -: The API location of this Pull Request's Issue comments. - -`review_comments` -: The API location of this Pull Request's Review comments. +Name | Description +-----|-----------| +`self`| The API location of this Pull Request. +`html`| The HTML location of this Pull Request. +`issue`| The API location of this Pull Request's [Issue](/v3/issues/). +`comments`| The API location of this Pull Request's [Issue comments](/v3/issues/comments/). +`review_comments`| The API location of this Pull Request's [Review comments](/v3/pulls/comments/). +`review_comment`| The [URL template](/v3/#hypermedia) to construct the API location for a [Review comment](/v3/pulls/comments/) in this Pull Request's repository. +`commits`|The API location of this Pull Request's [commits](#list-commits-on-a-pull-request). +`statuses`| The API location of this Pull Request's [commit statuses](/v3/repos/statuses/), which are the statuses of its `head` branch. ## List pull requests - GET /repos/:user/:repo/pulls + GET /repos/:owner/:repo/pulls ### Parameters -state -: _Optional_ **string** - `open` or `closed` to filter by state. Default -is `open`. +Name | Type | Description +-----|------|-------------- +`state`|`string` | Either `open`, `closed`, or `all` to filter by state. Default: `open` +`head`|`string` | Filter pulls by head user and branch name in the format of `user:ref-name`. Example: `github:new-script-format`. +`base`|`string` | Filter pulls by base branch name. Example: `gh-pages`. +`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). Default: `created` +`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:pull) { |h| [h] } %> ## Get a single pull request - GET /repos/:user/:repo/pulls/:number + GET /repos/:owner/:repo/pulls/:number ### Response +{{#tip}} + +Each time the pull request receives new commits, {{ site.data.variables.product.product_name }} creates a merge commit +to _test_ whether the pull request can be automatically merged into the base +branch. (This _test_ commit is not added to the base branch or the head branch.) +The `merge_commit_sha` attribute holds the SHA of the _test_ merge commit; +however, this attribute is [deprecated](/v3/versions/#v3-deprecations) and is scheduled for +removal in the next version of the API. The Boolean `mergeable` attribute will +remain to indicate whether the pull request can be automatically merged. + +The value of the `mergeable` attribute can be `true`, `false`, or `null`. If +the value is `null`, this means that the mergeability hasn't been computed yet, +and a background job was started to compute it. Give the job a few moments to +complete, and then submit the request again. When the job is complete, the +response will include a non-`null` value for the `mergeable` attribute. + +{{/tip}} + +Pass the appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + <%= headers 200 %> <%= json :full_pull %> ## Create a pull request - POST /repos/:user/:repo/pulls + POST /repos/:owner/:repo/pulls ### Input -title -: _Required_ **string** - -body -: _Optional_ **string** - -base -: _Required_ **string** - The branch (or git ref) you want your changes pulled into. -This should be an existing branch on the current repository. You cannot -submit a pull request to one repo that requests a merge to a base of -another repo. +Name | Type | Description +-----|------|------------- +`title`|`string` | **Required**. The title of the pull request. +`head`|`string` | **Required**. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. +`base`|`string` | **Required**. The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. +`body`|`string` | The contents of the pull request. -head -: _Required_ **string** - The branch (or git ref) where your changes are implemented. -NOTE: `head` and `base` can be either a sha or a branch name. Typically you -would namespace `head` with a user like this: `username:branch`. +#### Example <%= json \ :title => "Amazing new feature", @@ -88,41 +105,45 @@ would namespace `head` with a user like this: `username:branch`. You can also create a Pull Request from an existing Issue by passing an Issue number instead of `title` and `body`. -issue -: _Required_ **number** - Issue number in this repository to turn into a -Pull Request. +Name | Type | Description +-----|------|-------------- +`issue`|`integer` | **Required**. The issue number in this repository to turn into a Pull Request. + +#### Example <%= json \ - :issue => "5", - :head => "ocotocat:new-feature", + :issue => 5, + :head => "octocat:new-feature", :base => "master" %> ### Response -<%= headers 201, :Location => "https://api.github.com/user/repo/pulls/1" %> +<%= headers 201, :Location => get_resource(:pull)['url'] %> <%= json :pull %> ## Update a pull request - PATCH /repos/:user/:repo/pulls/:number + PATCH /repos/:owner/:repo/pulls/:number ### Input -title -: _Optional_ **string** - -body -: _Optional_ **string** +Name | Type | Description +-----|------|-------------- +`title`|`string` | The title of the pull request. +`body`|`string` | The contents of the pull request. +`state`|`string` | State of this Pull Request. Either `open` or `closed`.{% if page.version == 'dotcom' or page.version >= 2.8 %} +`base`|`string` | The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. +{% endif %} -state -: _Optional_ **string** - State of this Pull Request. Valid values are -`open` and `closed`. +#### Example <%= json \ :title => "new title", :body => "updated body", - :state => "open" + :state => "open"{% if page.version == 'dotcom' or page.version >= 2.8 %}, + :base => "master" +{% endif %} %> ### Response @@ -132,25 +153,27 @@ state ## List commits on a pull request - GET /repos/:user/:repo/pulls/:number/commits + GET /repos/:owner/:repo/pulls/:number/commits ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:commit) { |h| [h] } %> +Note: The response includes a maximum of 250 commits. If you are working with a pull request larger than that, you can use the [Commit List API](/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the pull request. + ## List pull requests files - GET /repos/:user/:repo/pulls/:number/files + GET /repos/:owner/:repo/pulls/:number/files ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:file) { |h| [h] } %> ## Get if a pull request has been merged - GET /repos/:user/:repo/pulls/:number/merge + GET /repos/:owner/:repo/pulls/:number/merge ### Response if pull request has been merged @@ -160,14 +183,34 @@ state <%= headers 404 %> -## Merge a pull request (Merge Button™) +## Merge a pull request (Merge Button) - PUT /repos/:user/:repo/pulls/:number/merge + PUT /repos/:owner/:repo/pulls/:number/merge ### Input -commit\_message -: _Optional_ **string** - The message that will be used for the merge commit +Name | Type | Description +-----|------|------------- +{% if page.version == 'dotcom' or page.version >= 2.6 %}`commit_title`|`string`| Title for the automatic commit message.{% endif %} +`commit_message`|`string`| Extra detail to append to automatic commit message. +`sha`|`string`| SHA that pull request head must match to allow merge +{% if page.version == 'dotcom' or page.version >= 2.6 %}`squash`|`boolean`| Commit a single commit to the head branch.{% endif %} + +{% if page.version == 'dotcom' or page.version >= 2.6 %} + +{{#tip}} + +The `commit_title` and `squash` parameters are currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](/changes/2016-04-01-squash-api-preview) for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.polaris-preview+json +``` + +{{/tip}} + +{% endif %} ### Response if merge was successful @@ -182,17 +225,34 @@ commit\_message <%= headers 405 %> <%= json \ - :sha => nil, - :merged => false, - :message => 'Failure reason' + :message => "Pull Request is not mergeable", + :documentation_url => "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button" %> -## Custom Mime Types +### Response if sha was provided and pull request head did not match -These are the supported mime types for pull requests. You can read more about the -use of mime types in the API [here](/v3/mime/). +<%= headers 409 %> +<%= json \ + :message => "Head branch was modified. Review and try the merge again.", + :documentation_url => "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button" +%> + +## Labels, assignees, and milestones + +Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within [the Issues API](/v3/issues). + +## Custom media types + +These are the supported media types for pull requests. You can read more about the +use of media types in the API [here](/v3/media/). application/vnd.github.VERSION.raw+json application/vnd.github.VERSION.text+json application/vnd.github.VERSION.html+json application/vnd.github.VERSION.full+json + application/vnd.github.VERSION.diff + application/vnd.github.VERSION.patch + + + +If a diff is corrupt, contact {{ site.data.variables.contact.contact_support }} to receive help. Be sure to include the repository name and pull request ID. diff --git a/content/v3/pulls/comments.md b/content/v3/pulls/comments.md index ce0b4634fd..fa543427ab 100644 --- a/content/v3/pulls/comments.md +++ b/content/v3/pulls/comments.md @@ -1,53 +1,141 @@ --- -title: Pull Request Comments | GitHub API +title: Review Comments --- -# Pull Request Review Comments API +# Review Comments + +{:toc} Pull Request Review Comments are comments on a portion of the unified diff. These are separate from Commit Comments (which are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference a portion of the unified diff). -Pull Request Review Comments leverage [these](#custom-mime-types) custom mime -types. You can read more about the use of mime types in the API -[here](/v3/mime/). +Pull Request Review Comments use [these custom media +types](#custom-media-types). You can read more about the use of media types in the API +[here](/v3/media/). ## List comments on a pull request - GET /repos/:user/:repo/pulls/:number/comments + GET /repos/:owner/:repo/pulls/:number/comments ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:pull_comment) { |h| [h] } %> + +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the review comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :pull_comment_reaction_summary %> +{% endif %} + +## List comments in a repository + + GET /repos/:owner/:repo/pulls/comments + +By default, Review Comments are ordered by ascending ID. + +### Parameters + +Name | Type | Description +-----|------|-------------- +`sort`|`string` | Can be either `created` or `updated`. Default: `created` +`direction`|`string` | Can be either `asc` or `desc`. Ignored without `sort` parameter. +`since`|`string` | Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:pull_comment) { |h| [h] } %> +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the review comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :pull_comment_reaction_summary %> +{% endif %} + ## Get a single comment - GET /repos/:user/:repo/pulls/comments/:number + GET /repos/:owner/:repo/pulls/comments/:id ### Response <%= headers 200 %> <%= json :pull_comment %> +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the review comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :pull_comment_reaction_summary %> +{% endif %} + ## Create a comment - POST /repos/:user/:repo/pulls/:number/comments + POST /repos/:owner/:repo/pulls/:number/comments ### Input -body -: _Required_ **string** +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The text of the comment +`commit_id`|`string` | **Required**. The SHA of the commit to comment on. +`path`|`string` | **Required**. The relative path of the file to comment on. +`position`|`integer` | **Required**. The line index in the diff to comment on. -commit_id -: _Required_ **string** - Sha of the commit to comment on. +{{#tip}} -path -: _Required_ **string** - Relative path of the file to comment on. +When passing the `commit_id`, use the SHA of the latest commit in the pull request or your comment may appear as "outdated" if the specified `position` has been modified in a subsequent commit. -position -: _Required_ **number** - Line index in the diff to comment on. +To comment on a specific line in a file, you will need to first determine the position in the diff. GitHub offers a `application/vnd.github.v3.diff` media type which you can use in a preceding request to view the pull request's diff. The diff needs to be [interpreted](https://en.wikipedia.org/wiki/Diff_utility#Unified_format) to translate from the *line in the file* to a *position in the diff*. The `position` value is the number of lines down from the first "@@" hunk header in the file you would like to comment on. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the file's diff continues to increase through lines of whitespace and additional hunks until a new file is reached. + +{{/tip}} #### Example @@ -63,11 +151,11 @@ position Instead of passing `commit_id`, `path`, and `position` you can reply to an existing Pull Request Comment like this: -body -: _Required_ **string** +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The text of the comment +`in_reply_to`|`integer` | **Required**. The comment id to reply to. -in_reply_to -: _Required_ **number** - Comment id to reply to. #### Example @@ -78,19 +166,19 @@ in_reply_to ### Response -<%= headers 201, - :Location => -"https://api.github.com/repos/:user/:repo/pulls/comments/1" %> +<%= headers 201, :Location => get_resource(:pull_comment)['url'] %> <%= json :pull_comment %> ## Edit a comment - PATCH /repos/:user/:repo/pulls/comments/:number + PATCH /repos/:owner/:repo/pulls/comments/:id ### Input -body -: _Required_ **string** +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The text of the comment + #### Example @@ -105,16 +193,16 @@ body ## Delete a comment - DELETE /repos/:user/:repo/pulls/comments/:number + DELETE /repos/:owner/:repo/pulls/comments/:id ### Response <%= headers 204 %> -## Custom Mime Types +## Custom media types -These are the supported mime types for pull request comments. You can read -more about the use of mime types in the API [here](/v3/mime/). +These are the supported media types for pull request review comments. You can +read more about the use of media types in the API [here](/v3/media/). application/vnd.github.VERSION.raw+json application/vnd.github.VERSION.text+json diff --git a/content/v3/rate_limit.md b/content/v3/rate_limit.md new file mode 100644 index 0000000000..cb27f21b3b --- /dev/null +++ b/content/v3/rate_limit.md @@ -0,0 +1,55 @@ +--- +title: Rate Limit +--- + +{% if page.version == 'dotcom' %} + +# Rate Limit + +The overview documentation describes the [rate limit rules](/v3/#rate-limiting). +You can check your current rate limit status at any time using the Rate Limit +API described below. + +## Get your current rate limit status + +Note: Accessing this endpoint does not count against your rate limit. + + GET /rate_limit + +### Response + +<%= + headers 200, + 'X-RateLimit-Limit' => 5000, + 'X-RateLimit-Remaining' => 4999, + 'X-RateLimit-Reset' => 1372700873 +%> +<%= + json :resources => { + :core => {:limit => 5000, :remaining => 4999, :reset => 1372700873}, + :search => {:limit => 30, :remaining => 18, :reset => 1372697452}, + }, + :rate => {:limit => 5000, :remaining => 4999, :reset => 1372700873} +%> +
+ +#### Understanding Your Rate Limit Status + +The Search API has a [custom rate limit](/v3/search/#rate-limit), separate from +the rate limit governing the rest of the API. For that reason, the response +(shown above) categorizes your rate limit by resource. Within the `"resources"` +object, the `"search"` object provides your rate limit status for the +[Search API](/v3/search). The `"core"` object provides your rate limit status for +all the _rest_ of the API. + +#### Deprecation Notice + +The `"rate"` object (shown at the bottom of the response above) is +[deprecated](/v3/versions/#v3-deprecations) and is scheduled for removal in the next +version of the API. + +If you're writing new API client code (or updating your existing code), you +should use the `"core"` object instead of the `"rate"` object. The `"core"` object +contains the same information that is present in the `"rate"` object. + +{% endif %} diff --git a/content/v3/reactions.md b/content/v3/reactions.md new file mode 100644 index 0000000000..d8effc8a38 --- /dev/null +++ b/content/v3/reactions.md @@ -0,0 +1,208 @@ +--- +title: Reactions +--- + +{% if page.version == 'dotcom' or page.version >= 2.7 %} + +# Reactions + +{{#tip}} + + + + APIs for managing reactions are currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + +{{/tip}} + +{:toc} + + +## Reaction types + + When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): + +content | emoji +-----|------ +`+1` | :+1: +`-1` | :-1: +`laugh` | :smile: +`confused` | :confused: +`heart` | :heart: +`hooray` | :tada: + + +## List reactions for a commit comment + + GET /repos/:owner/:repo/comments/:id/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | Indicates which type of reaction to return. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:reaction) { |h| [h] } %> + + +## Create reaction for a commit comment + + POST /repos/:owner/:repo/comments/:id/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | **Required**. The reaction type + +<%= json :content => 'heart' %> + +### Response + +{{#tip}} + + If you have already created a reaction of type `content`, the previously created reaction will be returned with `Status: 200 OK`. + +{{/tip}} + +<%= headers 201 %> +<%= json :reaction %> + + +## List reactions for an issue + + GET /repos/:owner/:repo/issues/:number/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | Indicates which type of reaction to return. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:reaction) { |h| [h] } %> + + +## Create reaction for an issue + + POST /repos/:owner/:repo/issues/:number/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | **Required**. The reaction type + +<%= json :content => 'heart' %> + +### Response + +{{#tip}} + + If you have already created a reaction of type `content`, the previously created reaction will be returned with `Status: 200 OK`. + +{{/tip}} + +<%= headers 201 %> +<%= json :reaction %> + + +## List reactions for an issue comment + + GET /repos/:owner/:repo/issues/comments/:id/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | Indicates which type of reaction to return. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:reaction) { |h| [h] } %> + + +## Create reaction for an issue comment + + POST /repos/:owner/:repo/issues/comments/:id/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | **Required**. The reaction type + +<%= json :content => 'heart' %> + +### Response + +{{#tip}} + + If you have already created a reaction of type `content`, the previously created reaction will be returned with `Status: 200 OK`. + +{{/tip}} + +<%= headers 201 %> +<%= json :reaction %> + + +## List reactions for a pull request review comment + + GET /repos/:owner/:repo/pulls/comments/:id/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | Indicates which type of reaction to return. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:reaction) { |h| [h] } %> + + +## Create reaction for a pull request review comment + + POST /repos/:owner/:repo/pulls/comments/:id/reactions + +### Parameters + +Name | Type | Description +-----|------|-------------- +`content`|`string` | **Required**. The reaction type + +<%= json :content => 'heart' %> + +### Response + +{{#tip}} + + If you have already created a reaction of type `content`, the previously created reaction will be returned with `Status: 200 OK`. + +{{/tip}} + +<%= headers 201 %> +<%= json :reaction %> + + +## Delete a reaction + + DELETE /reactions/:id + +### Response + +<%= headers 204 %> + +{% endif %} diff --git a/content/v3/repos.md b/content/v3/repos.md index e379f0f0c7..2e8b726228 100644 --- a/content/v3/repos.md +++ b/content/v3/repos.md @@ -1,44 +1,47 @@ --- -title: Repos | GitHub API +title: Repositories --- -# Repos API +# Repositories + +{:toc} ## List your repositories -List repositories for the authenticated user. +List repositories that are accessible to the authenticated user. + +This includes repositories owned by the authenticated user, repositories where +the authenticated user is a collaborator, and repositories that the +authenticated user has access to through an organization membership. GET /user/repos ### Parameters -type -: `all`, `owner`, `public`, `private`, `member`. Default: `all`. - -sort -: `created`, `updated`, `pushed`, `full_name`, default: `full_name`. - -direction -: `asc` or `desc`, default: when using `full_name`: `asc`, otherwise `desc`. +Name | Type | Description +-----|------|-------------- +`visibility` | `string` | Can be one of `all`, `public`, or `private`. Default: `all` +`affiliation` | `string` | Comma-separated list of values. Can include:
* `owner`: Repositories that are owned by the authenticated user.
* `collaborator`: Repositories that the user has been added to as a collaborator.
* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Default: `owner,collaborator,organization_member` +`type`|`string` | Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all`
Will cause a `422` error if used in the same request as **visibility** or **affiliation**. +`sort`|`string` | Can be one of `created`, `updated`, `pushed`, `full_name`. Default: `full_name` +`direction`|`string` | Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`; otherwise `desc` ## List user repositories List public repositories for the specified user. - GET /users/:user/repos + GET /users/:username/repos ### Parameters -type -: `all`, `owner`, `member`. Default: `all`. +Name | Type | Description +-----|------|------------- +`type`|`string` | Can be one of `all`, `owner`, `member`. Default: `owner` +`sort`|`string` | Can be one of `created`, `updated`, `pushed`, `full_name`. Default: `full_name` +`direction`|`string` | Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` -sort -: `created`, `updated`, `pushed`, `full_name`, default: `full_name`. -direction -: `asc` or `desc`, default: when using `full_name`: `asc`, otherwise `desc`. - -## List organization repositories. +## List organization repositories List repositories for the specified org. @@ -46,17 +49,54 @@ List repositories for the specified org. ### Parameters -type -: `all`, `public`, `member`, `private`. Default: `all`. +Name | Type | Description +-----|------|-------------- +`type`|`string` | Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. Default: `all` + ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:repo) { |h| [h] } %> +## List all public repositories + +This provides a dump of every public repository, in the order that they were created. + +Note: Pagination is powered exclusively by the `since` parameter. +Use the [Link header](/v3/#link-header) to get the URL for the next page of +repositories. + +{% if page.version != 'dotcom' and page.version >= 2.3 %} + +If you are an [authenticated](/v3/#authentication) site administrator for your Enterprise instance, +you will be able to list all repositories including private repositories. + +### Parameters + +Name | Type | Description +-----|------|-------------- +`visibility`|`string`| To include private repositories as well set to `all`. Default: `public` + +{% endif %} + + GET /repositories + +### Parameters + +Name | Type | Description +-----|------|-------------- +`since`|`string`| The integer ID of the last Repository that you've seen. + + +### Response + +<%= headers 200, :pagination => { :next => 'https://api.github.com/repositories?since=364' } %> +<%= json(:simple_repo) { |h| [h] } %> + ## Create -Create a new repository for the authenticated user. OAuth users must supply `repo` scope. +Create a new repository for the authenticated user. POST /user/repos @@ -65,42 +105,34 @@ be a member of the specified organization. POST /orgs/:org/repos -### Input - -name -: _Required_ **string** - -description -: _Optional_ **string** +### OAuth scope requirements -homepage -: _Optional_ **string** +When using [OAuth](/v3/oauth/#scopes), authorizations must include: -private -: _Optional_ **boolean** - `true` to create a private repository, `false` -to create a public one. Creating private repositories requires a paid -GitHub account. Default is `false`. +- `public_repo` scope or `repo` scope to create a public repository +- `repo` scope to create a private repository -has\_issues -: _Optional_ **boolean** - `true` to enable issues for this repository, -`false` to disable them. Default is `true`. - -has\_wiki -: _Optional_ **boolean** - `true` to enable the wiki for this -repository, `false` to disable it. Default is `true`. - -has\_downloads -: _Optional_ **boolean** - `true` to enable downloads for this -repository, `false` to disable them. Default is `true`. +### Input -team\_id -: _Optional_ **number** - The id of the team that will be granted access -to this repository. This is only valid when creating a repo in an -organization. +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. The name of the repository +`description`|`string` | A short description of the repository +`homepage`|`string` | A URL with more information about the repository +`private`|`boolean` | Either `true` to create a private repository, or `false` to create a public one. Creating private repositories requires a paid GitHub account. Default: `false` +`has_issues`|`boolean` | Either `true` to enable issues for this repository, `false` to disable them. Default: `true` +`has_wiki`|`boolean` | Either `true` to enable the wiki for this repository, `false` to disable it. Default: `true` +`has_downloads`|`boolean` | Either `true` to enable downloads for this repository, `false` to disable them. Default: `true` +`team_id`|`integer` | The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. +`auto_init`|`boolean` | Pass `true` to create an initial commit with empty README. Default: `false` +`gitignore_template`|`string` | Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". +`license_template`|`string` | Desired [LICENSE template](https://github.com/github/choosealicense.com) to apply. Use the [name of the template](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses) without the extension. For example, "mit" or "mozilla". + +#### Example <%= json \ :name => "Hello-World", - :description => "This is your first repo", + :description => "This is your first repository", :homepage => "https://github.com", :private => false, :has_issues => true, @@ -110,56 +142,46 @@ organization. ### Response -<%= headers 201, - :Location => -'https://api.github.com/repos/octocat/Hello-World' %> +<%= headers 201, :Location => get_resource(:repo)['url'] %> <%= json :repo %> ## Get - GET /repos/:user/:repo + GET /repos/:owner/:repo ### Response +The `parent` and `source` objects are present when the repository is a fork. +`parent` is the repository this repository was forked from, +`source` is the ultimate source for the network. + <%= headers 200 %> <%= json :full_repo %> ## Edit - PATCH /repos/:user/:repo + PATCH /repos/:owner/:repo ### Input -name -: _Required_ **string** - -description -: _Optional_ **string** - -homepage -: _Optional_ **string** - -private -: _Optional_ **boolean** - `true` makes the repository private, and -`false` makes it public. +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. The name of the repository +`description`|`string` | A short description of the repository +`homepage`|`string` | A URL with more information about the repository +`private`|`boolean` | Either `true` to make the repository private, or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false` +`has_issues`|`boolean` | Either `true` to enable issues for this repository, `false` to disable them. Default: `true` +`has_wiki`|`boolean` | Either `true` to enable the wiki for this repository, `false` to disable it. Default: `true` +`has_downloads`|`boolean` | Either `true` to enable downloads for this repository, `false` to disable them. Default: `true` +`default_branch`|`String` | Updates the default branch for this repository. -has\_issues -: _Optional_ **boolean** - `true` to enable issues for this repository, -`false` to disable them. Default is `true`. - -has\_wiki -: _Optional_ **boolean** - `true` to enable the wiki for this -repository, `false` to disable it. Default is `true`. - -has\_downloads -: _Optional_ **boolean** - `true` to enable downloads for this -repository, `false` to disable them. Default is `true`. +#### Example <%= json \ :name => "Hello-World", - :description => "This is your first repo", + :description => "This is your first repository", :homepage => "https://github.com", - :public => true, + :private => true, :has_issues => true, :has_wiki => true, :has_downloads => true @@ -172,24 +194,35 @@ repository, `false` to disable them. Default is `true`. ## List contributors - GET /repos/:user/:repo/contributors +List contributors to the specified repository, sorted by the number of commits per contributor in descending order. + +{{#tip}} + +Contributors data is cached for performance reasons. This endpoint may return information that is a few hours old. + +Git contributors are identified by author email address. This API attempts to group contribution counts by GitHub user, across all of their associated email addresses. For performance reasons, only the first 500 author email addresses in the repository will be linked to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. + +{{/tip}} + + GET /repos/:owner/:repo/contributors ### Parameters -anon -: Optional flag. Set to `1` or `true` to include anonymous contributors -in results. +Name | Type | Description +-----|------|------------- +`anon`|`string` | Set to `1` or `true` to include anonymous contributors in results. + ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:contributor) { |h| [h] } %> ## List languages List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language. - GET /repos/:user/:repo/languages + GET /repos/:owner/:repo/languages ### Response @@ -201,48 +234,29 @@ List languages for the specified repository. The value on the right of a languag ## List Teams - GET /repos/:user/:repo/teams + GET /repos/:owner/:repo/teams ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:team) { |h| [h] } %> ## List Tags - GET /repos/:user/:repo/tags + GET /repos/:owner/:repo/tags ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:tag) { |h| [h] } %> -## List Branches - - GET /repos/:user/:repo/branches - -### Response - -<%= headers 200 %> -<%= json(:branches) %> - -## Get Branch - - GET /repos/:user/:repo/branches/:branch - -### Response - -<%= headers 200 %> -<%= json(:branch) %> - ## Delete a Repository Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. - DELETE /repos/:user/:repo + DELETE /repos/:owner/:repo ### Response <%= headers 204 %> - diff --git a/content/v3/repos/branches.md b/content/v3/repos/branches.md new file mode 100644 index 0000000000..e620efd95c --- /dev/null +++ b/content/v3/repos/branches.md @@ -0,0 +1,522 @@ +--- +title: Branches +--- + +# Branches + +{:toc} + +{% if page.version != 'dotcom' and page.version >= 2.5 and page.version < 2.7 %} + +## List Branches + + GET /repos/:owner/:repo/branches + +### Parameters + +Name | Type | Description +-----|------|------------- +`protected`| `boolean` | Set to `true` to only return protected branches + +{{#tip}} + + + + The Protected Branch API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2015-11-11-protected-branches-api) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.loki-preview+json + + The `protection` key will only be present in branch payloads if this header is passed. + +{{/tip}} + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:branches) { |a| a.each { |b| b.merge!("protection" => { + "enabled" => false, + "required_status_checks" => { + "enforcement_level" => "off", + "contexts" => [] + } +}) } } %> + +## Get Branch + + GET /repos/:owner/:repo/branches/:branch + +### Response + +{{#tip}} + + + + The Protected Branch API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2015-11-11-protected-branches-api) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.loki-preview+json + + The `protection` key will only be present in branch payloads if this header is passed. + +{{/tip}} + +<%= headers 200 %> +<%= json(:branch) { |h| h.merge!("protection" => { + "enabled" => false, + "required_status_checks" => { + "enforcement_level" => "off", + "contexts" => [] + } +}) } %> + +## Enabling and disabling branch protection + +{{#tip}} + + + + The Protected Branch API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2015-11-11-protected-branches-api) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.loki-preview+json + +{{/tip}} + +Protecting a branch requires admin access. + + PATCH /repos/:owner/:repo/branches/:branch + +### Parameters + +You need to pass a `protection` object. + +Name | Type | Description +-----|------|------------- +`enabled`|`boolean` | **Required**. Should this branch be protected or not +`required_status_checks`|`object`| Configure required status checks here + +The `required_status_checks` object must have the following keys: + +Name | Type | Description +-----|------|------------- +`enforcement_level`|`string` | **Required**. Who required status checks apply to. Options are `off`, `non_admins` or `everyone`. +`contexts`|`array` | **Required**. The list of status checks to require in order to merge into this branch + +The `enforcement_level` key can have the following values: + +Name | Description +------|------------ +`off` | Turn off required status checks for this branch. +`non_admins` | Required status checks will be enforced for non-admins. +`everyone` | Required status checks will be enforced for everyone (including admins). + +#### Example + +<%= json \ + "protection" => { + "enabled" => true, + "required_status_checks" => { + "enforcement_level" => "everyone", + "contexts" => ["continuous-integration/travis-ci"] + } + } +%> + +{% endif %} + +{% if page.version == 'dotcom' or page.version >= 2.7 %} + +{{#tip}} + + + + The Protected Branch API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2016-06-27-protected-branches-api-update) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.loki-preview+json + +{{/tip}} + +## List Branches + + GET /repos/:owner/:repo/branches + +### Parameters + +Name | Type | Description +-----|------|------------- +`protected` | `boolean` | Set to `true` to only return protected branches + +{{#tip}} + + + + The Protected Branch API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2016-06-27-protected-branches-api-update) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.loki-preview+json + + The `protected` key will only be present in branch payloads if this header is passed. + +{{/tip}} + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:branches) { |a| a.each { |b| b.merge!( + "protected": true, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/#{b["name"]}/protection", +) } } %> + +## Get Branch + + GET /repos/:owner/:repo/branches/:branch + +### Response + +{{#tip}} + + + + The Protected Branch API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + Please see the [blog post](/changes/2016-06-27-protected-branches-api-update) for full details. + + To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.loki-preview+json + + The `protected` key will only be present in branch payloads if this header is passed. + +{{/tip}} + +<%= headers 200 %> +<%= json(:branch) { |h| h.merge!( + "protected": true, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/#{h["name"]}/protection", +) } %> + + +## Get branch protection + + GET /repos/:owner/:repo/branches/:branch/protection + +<%= headers 200 %> +<%= json(:repo_branch_protection) %> + +## Update branch protection + +Protecting a branch requires admin access. + + PUT /repos/:owner/:repo/branches/:branch/protection + +### Parameters + +You must pass two objects: `required_status_checks` and `restrictions`. Both can have the value `null` for disabled. + +The `required_status_checks` object must have the following keys: + +Name | Type | Description +-----|------|------------- +`include_admins` | `boolean` | **Required**. Enforce required status checks for repository administrators. +`strict` | `boolean` | **Required**. Require branches to be up to date before merging. +`contexts` | `array` | **Required**. The list of status checks to require in order to merge into this branch + +The `restrictions` object must have the following keys: + +Name | Type | Description +-----|------|------------- +`users` | `array` | The list of user `login`s with push access +`teams` | `array` | The list of team `slug`s with push access + +{{#tip}} + +* Teams and users `restrictions` are only available for organization-owned repositories. +* The list of users and teams in total is limited to 100 items. + +{{/tip}} + +### Example + +<%= json \ + "required_status_checks" => { + "include_admins" => true, + "strict" => true, + "contexts" => ["continuous-integration/travis-ci"] + }, + "restrictions" => { + "users" => ["octocat"], + "teams" => ["justice-league"] + } +%> + +### Response + +<%= headers 200 %> +<%= json(:repo_branch_protection) %> + +## Remove branch protection + + DELETE /repos/:owner/:repo/branches/:branch/protection + +<%= headers 204 %> + +## Get required status checks of protected branch + + GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks + +<%= headers 200 %> +<%= json(:repo_branch_protection_required_status_checks) %> + +## Update required status checks of protected branch + +Updating required status checks requires admin access and branch protection to be enabled. + + PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks + +### Parameters + +The object passed can have the following keys: + +Name | Type | Description +-----|------|------------- +`include_admins`|`boolean` | Enforce required status checks for repository administrators. +`strict`|`boolean` | Require branches to be up to date before merging. +`contexts`|`array` | The list of status checks to require in order to merge into this branch + +### Example + +<%= json \ + "include_admins" => true, + "strict" => true, + "contexts" => ["continuous-integration/travis-ci"] +%> + +### Response + +<%= headers 200 %> +<%= json(:repo_branch_protection_required_status_checks) %> + +## Remove required status checks of protected branch + + DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks + +<%= headers 204 %> + +## List required status checks contexts of protected branch + + GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts + +<%= headers 200 %> +<%= json ["continuous-integration/travis-ci"] %> + +## Replace required status checks contexts of protected branch + + PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts + +### Example + +<%= json ["continuous-integration/travis-ci"] %> + +### Response + +<%= headers 200 %> +<%= json ["continuous-integration/travis-ci"] %> + +## Add required status checks contexts of protected branch + + POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts + +### Example + +<%= json ["continuous-integration/jenkins"] %> + +### Response + +<%= headers 200 %> +<%= json ["continuous-integration/travis-ci", "continuous-integration/jenkins"] %> + +## Remove required status checks contexts of protected branch + + DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts + +### Example + +<%= json ["continuous-integration/jenkins"] %> + +### Response + +<%= headers 200 %> +<%= json ["continuous-integration/travis-ci"] %> + + +## Get restrictions of protected branch + +{{#tip}} + +Teams and users `restrictions` are only available for organization-owned repositories. + +{{/tip}} + + GET /repos/:owner/:repo/branches/:branch/protection/restrictions + +<%= headers 200 %> +<%= json(:repo_branch_protection_restrictions) %> + +## Remove restrictions of protected branch + + DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions + +<%= headers 204 %> + +## List team restrictions of protected branch + + GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams + +<%= headers 200 %> +<%= json(:team) { |h| [h] } %> + +## Replace team restrictions of protected branch + + PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams + +### Body parameters + +Pass the list of team `slug`s with push access. + +{{#tip}} + + The list of users and teams in total is limited to 100 items. + +{{/tip}} + +### Example + +<%= json ["justice-league"] %> + +### Response + +<%= headers 200 %> +<%= json(:team) { |h| [h] } %> + +## Add team restrictions of protected branch + + POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams + +### Body parameters + +Pass the list of team `slug`s with push access. + +{{#tip}} + +The list of users and teams in total is limited to 100 items. + +{{/tip}} + +### Example + +<%= json ["justice-league"] %> + +### Response + +<%= headers 200 %> +<%= json(:team) { |h| [h] } %> + +## Remove team restrictions of protected branch + + DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams + +### Example + +<%= json ["octocats"] %> + +### Response + +<%= headers 200 %> +<%= json(:team) { |h| [h] } %> + + +## List user restrictions of protected branch + + GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users + +<%= headers 200 %> +<%= json(:user) { |h| [h] } %> + +## Replace user restrictions of protected branch + + PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users + +### Body parameters + +Pass the list of user `login`s with push access. + +{{#tip}} + +The list of users and teams in total is limited to 100 items. + +{{/tip}} + +### Example + +<%= json ["octocat"] %> + +### Response + +<%= headers 200 %> +<%= json(:user) { |h| [h] } %> + +## Add user restrictions of protected branch + + POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users + +### Body parameters + +Pass the list of user `login`s with push access. + +{{#tip}} + +The list of users and teams in total is limited to 100 items. + +{{/tip}} + +### Example + +<%= json ["octocat"] %> + +### Response + +<%= headers 200 %> +<%= json(:user) { |h| [h] } %> + +## Remove user restrictions of protected branch + + DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users + +### Example + +<%= json ["defunkt"] %> + +### Response + +<%= headers 200 %> +<%= json(:user) { |h| [h] } %> + + +{% endif %} diff --git a/content/v3/repos/collaborators.md b/content/v3/repos/collaborators.md index 1bfe5b6436..5e22e210d7 100644 --- a/content/v3/repos/collaborators.md +++ b/content/v3/repos/collaborators.md @@ -1,21 +1,51 @@ --- -title: Repo Collaborators | GitHub API +title: Collaborators --- -# Repo Collaborators API +# Collaborators -## List +{:toc} - GET /repos/:user/:repo/collaborators + + +## List collaborators + + GET /repos/:owner/:repo/collaborators + +When authenticating as an organization owner of an organization-owned +repository, all organization owners are included in the list of collaborators. +Otherwise, only users with access to the repository are returned in the +collaborators list. ### Response -<%= headers 200 %> +{% if page.version != 'dotcom' and page.version > 2.3 and page.version < 2.6 %} + +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> -## Get +### Alternative response with extra repository information + +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Organization Permissions API. Please see the [blog post](/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions/) for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ironman-preview+json +``` + +{{/tip}} - GET /repos/:user/:repo/collaborators/:user +{% endif %} + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:collaborator) { |h| [h] } %> + +## Check if a user is a collaborator + + GET /repos/:owner/:repo/collaborators/:username ### Response if user is a collaborator @@ -25,17 +55,68 @@ title: Repo Collaborators | GitHub API <%= headers 404 %> -## Add collaborator +## Add user as a collaborator + + PUT /repos/:owner/:repo/collaborators/:username + +### Parameters + +{% if page.version == 'dotcom' or page.version >= 2.4 %} + +Name | Type | Description +-----|------|-------------- +`permission`|`string` | The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of:
* `pull` - can pull, but not push to or administer this repository.
* `push` - can pull and push, but not administer this repository.
* `admin` - can pull, push and administer this repository.
Default: `push` + +<%= fetch_content(:optional_put_content_length) %> - PUT /repos/:user/:repo/collaborators/:user +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Repository Invitations API. + +To send an invitation to a collaborator rather than directly adding them, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.swamp-thing-preview+json +``` + +{{/tip}} + +{% if page.version != 'dotcom' and page.version > 2.3 and page.version < 2.6 %} + +{{#tip}} + +We're currently offering a preview period allowing applications to opt in to the Organization Permissions API. Please see the [blog post](/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions/) for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ironman-preview+json +``` + +**Warning:** If you use this API to add a collaborator to a repository that's owned by an organization that hasn't had [improved organization permissions](https://github.com/blog/2020-improved-organization-permissions) enabled yet, you will get a `422` error response. + +{{/tip}} + +{% endif %} + +{% else %} + +<%= fetch_content(:put_content_length) %> + +{% endif %} ### Response <%= headers 204 %> -## Remove collaborator +### Response with preview media type + +<%= headers 201 %> +<%= json(:repository_invitation) %> + +## Remove user as a collaborator - DELETE /repos/:user/:repo/collaborators/:user + DELETE /repos/:owner/:repo/collaborators/:username ### Response diff --git a/content/v3/repos/comments.md b/content/v3/repos/comments.md index 5b7e7b1cba..e6f9bb5050 100644 --- a/content/v3/repos/comments.md +++ b/content/v3/repos/comments.md @@ -1,83 +1,144 @@ --- -title: Repo Comments | GitHub API +title: Comments --- -# Repo Comments API +# Comments + +{:toc} ## List commit comments for a repository -Commit Comments leverage [these](#custom-mime-types) custom mime types. You can -read more about the use of mime types in the API [here](/v3/mime/). +Commit Comments use [these custom media types](#custom-media-types). You can +read more about the use of media types in the API [here](/v3/media/). Comments are ordered by ascending ID. - GET /repos/:user/:repo/comments + GET /repos/:owner/:repo/comments ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:commit_comment) { |h| [h] } %> +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the commit comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :commit_comment_reaction_summary %> +{% endif %} + ## List comments for a single commit - GET /repos/:user/:repo/commits/:sha/comments + GET /repos/:owner/:repo/commits/:ref/comments ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:commit_comment) { |h| [h] } %> -## Create a commit comment +{% if page.version == 'dotcom' %} +#### Reactions summary - POST /repos/:user/:repo/commits/:sha/comments +{{#tip}} -### Input + + + An additional `reactions` object in the commit comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: -body -: _Required_ **string** + application/vnd.github.squirrel-girl-preview -path -: _Required_ **string** - Relative path of the file to comment on. + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. -position -: _Required_ **number** - Line index in the diff to comment on. +{{/tip}} +<%= json :commit_comment_reaction_summary %> +{% endif %} -line -: _Optional_ **number** - Line number in the file to comment on. Defaults to 1. +## Create a commit comment + + POST /repos/:owner/:repo/commits/:sha/comments + +### Input + +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The contents of the comment. +`path`|`string` | Relative path of the file to comment on. +`position`|`integer` | Line index in the diff to comment on. +`line`|`integer` | **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. #### Example <%= json \ - :body => 'Nice change', - :commit_id => '6dcb09b5b57875f334f61aebed695e2e4193db5e', - :line => 1, + :body => 'Great stuff', :path => 'file1.txt', - :position => 4 + :position => 4, + :line => nil %> ### Response -<%= headers 201, :Location => "https://api.github.com/user/repo/comments/1" %> +<%= headers 201, :Location => get_resource(:commit_comment)['url'] %> <%= json :commit_comment %> ## Get a single commit comment - GET /repos/:user/:repo/comments/:id + GET /repos/:owner/:repo/comments/:id ### Response <%= headers 200 %> <%= json :commit_comment %> +{% if page.version == 'dotcom' %} +#### Reactions summary + +{{#tip}} + + + + An additional `reactions` object in the commit comment payload is currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.squirrel-girl-preview + + The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions. + +{{/tip}} +<%= json :commit_comment_reaction_summary %> +{% endif %} + ## Update a commit comment - PATCH /repos/:user/:repo/comments/:id + PATCH /repos/:owner/:repo/comments/:id ### Input -body -: _Required_ **string** +Name | Type | Description +-----|------|-------------- +`body`|`string` | **Required**. The contents of the comment + #### Example @@ -88,20 +149,20 @@ body ### Response <%= headers 200 %> -<%= json :commit_comment %> +<%= json(:commit_comment) { |h| h.merge('body' => 'Nice change') } %> ## Delete a commit comment - DELETE /repos/:user/:repo/comments/:id + DELETE /repos/:owner/:repo/comments/:id ### Response <%= headers 204 %> -## Custom Mime Types +## Custom media types -These are the supported mime types for commit comments. You can read more -about the use of mime types in the API [here](/v3/mime/). +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/v3/media/). application/vnd.github-commitcomment.raw+json application/vnd.github-commitcomment.text+json diff --git a/content/v3/repos/commits.md b/content/v3/repos/commits.md index ab940d93fa..20c2ee69c3 100644 --- a/content/v3/repos/commits.md +++ b/content/v3/repos/commits.md @@ -1,49 +1,141 @@ --- -title: Repo Commits | GitHub API +title: Commits --- -# Repo Commits API +# Commits + +{:toc} The Repo Commits API supports listing, viewing, and comparing commits in a repository. ## List commits on a repository - GET /repos/:user/:repo/commits - -_A special note on pagination:_ Due to the way Git works, commits are paginated -based on SHA instead of page number. Please follow the link headers as outlined -in the [pagination overview](http://developer.github.com/v3/#pagination) -instead of constructing page links yourself. + GET /repos/:owner/:repo/commits ### Parameters -sha -: _Optional_ **string** - Sha or branch to start listing commits from. +Name | Type | Description +-----|------|-------------- +`sha`|`string` | SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). +`path`|`string` | Only commits containing this file path will be returned. +`author`|`string` | GitHub login or email address by which to filter by commit author. +`since`|`string` | Only commits after this date will be returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. +`until`|`string` | Only commits before this date will be returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. -path -: _Optional_ **string** - Only commits containing this file path -will be returned. ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:commit) { |h| [h] } %> ## Get a single commit - GET /repos/:user/:repo/commits/:sha + GET /repos/:owner/:repo/commits/:sha ### Response +Diffs with binary data will have no 'patch' property. Pass the +appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and +patch formats. + <%= headers 200 %> <%= json(:full_commit) %> -Note: Diffs with binary data will have no 'patch' property. +## Get the SHA-1 of a commit reference + +Users with read access can get the SHA-1 of a commit reference: + + GET /repos/:owner/:repo/commits/:ref + +To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.VERSION.sha + +To check if a remote reference's SHA-1 is the same as your local reference's SHA-1, make a `GET` request and provide the current SHA-1 for the local reference as the ETag. + +### Response + +The SHA-1 of the commit reference. + +<%= headers 200 %> +
+814412cfbd631109df337e16c807207e78c0d24e +## Compare two commits - GET /repos/:user/:repo/compare/:base...:head + GET /repos/:owner/:repo/compare/:base...:head + +Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `
-curl -L https://api.github.com/repos/pengwynn/octokit/tarball > octokit.tar.gz +``` command-line +$curl -L https://api.github.com/repos/octokit/octokit.rb/tarball > octokit.tar.gz + +> % Total % Received % Xferd Average Speed Time Time Time Current +> Dload Upload Total Spent Left Speed +> 100 206k 100 206k 0 0 146k 0 0:00:01 0:00:01 --:--:-- 790k +``` + +## Custom media types + +[READMEs](#get-the-readme), [files](#get-contents), and [symlinks](#get-contents) support the following custom media types: + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.html + +Use the `.raw` media type to retrieve the contents of the file. + +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). + +[All objects](#get-contents) support the following custom media type: + + application/vnd.github.VERSION.object + +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. - % Total % Received % Xferd Average Speed Time Time Time Current - Dload Upload Total Spent Left Speed -100 206k 100 206k 0 0 146k 0 0:00:01 0:00:01 --:--:-- 790k -+You can read more about the use of media types in the API [here](/v3/media/). diff --git a/content/v3/repos/deployments.md b/content/v3/repos/deployments.md new file mode 100644 index 0000000000..34e2574621 --- /dev/null +++ b/content/v3/repos/deployments.md @@ -0,0 +1,277 @@ +--- +title: Deployments +--- + +# Deployments + +{:toc} + +Deployments are a request for a specific ref (branch, SHA, tag) to be deployed. +GitHub then dispatches deployment events that external services can listen for +and act on. This enables developers and organizations to build loosely-coupled +tooling around deployments, without having to worry about implementation +details of delivering different types of applications (e.g., web, native). + +Deployment Statuses allow external services to mark deployments with a +'success', 'failure', 'error', or 'pending' state, which can then be consumed +by any system listening for `deployment_status` events. + +Deployment Statuses can also include an optional `description` and `target_url`, and +we highly recommend providing them as they make deployment statuses much more +useful. The `target_url` would be the full URL to the deployment output, and +the `description` would be the high level summary of what happened with the +deployment. + +Deployments and Deployment Statuses both have associated +[repository events](/v3/activity/events/types/#deploymentevent) when +they're created. This allows webhooks and 3rd party integrations to respond to +deployment requests as well as update the status of a deployment as progress is +made. + +Below is a simple sequence diagram for how these interactions would work. + +``` ++---------+ +--------+ +-----------+ +-------------+ +| Tooling | | GitHub | | 3rd Party | | Your Server | ++---------+ +--------+ +-----------+ +-------------+ + | | | | + | Create Deployment | | | + |--------------------->| | | + | | | | + | Deployment Created | | | + |<---------------------| | | + | | | | + | | Deployment Event | | + | |---------------------->| | + | | | SSH+Deploys | + | | |-------------------->| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | + | | | Deploy Completed | + | | |<--------------------| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | +``` + +Keep in mind that GitHub is never actually accessing your servers. It's up to +your 3rd party integration to interact with deployment events. This allows for +[GitHub integrations](https://github.com/integrations) as +well as running your own systems depending on your use case. Multiple systems +can listen for deployment events, and it's up to each of those systems to +decide whether or not they're responsible for pushing the code out to your +servers, building native code, etc. + +Note that the `repo_deployment` [OAuth scope](/v3/oauth/#scopes) grants +targeted access to Deployments and Deployment Statuses **without** +granting access to repository code, while the `repo` scope grants permission to code +as well. + +## List Deployments + +Simple filtering of deployments is available via query parameters: + + GET /repos/:owner/:repo/deployments + +Name | Type | Description +-----|------|-------------- +`sha`|`string` | The SHA that was recorded at creation time. Default: `none` +`ref`|`string` | The name of the ref. This can be a branch, tag, or SHA. Default: `none` +`task`|`string` | The name of the task for the deployment. e.g. `deploy` or `deploy:migrations`. Default: `none` +`environment`|`string` | The name of the environment that was deployed to. e.g. `staging` or `production`. Default: `none` + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:deployment) { |h| [h] } %> + +## Create a Deployment + +Deployments offer a few configurable parameters with sane defaults. + +The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often +deploy branches and verify them before we merge a pull request. + +The `environment` parameter allows deployments to be issued to different +runtime environments. Teams often have multiple environments for verifying +their applications, like 'production', 'staging', and 'qa'. This allows for +easy tracking of which environments had deployments requested. The default +environment is 'production'. + +The `auto_merge` parameter is used to ensure that the requested ref is not +behind the repository's default branch. If the ref *is* behind the default +branch for the repository, we will attempt to merge it for you. If the merge +succeeds, the API will return a successful merge commit. If merge conflicts +prevent the merge from succeeding, the API will return a failure response. + +By default, [commit statuses](/v3/repos/statuses) for every submitted context +must be in a 'success' state. The `required_contexts` parameter allows you to +specify a subset of contexts that must be "success", or to specify contexts +that have not yet been submitted. You are not required to use commit statuses +to deploy. If you do not require any contexts or create any commit statuses, +the deployment will always succeed. + +The `payload` parameter is available for any extra information that a +deployment system might need. It is a JSON text field that will be passed on +when a deployment event is dispatched. + +The `task` parameter is used by the deployment system to allow different +execution paths. In the web world this might be 'deploy:migrations' to run +schema changes on the system. In the compiled world this could be a flag to +compile an application with debugging enabled. + +Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref: + + POST /repos/:owner/:repo/deployments + +### Parameters + +Name | Type | Description +-----|------|-------------- +`ref`|`string`| **Required**. The ref to deploy. This can be a branch, tag, or SHA. +`task`|`string`| Optional parameter to specify a task to execute, e.g. `deploy` or `deploy:migrations`. Default: `deploy` +`auto_merge`|`boolean`| Optional parameter to merge the default branch into the requested ref if it is behind the default branch. Default: `true` +`required_contexts`|`Array`| Optional array of status contexts verified against commit status checks. If this parameter is omitted from the parameters then all unique contexts will be verified before a deployment is created. To bypass checking entirely pass an empty array. Defaults to all unique contexts. +`payload`|`string` | Optional JSON payload with extra information about the deployment. Default: `""` +`environment`|`string` | Optional name for the target deployment environment (e.g., production, staging, qa). Default: `"production"` +`description`|`string` | Optional short description. Default: `""` +{% if page.version == 'dotcom' || page.version > 2.6 %} `transient_environment` | `boolean` | Optionally specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` **This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} +{% if page.version == 'dotcom' || page.version > 2.6 %} `production_environment` | `boolean` | Optionally specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `"production"` and `false` otherwise. **This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} + +{% if page.version == 'dotcom' || page.version > 2.6 %} +{{#tip}} + +The new `transient_environment` and `production_environment` parameters are currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post][blog-post] for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ant-man-preview+json +``` + +{{/tip}} + +{% endif %} + +#### Simple Example + +A simple example putting the user and room into the payload to notify back to +chat networks. + +<%= json \ + :ref => "topic-branch", + :payload => "{\"user\":\"atmos\",\"room_id\":123456}", + :description => "Deploying my sweet branch" +%> + +### Successful response + +<%= headers 201, :Location => get_resource(:deployment)['url'] %> +<%= json :deployment %> + +#### Advanced Example + +A more advanced example specifying required commit statuses and bypassing auto-merging. + +<%= json \ + :ref => "topic-branch", + :auto_merge => false, + :payload => "{\"user\":\"atmos\",\"room_id\":123456}", + :description => "Deploying my sweet branch", + :required_contexts => ["ci/janky", "security/brakeman"] +%> + +### Successful response + +<%= headers 201, :Location => get_resource(:deployment)['url'] %> +<%= json :deployment %> + +### Merge conflict response + +This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + +<%= headers 409 %> +<%= json({ :message => "Conflict merging master into topic-branch" }) %> + +### Failed commit status checks + +This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + +<%= headers 409 %> +<%= json({ :message => "Conflict: Commit status checks failed for topic-branch." }) %> + +## Update a Deployment + +Once a deployment is created, it cannot be updated. Information relating to the +success or failure of a deployment is handled through Deployment Statuses. + +# Deployment Statuses + +## List Deployment Statuses + +Users with pull access can view deployment statuses for a deployment: + + GET /repos/:owner/:repo/deployments/:id/statuses + +### Parameters + +Name | Type | Description +-----|------|-------------- +`id` |`integer`| **Required**. The Deployment ID to list the statuses from. + + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:deployment_status) { |h| h.delete("deployment"); [h] } %> + +## Create a Deployment Status + +Users with push access can create deployment statuses for a given deployment: + + POST /repos/:owner/:repo/deployments/:id/statuses + +### Parameters + +Name | Type | Description +-----|------|-------------- +`state`|`string` | **Required**. The state of the status. Can be one of `pending`, `success`, `error`, {% if page.version == 'dotcom' || page.version > 2.6 %} `inactive`, {% endif %}or `failure` **The `inactive` state requires a custom media type to be specified. Please see more in the alert below.**. +`target_url`|`string` | The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Default: `""` +{% if page.version == 'dotcom' || page.version > 2.6 %}`log_url`|`string` | This is functionally equivalent to `target_url`. We will continue accept `target_url` to support legacy uses, but we recommend modifying this to the new name to avoid confusion. Default: `""` **This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} +`description`|`string` | A short description of the status. Maximum length of 140 characters. Default: `""` +{% if page.version == 'dotcom' || page.version > 2.6 %}`environment_url`|`string`| Optionally set the URL for accessing your environment. Default: `""` **This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} +{% if page.version == 'dotcom' || page.version > 2.6 %}`auto_inactive`|`boolean`| Optional parameter to add a new `inactive` status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. Default: `true` **This parameter requires a custom media type to be specified. Please see more in the alert below.**{% endif %} + +{% if page.version == 'dotcom' || page.version > 2.6 %} + +{{#tip}} + +The new `inactive` state, rename of the `target_url` parameter to `log_url` and new `environment_url` and `auto_inactive` parameters are currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post][blog-post] for full details. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.ant-man-preview+json +``` + +{{/tip}} + +{% endif %} + +#### Example + +<%= json \ + :state => "success", + :target_url => "https://example.com/deployment/42/output", + :description => "Deployment finished successfully." +%> + +### Response + +<%= headers 201, :Location => get_resource(:deployment_status)['url'] %> +<%= json :deployment_status %> + +[blog-post]: /changes/2016-04-06-deployment-and-deployment-status-enhancements diff --git a/content/v3/repos/downloads.md b/content/v3/repos/downloads.md index a49fee2614..c5f027a106 100644 --- a/content/v3/repos/downloads.md +++ b/content/v3/repos/downloads.md @@ -1,124 +1,46 @@ --- -title: Repo Downloads | GitHub API +title: Downloads --- -# Repo Downloads API +# Downloads + +{:toc} + +### Downloads API is Deprecated + +{{#warning}} + +The Downloads API (described below) was deprecated on December 11, 2012. It will be removed at a future date. + +We recommend using Releases instead. + +{{/warning}} The downloads API is for package downloads only. If you want to get -source tarballs you should use [this](/repos/contents/#get-archive-link) +source tarballs you should use [this](/v3/repos/contents/#get-archive-link) instead. ## List downloads for a repository - GET /repos/:user/:repo/downloads + GET /repos/:owner/:repo/downloads ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:download) { |h| [h] } %> ## Get a single download - GET /repos/:user/:repo/downloads/:id + GET /repos/:owner/:repo/downloads/:id ### Response <%= headers 200 %> <%= json :download %> -## Create a new download (Part 1: Create the resource) - -Creating a new download is a two step process. You must first create a -new download resource. - - POST /repos/:user/:repo/downloads - -### Input - -name -: _Required_ **string** - -size -: _Required_ **number** - Size of file in bytes. - -description -: _Optional_ **string** - -content\_type -: _Optional_ **string** - -<%= json \ - :name => "new_file.jpg", - :size => 114034, - :description => "Latest release", - :content_type => "text/plain" -%> - -### Response - -<%= headers 201, :Location => "https://api.github.com/user/repo/downloads/1" %> -<%= json :create_download %> - -## Create a new download (Part 2: Upload file to s3) - -Now that you have created the download resource, you can use the -information in the response to upload your file to s3. This can be done -with a `POST` to the `s3_url` you got in the create response. Here is a -brief example using curl: - - curl \ - -F "key=downloads/octocat/Hello-World/new_file.jpg" \ - -F "acl=public-read" \ - -F "success_action_status=201" \ - -F "Filename=new_file.jpg" \ - -F "AWSAccessKeyId=1ABCDEF..." \ - -F "Policy=ewogIC..." \ - -F "Signature=mwnF..." \ - -F "Content-Type=image/jpeg" \ - -F "file=@new_file.jpg" \ - https://github.s3.amazonaws.com/ - -NOTES - -The order in which you pass these fields matters! Follow the order shown -above exactly. All parameters shown are required and if you excluded or -modify them your upload will fail because the values are hashed and signed -by the policy. - -key -: Value of `path` field in the response. - -acl -: Value of `acl` field in the response. - -success_action_status -: 201, or whatever you want to get back. - -Filename -: Value of `name` field in the response. - -AWSAccessKeyId -: Value of `accesskeyid` field in the response. - -Policy -: Value of `policy` field in the response. - -Signature -: Value of `signature` field in the response. - -Content-Type -: Value of `mime_type` field in the response. - -file -: Local file. Example assumes the file existing in the directory where -you are running the curl command. Yes, the `@` matters. - -More information about using the REST API to interact with s3 can -be found [here](http://docs.amazonwebservices.com/AmazonS3/latest/API/). - ## Delete a download - DELETE /repos/:user/:repo/downloads/:id + DELETE /repos/:owner/:repo/downloads/:id ### Response diff --git a/content/v3/repos/forks.md b/content/v3/repos/forks.md index 5e5ab1bc9c..27c1c98f89 100644 --- a/content/v3/repos/forks.md +++ b/content/v3/repos/forks.md @@ -1,40 +1,45 @@ --- -title: Repo Forks | GitHub API +title: Forks --- -# Repo Forks API +# Forks + +{:toc} ## List forks - GET /repos/:user/:repo/forks + GET /repos/:owner/:repo/forks ### Parameters -sort -: `newest`, `oldest`, `watchers`, default: `newest`. +Name | Type | Description +-----|------|------------- +`sort`|`string` | The sort order. Can be either `newest`, `oldest`, or `stargazers`. Default: `newest` + ### Response -<%= headers 200 %> -<%= json(:repo) { |h| [h] } %> +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:repo) { |h| h['fork'] = true; [h] } %> ## Create a fork Create a fork for the authenticated user. - POST /repos/:user/:repo/forks + POST /repos/:owner/:repo/forks ### Parameters -org -: _Optional_ **String** - Organization login. The repository will be -forked into this organization. +Name | Type | Description +-----|------|------------- +`organization`|`string` | Optional parameter to specify the organization name if forking into an organization. + ### Response Forking a Repository happens asynchronously. Therefore, you may have to wait a short period before accessing the git objects. If this takes longer than -5 minutes, be sure to [contact Support](https://github.com/contact). +5 minutes, be sure to [contact Support](https://github.com/contact?form[subject]=APIv3). <%= headers 202 %> -<%= json :repo %> +<%= json(:repo) { |h| h['fork'] = true; h } %> diff --git a/content/v3/repos/hooks.md b/content/v3/repos/hooks.md index c5acc6cc07..2208924598 100644 --- a/content/v3/repos/hooks.md +++ b/content/v3/repos/hooks.md @@ -1,53 +1,29 @@ --- -title: Repo Hooks | GitHub API +title: Repository Webhooks --- -# Repo Hooks API +# Webhooks -The Repository Hooks API manages the post-receive web and service hooks -for a repository. There are two main APIs to manage these hooks: a JSON -HTTP API, and [PubSubHubbub](#pubsubhubbub). +{:toc} -Active hooks can be configured to trigger for one or more events. -The default event is `push`. The available events are: +The Repository Webhooks API allows repository admins to manage the post-receive +hooks for a repository. Webhooks can be managed using the JSON HTTP API, +or the [PubSubHubbub API](#pubsubhubbub). -* `push` - Any git push to a Repository. -* `issues` - Any time an Issue is opened or closed. -* `issue_comment` - Any time an Issue is commented on. -* `commit_comment` - Any time a Commit is commented on. -* `pull_request` - Any time a Pull Request is opened, closed, or - synchronized (updated due to a new push in the branch that the pull -request is tracking). -* `gollum` - Any time a Wiki page is updated. -* `watch` - Any time a User watches the Repository. -* `download` - Any time a Download is added to the Repository. -* `fork` - Any time a Repository is forked. -* `fork_apply` - Any time a patch is applied to the Repository from the - Fork Queue. -* `member` - Any time a User is added as a collaborator to a - non-Organization Repository. -* `public` - Any time a Repository changes from private to public. +If you would like to set up a single webhook to receive events from all of your organization's repositories, check out our [API documentation for Organization Webhooks][org-hooks]. -The payloads for all of the hooks mirror [the payloads for the Event -types](/v3/events/types/), with the exception of [the original `push` -event](http://help.github.com/post-receive-hooks/). +## List hooks -For a Hook to go through, the Hook needs to be configured to trigger for -an event, and the Service has to listen to it. The Services are all -part of the open source [github-services](https://github.com/github/github-services) project. Most of the Services only listen for `push` events. However, the generic [Web Service](https://github.com/github/github-services/blob/master/services/web.rb) listens for all events. Other services like the [IRC Service](https://github.com/github/github-services/blob/master/services/irc.rb) may only listen for `push`, `issues`, and `pull_request` events. - -## List - - GET /repos/:user/:repo/hooks + GET /repos/:owner/:repo/hooks ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:hook) { |h| [h] } %> ## Get single hook - GET /repos/:user/:repo/hooks/:id + GET /repos/:owner/:repo/hooks/:id ### Response @@ -56,86 +32,66 @@ part of the open source [github-services](https://github.com/github/github-servi ## Create a hook - POST /repos/:user/:repo/hooks + POST /repos/:owner/:repo/hooks + +**Note**: Repository service hooks (like email or Campfire) can have at most one configured at a time. Creating hooks for a service that already has one configured will [update the existing hook](#edit-a-hook). + +Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap. -### Input +### Parameters + +Name | Type | Description +-----|------|-------------- +`name`|`string` | **Required**. Use `web` for a webhook or use the name of a valid service. (See /hooks for the list of valid service names.) +`config`|`object` | **Required**. Key/value pairs to provide settings for this hook. These settings vary between hooks and some are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON `true`/`false` values will be converted automatically. +`events`|`array` | Determines what events the hook is triggered for. Default: `["push"]` +`active`|`boolean` | Determines whether the hook is actually triggered on pushes. -`name` -: _Required_ **string** - The name of the service that is being called. -See [/hooks](https://api.github.com/hooks) for the possible names. +#### Example -`config` -: _Required_ **hash** - A Hash containing key/value pairs to provide -settings for this hook. These settings vary between the services and -are defined in the -[github-services](https://github.com/github/github-services) repo. -Booleans are stored internally as "1" for true, and "0" for false. Any -JSON true/false values will be converted automatically. +To create [a webhook](/webhooks), the following fields are required by the `config`: -`events` -: _Optional_ **array** - Determines what events the hook is triggered -for. Default: `["push"]`. +* `url`: A required string defining the URL to which the payloads will be delivered. +* `content_type`: An optional string defining the media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. +* `secret`: An optional string that's passed with the HTTP requests as an `X-Hub-Signature` header. The value of this header is computed as the HMAC hex digest of the body, using the `secret` as the key. +* `insecure_ssl`: An optional string that determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `"0"` (verification is performed) and `"1"` (verification is not performed). The default is `"0"`. -`active` -: _Optional_ **boolean** - Determines whether the hook is actually -triggered on pushes. +Here's how you can create a hook that posts payloads in JSON format: <%= json \ :name => "web", :active => true, + :events => ['push', 'pull_request'], :config => { - :url => 'http://something.com/webhook'} + :url => 'http://example.com/webhook', + :content_type => 'json'} %> ### Response -<%= headers 201, - :Location => 'https://api.github.com/repos/user/repo/hooks/1' %> +<%= headers 201, :Location => get_resource(:hook)['url'] %> <%= json :hook %> -### Edit a hook - - PATCH /repos/:user/:repo/hooks/:id - -### Input +## Edit a hook -`name` -: _Required_ **string** - The name of the service that is being called. -See [/hooks](https://api.github.com/hooks) for the possible names. + PATCH /repos/:owner/:repo/hooks/:id -`config` -: _Required_ **hash** - A Hash containing key/value pairs to provide -settings for this hook. Modifying this will replace the entire config -object. These settings vary between the services and -are defined in the -[github-services](https://github.com/github/github-services) repo. -Booleans are stored internally as "1" for true, and "0" for false. Any -JSON true/false values will be converted automatically. - - -`events` -: _Optional_ **array** - Determines what events the hook is triggered -for. This replaces the entire array of events. Default: `["push"]`. +### Parameters -`add_events` -: _Optional_ **array** - Determines a list of events to be added to the -list of events that the Hook triggers for. +Name | Type | Description +-----|------|-------------- +`config`|`object` | Key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between hooks and some are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON `true`/`false` values will be converted automatically. +`events`|`array` | Determines what events the hook is triggered for. This replaces the entire array of events. Default: `["push"]` +`add_events`|`array` | Determines a list of events to be added to the list of events that the Hook triggers for. +`remove_events`|`array` | Determines a list of events to be removed from the list of events that the Hook triggers for. +`active`|`boolean` | Determines whether the hook is actually triggered on pushes. -`remove_events` -: _Optional_ **array** - Determines a list of events to be removed from the -list of events that the Hook triggers for. -`active` -: _Optional_ **boolean** - Determines whether the hook is actually -triggered on pushes. +#### Example <%= json \ - :name => "campfire", :active => true, - :config => { - :subdomain => 'github', - :room => 'Commits', - :token => 'abc123'} + :add_events => ['pull_request'] %> ### Response @@ -143,12 +99,26 @@ triggered on pushes. <%= headers 200 %> <%= json :hook %> -## Test a hook +## Test a `push` hook This will trigger the hook with the latest push to the current -repository. +repository if the hook is subscribed to `push` events. If the +hook is not subscribed to `push` events, the server will respond +with 204 but no test POST will be generated. + + POST /repos/:owner/:repo/hooks/:id/tests + +**Note**: Previously `/repos/:owner/:repo/hooks/:id/test` + +### Response - POST /repos/:user/:repo/hooks/:id/test +<%= headers 204 %> + +## Ping a hook + +This will trigger a [ping event][ping-event-url] to be sent to the hook. + + POST /repos/:owner/:repo/hooks/:id/pings ### Response @@ -156,28 +126,50 @@ repository. ## Delete a hook - DELETE /repos/:user/:repo/hooks/:id + DELETE /repos/:owner/:repo/hooks/:id ### Response <%= headers 204 %> +## Receiving Webhooks + +In order for {{ site.data.variables.product.product_name }} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +### Webhook Headers + +GitHub will send along several HTTP headers to differentiate between event types and payload identifiers. + +Name | Description +-----|-----------| +`X-GitHub-Event` | The [event type](/v3/activity/events/types/) that was triggered. +`X-GitHub-Delivery` | A [guid][guid] to identify the payload and event being sent. +`X-Hub-Signature` | The value of this header is computed as the HMAC hex digest of the body, using the `secret` config option as the key. + ## PubSubHubbub -GitHub can also serve as a [PubSubHubbub][pubsub] hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. Topic URLs for a GitHub repository's pushes are in this format: +GitHub can also serve as a [PubSubHubbub][pubsub] hub for all repositories. +PSHB is a simple publish/subscribe protocol +that lets servers register to receive updates when a topic is updated. +The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: - https://github.com/:user/:repo/events/:event + https://github.com/:owner/:repo/events/:event -The event can be any Event string that is listed at the top of this +The event can be any [event][events-url] string that is listed at the top of this document. +### Response format + The default format is what [existing post-receive hooks should expect][post-receive]: A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. Accept: application/json - https://github.com/:user/:repo/events/push.json + https://github.com/:owner/:repo/events/push.json + +### Callback URLs Callback URLs can use either the `http://` protocol, or `github://`. `github://` callbacks specify a GitHub service. @@ -188,38 +180,38 @@ Callback URLs can use either the `http://` protocol, or `github://`. # Send updates to Campfire github://campfire?subdomain=github&room=Commits&token=abc123 -The GitHub PubSubHubbub endpoint is: https://api.github.com/hub. -(GitHub Enterprise users should use http://yourhost/api/v3/hub as the +### Subscribing + +The GitHub PubSubHubbub endpoint is: `https://api.github.com/hub`. +(GitHub Enterprise users should use `http://yourhost/api/v3/hub` as the PubSubHubbub endpoint, but not change the `hub.topic` URI format.) A successful request with curl looks like: - curl -u "user" -i \ - https://api.github.com/hub \ - -F "hub.mode=subscribe" \ - -F "hub.topic=https://github.com/:user/:repo/events/push" \ - -F "hub.callback=http://postbin.org/123" +``` command-line +curl -u "user" -i \ + https://api.github.com/hub \ + -F "hub.mode=subscribe" \ + -F "hub.topic=https://github.com/:owner/:repo/events/push" \ + -F "hub.callback=http://postbin.org/123" +``` PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. -### Parameters - -`hub.mode` -: _Required_ **string** - Either `subscribe` or `unsubscribe`. +#### Parameters -`hub.topic` -: _Required_ **string** - The URI of the GitHub repository to subscribe -to. The path must be in the format of `/:user/:repo/events/:event`. +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/:owner/:repo/events/:event`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a SHA1 HMAC of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the `X-Hub-Signature` header. You can see [the PubSubHubbub documentation][pshb-secret] for more details. -`hub.callback` -: _Required_ **string** - The URI to receive the updates to the topic. -`hub.secret` -: _Optional_ **string** - A shared secret key that generates a SHA1 HMAC -of the payload content. You can verify a push came from GitHub by -comparing the received body with the contents of the `X-Hub-Signature` -header. - -[pubsub]: http://code.google.com/p/pubsubhubbub/ +[guid]: http://en.wikipedia.org/wiki/Globally_unique_identifier +[pubsub]: https://github.com/pubsubhubbub/PubSubHubbub [post-receive]: http://help.github.com/post-receive-hooks/ - +[pshb-secret]: https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify +[events-url]: /webhooks/#events +[ping-event-url]: /webhooks/#ping-event +[org-hooks]: /v3/orgs/hooks/ diff --git a/content/v3/repos/invitations.md b/content/v3/repos/invitations.md new file mode 100644 index 0000000000..50469923aa --- /dev/null +++ b/content/v3/repos/invitations.md @@ -0,0 +1,98 @@ +--- +title: Repository Invitations +--- + +# Repository Invitations + +{{#tip}} + +We're currently offering a preview of the Repository Invitations API. + +To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + +``` +application/vnd.github.swamp-thing-preview+json +``` + +{{/tip}} + +{:toc} + + + +## Invite a user to a repository + +Use the API endpoint for adding a collaborator [here](/v3/repos/collaborators). + + + +## List invitations for a repository + + GET /repositories/:repo_id/invitations + +When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:repository_invitation) { |h| [h] } %> + + + +## Delete a repository invitation + + DELETE /repositories/:repo_id/invitations/:invitation_id + +### Response + +<%= headers 204 %> + + + +## Update a repository invitation + + PATCH /repositories/:repo_id/invitations/:invitation_id + +### Input + +Name | Type | Description +-----|------|-------------- +`permissions`|`string` | The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. + +### Response + +<%= headers 200 %> +<%= json(:repository_invitation) %> + + + +## List a user's repository invitations + + GET /user/repository_invitations + +When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + +### Response + +<%= headers 200 %> +<%= json(:repository_invitation) { |h| [h] } %> + + + +## Accept a repository invitation + + PATCH /user/repository_invitations/:invitation_id + +### Response + +<%= headers 204 %> + + + +## Decline a repository invitation + + DELETE /user/repository_invitations/:invitation_id + +### Response + +<%= headers 204 %> diff --git a/content/v3/repos/keys.md b/content/v3/repos/keys.md index 429dea72fa..db2fdcc7cc 100644 --- a/content/v3/repos/keys.md +++ b/content/v3/repos/keys.md @@ -1,56 +1,70 @@ --- -title: Repo Deploy Keys | GitHub API +title: Deploy Keys --- -# Repo Deploy Keys API +# Deploy Keys -## List +{:toc} - GET /repos/:user/:repo/keys + + +## List deploy keys + + GET /repos/:owner/:repo/keys ### Response -<%= headers 200 %> -<%= json(:public_key) { |h| [h] } %> +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:deploy_key) { |h| [h] } %> -## Get + - GET /repos/:user/:repo/keys/:id +## Get a deploy key + + GET /repos/:owner/:repo/keys/:id ### Response <%= headers 200 %> -<%= json :public_key %> +<%= json :deploy_key %> -## Create + - POST /repos/:user/:repo/keys +## Add a new deploy key -### Input + POST /repos/:owner/:repo/keys -<%= json :title => "octocat@octomac", :key => "ssh-rsa AAA..." %> +### Parameters -### Response +Name | Type | Description +-----|------|------------- +`title`|`string`|A name for the key. +`key`|`string`|The contents of the key. +`read_only`|`boolean`|If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. -<%= headers 201, :Location => "https://api.github.com/user/repo/keys/1" %> -<%= json :public_key %> +#### Example -## Edit +Here's how you can create a read-only deploy key: - PATCH /repos/:user/:repo/keys/:id +<%= json :title => "octocat@octomac", :key => "ssh-rsa AAA...", :read_only => true %> -### Input +### Response -<%= json :title => "octocat@octomac", :key => "ssh-rsa AAA..." %> +<%= headers 201, :Location => get_resource(:deploy_key)['url'] %> +<%= json :deploy_key %> -### Response + -<%= headers 200 %> -<%= json :public_key %> +## Edit a deploy key + +Deploy keys are immutable. If you need to update a key, [remove the +key](#remove-a-deploy-key) and [create a new one](#add-a-new-deploy-key) instead. + + -## Delete +## Remove a deploy key - DELETE /repos/:user/:repo/keys/:id + DELETE /repos/:owner/:repo/keys/:id ### Response diff --git a/content/v3/repos/merging.md b/content/v3/repos/merging.md index 16ace4a025..ed5285c212 100644 --- a/content/v3/repos/merging.md +++ b/content/v3/repos/merging.md @@ -1,12 +1,14 @@ --- -title: Repo Merging | GitHub API +title: Merging --- -# Repo Merging API +# Merging + +{:toc} The Repo Merging API supports merging branches in a repository. This accomplishes essentially the same thing as merging one branch into another in a local repository -and then pushing to GitHub. The benefit is that the merge is done on the server side +and then pushing to {{ site.data.variables.product.product_name }}. The benefit is that the merge is done on the server side and a local repository is not needed. This makes it more appropriate for automation and other tools where maintaining local repositories would be cumbersome and inefficient. @@ -14,19 +16,16 @@ The authenticated user will be the author of any merges done through this endpoi ## Perform a merge - POST /repos/:user/:repo/merges + POST /repos/:owner/:repo/merges ### Input -base -: _Required_ **string** - The name of the base branch that the head will be merged into. - -head -: _Required_ **string** - The head to merge. This can be a branch name or a commit SHA1. +Name | Type | Description +-----|------|-------------- +`base`|`string` | **Required**. The name of the base branch that the head will be merged into. +`head`|`string` | **Required**. The head to merge. This can be a branch name or a commit SHA1. +`commit_message`|`string` | Commit message to use for the merge commit. If omitted, a default message will be used. -commit_message -: _Optional_ **string** - Commit message to use for the merge commit. -If omitted, a default message will be used. <%= json \ :base => "master", @@ -48,8 +47,12 @@ If omitted, a default message will be used. <%= headers 409 %> <%= json({ :message => "Merge Conflict" }) %> -### Missing base or head response +### Missing base response <%= headers 404 %> <%= json(:message => "Base does not exist") %> + +### Missing head response + +<%= headers 404 %> <%= json(:message => "Head does not exist") %> diff --git a/content/v3/repos/pages.md b/content/v3/repos/pages.md new file mode 100644 index 0000000000..78f8c5ba94 --- /dev/null +++ b/content/v3/repos/pages.md @@ -0,0 +1,91 @@ +--- +title: Pages +--- + +# Pages + +{:toc} + +The GitHub Pages API retrieves information about your GitHub Pages configuration, and +the statuses of your builds. Information about the site and the builds can only be +accessed by authenticated owners, even though the websites are public. + +In JSON responses, `status` can be one of: + +* `null`, which means the site has yet to be built +* `queued`, which means the build has been requested but not yet begun +* `building`, which means the build is in progress +* `built`, which means the site has been built +* `errored`, which indicates an error occurred during the build + +## Get information about a Pages site + + GET /repos/:owner/:repo/pages + +{% if page.version == 'dotcom' or page.version > 2.7 %} + +{{#tip}} + + + + Additional functionality of the GitHub Pages API is currently available for developers to preview. + During the preview period, the API may change without advance notice. + + To access the additional functionality during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.mister-fantastic-preview+json + + When the [preview flag](#preview-period) is passed, the response will contain an additional field, `html_url`, which will contain the absolute URL (with scheme) to the rendered site (e.g., `https://username.github.io`, or `http://example.com`). + +{{/tip}} + +{% endif %} + +### Response + +<%= headers 200 %> +<%= json(:pages) %> + +{% if page.version == 'dotcom' or page.version > 2.7 %} + +## Request a page build + + POST /repos/:owner/:repo/pages/builds + +{{#tip}} + + + + This endpoint is currently available for developers to preview. + During the preview period, the API may change without advance notice. + + To access this endpoint during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.mister-fantastic-preview+json + +{{/tip}} + +You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + +Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + +### Response + +<%= headers 200 %> +<%= json(:pages_request_build) %> + +{% endif %} + +## List Pages builds + + GET /repos/:owner/:repo/pages/builds + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:pages_build) { |h| [h] } %> + +## List latest Pages build + + GET /repos/:owner/:repo/pages/builds/latest + +<%= headers 200 %> +<%= json(:pages_build) %> diff --git a/content/v3/repos/pre_receive_hooks.md b/content/v3/repos/pre_receive_hooks.md new file mode 100644 index 0000000000..2eef1d9459 --- /dev/null +++ b/content/v3/repos/pre_receive_hooks.md @@ -0,0 +1,88 @@ +--- +title: Repository Pre-receive Hooks +--- + +# Repository Pre-receive Hooks (Enterprise) + +{{#tip}} + + + + APIs for managing pre-receive hooks are currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.eye-scream-preview + +{{/tip}} + + +{:toc} + +The Repository Pre-receive Hooks API allows you to view and modify +enforcement of the pre-receive hooks that are available to a repository. + +Prefix all the endpoints for this API with the following URL: + +``` command-line +http(s)://hostname/api/v3 +``` + +## Object attributes + +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this repository, it's organization +owner or global configuration. Authorization to access the endpoint at +`configuration_url` is determined at the owner or site admin level. + +## List pre-receive hooks + +List all pre-receive hooks that are enabled or testing for this +repository as well as any disabled hooks that are allowed to be enabled +at the repository level. Pre-receive hooks that are disabled at a higher +level and are not configurable will not be listed. + + GET /repos/:owner/:repo/pre-receive-hooks + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json :pre_receive_hooks_repo %> + +## Get a single pre-receive hook + + GET /repos/:owner/:repo/pre-receive-hooks/:id + +<%= headers 200 %> <%= json :pre_receive_hook_repo %> + +## Update pre-receive hook enforcement + +For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` + + PATCH /repos/:owner/:repo/pre-receive-hooks/:id + +<%= json :enforcement => "enabled" %> + +### Response + +<%= headers 200 %><%= json :pre_receive_hook_repo_update %> + +## Remove enforcement overrides for a pre-receive hook + +Deletes any overridden enforcement on this repository for the specified +hook. + + DELETE /repos/:owner/:repo/pre-receive-hooks/:id + +### Response + +Responds with effective values inherited from owner and/or global level. + +<%= headers 200 %> <%= json :pre_receive_hook_repo %> diff --git a/content/v3/repos/releases.md b/content/v3/repos/releases.md new file mode 100644 index 0000000000..73a2e10891 --- /dev/null +++ b/content/v3/repos/releases.md @@ -0,0 +1,242 @@ +--- +title: Releases +--- + +# Releases + +{:toc} + +## List releases for a repository + +{{#tip}} + +This returns a list of releases, which does not include regular +Git tags that have not been associated with a release. +To get a list of Git tags, use the [Repository Tags API][repo tags api]. + +{{/tip}} + +Information about published releases are available to everyone. +Only users with push access will receive listings for draft releases. + + GET /repos/:owner/:repo/releases + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:release) { |h| [h] } %> + +## Get a single release + + GET /repos/:owner/:repo/releases/:id + +### Response + +{{#tip}} + + + +**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia). + +{{/tip}} + +<%= headers 200 %> +<%= json :release %> + +## Get the latest release + +View the latest published full release for the repository. Draft releases and prereleases are not returned by this endpoint. + + GET /repos/:owner/:repo/releases/latest + +### Response + +<%= headers 200 %> +<%= json :release %> + +## Get a release by tag name + +Get a published release with the specified tag. + + GET /repos/:owner/:repo/releases/tags/:tag + +### Response + +<%= headers 200 %> +<%= json :release %> + + +## Create a release + +Users with push access to the repository can create a release. + + POST /repos/:owner/:repo/releases + +### Input + +Name | Type | Description +-----|------|-------------- +`tag_name`|`string` | **Required**. The name of the tag. +`target_commitish`|`string` | Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). +`name`|`string` | The name of the release. +`body`|`string` | Text describing the contents of the tag. +`draft`|`boolean` | `true` to create a draft (unpublished) release, `false` to create a published one. Default: `false` +`prerelease`|`boolean` | `true` to identify the release as a prerelease. `false` to identify the release as a full release. Default: `false` + +#### Example + +<%= json \ + :tag_name => "v1.0.0", + :target_commitish => "master", + :name => "v1.0.0", + :body => "Description of the release", + :draft => false, + :prerelease => false +%> + +### Response + +<%= headers 201, :Location => get_resource(:created_release)['url'] %> +<%= json(:created_release) %> + +## Edit a release + +Users with push access to the repository can edit a release. + + PATCH /repos/:owner/:repo/releases/:id + +### Input + +Name | Type | Description +-----|------|-------------- +`tag_name`|`string` | The name of the tag. +`target_commitish`|`string` | Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). +`name`|`string` | The name of the release. +`body`|`string` | Text describing the contents of the tag. +`draft`|`boolean` | `true` makes the release a draft, and `false` publishes the release. +`prerelease`|`boolean` | `true` to identify the release as a prerelease, `false` to identify the release as a full release. + +#### Example + +<%= json \ + :tag_name => "v1.0.0", + :target_commitish => "master", + :name => "v1.0.0", + :body => "Description of the release", + :draft => false, + :prerelease => false +%> + +### Response + +<%= headers 200 %> +<%= json :release %> + +## Delete a release + +Users with push access to the repository can delete a release. + + DELETE /repos/:owner/:repo/releases/:id + +### Response + +<%= headers 204 %> + +## List assets for a release + + GET /repos/:owner/:repo/releases/:id/assets + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:release_asset) { |h| [h] } %> + +## Upload a release asset + +This endpoint makes use of [a Hypermedia relation](/v3/#hypermedia) to determine which URL to access. +This endpoint is provided by a URI template in [the release's API response](#get-a-single-release). +{% if page.version == 'dotcom' %}You need to use an HTTP client which supports +SNI to make calls to this endpoint.{% endif %} + +The asset data is expected in its raw binary form, rather than JSON. +Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset. + + POST https://
For example, if your Continuous Integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
`http://ci.example.com/user/repo/build/sha`. +`description`|`string` | A short description of the status. +`context`|`string` | A string label to differentiate this status from the status of other systems. Default: `"default"` + +#### Example + +<%= json \ + :state => "success", + :target_url => "https://example.com/build/status", + :description => "The build succeeded!", + :context => "continuous-integration/jenkins" +%> + +### Response + +<%= headers 201, :Location => get_resource(:status)['url'] %> +<%= json :status %> + +## List Statuses for a specific Ref + +Users with pull access can view commit statuses for a given ref: + + GET /repos/:owner/:repo/commits/:ref/statuses + +{{#tip}} + +This resource is also available via a legacy route: +`GET /repos/:owner/:repo/statuses/:ref`. + +{{/tip}} + +Statuses are returned in reverse chronological order. The first status in the +list will be the latest one. + +### Parameters + +Name | Type | Description +-----|------|-------------- +`ref`|`string` | **Required**. Ref to list the statuses from. It can be a SHA, a branch name, or a tag name. + + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:status) { |h| [h] } %> + +## Get the combined Status for a specific Ref + +Users with pull access can access a combined view of commit statuses for a given ref. + + GET /repos/:owner/:repo/commits/:ref/status + +The most recent status for each context is returned, up to 100. This field +[paginates](/v3/#pagination) if there are over 100 contexts. + +Additionally, a combined `state` is returned. The `state` is one of: + + * **failure** if any of the contexts report as error or failure + * **pending** if there are no statuses or a context is pending + * **success** if the latest status for all contexts is success + +### Parameters + +Name | Type | Description +-----|------|-------------- +`ref`|`string` | **Required**. Ref to fetch the status for. It can be a SHA, a branch name, or a tag name. + +### Response +<%= headers 200 %> +<%= json(:combined_status) %> diff --git a/content/v3/repos/traffic.md b/content/v3/repos/traffic.md new file mode 100644 index 0000000000..483197db77 --- /dev/null +++ b/content/v3/repos/traffic.md @@ -0,0 +1,79 @@ +--- +title: Traffic +--- + +# Traffic +{{#tip}} + + + + APIs for repository traffic are currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-08-15-traffic-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.spiderman-preview + +{{/tip}} + +{:toc} + +For repositories that you have push access to, the traffic API provides access +to the information provided in the [graphs section](https://help.github.com/articles/about-repository-graphs/#traffic). + + + +## List referrers + +Get the top 10 referrers over the last 14 days. + + GET /repos/:owner/:repo/traffic/popular/referrers + +### Response + +<%= headers 200 %> +<%= json(:traffic_referrers) %> + +## List paths + +Get the top 10 popular contents over the last 14 days. + + GET /repos/:owner/:repo/traffic/popular/paths + +### Response + +<%= headers 200%> +<%= json(:traffic_contents) %> + +## Views + +Get the total number of views and breakdown per day or week for the last 14 days. + + GET /repos/:owner/:repo/traffic/views + +### Parameters +Name | Type | Description +-----|------|-------------- +`per`|string|Must be one of: `day`, `week`. Default: `day` + + +### Response +<%= headers 200 %> +<%= json(:traffic_views) %> + +## Clones + +Get the total number of clones and breakdown per day or week for the last 14 days. + + GET /repos/:owner/:repo/traffic/clones + +### Parameters +Name | Type | Description +-----|------|-------------- +`per`|string|Must be one of: `day`, `week`. Default: `day` + +### Response + +<%= headers 200 %> +<%= json(:traffic_clones) %> diff --git a/content/v3/repos/watching.md b/content/v3/repos/watching.md deleted file mode 100644 index f2826b7970..0000000000 --- a/content/v3/repos/watching.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Repo Watching | GitHub API ---- - -# Repo Watching API - -We recently [changed the way watching -works](https://github.com/blog/1204-notifications-stars) on GitHub. We hope to -roll out many of these features in the API soon. Until then, the [Watchers -method](#list-watchers) below will return "stargazers", and the [Watched -methods](#list-repos-being-watched) return repositories that have been -"starred." - -## List watchers - - GET /repos/:user/:repo/watchers - -### Response - -<%= headers 200, :pagination => true %> -<%= json(:user) { |h| [h] } %> - -## List repos being watched - -List repos being watched by a user - - GET /users/:user/watched - -List repos being watched by the authenticated user - - GET /user/watched - -### Response - -<%= headers 200, :pagination => true %> -<%= json(:repo) { |h| [h] } %> - -## Check if you are watching a repo - -Requires for the user to be authenticated - - GET /user/watched/:user/:repo - -### Response if this repo is watched by you - -<%= headers 204 %> - -### Response if this repo is not watched by you - -<%= headers 404 %> - -## Watch a repo - -Requires for the user to be authenticated - - PUT /user/watched/:user/:repo - -### Response - -<%= headers 204 %> - -## Stop watching a repo - -Requires for the user to be authenticated - - DELETE /user/watched/:user/:repo - -### Response - -<%= headers 204 %> diff --git a/content/v3/search.md b/content/v3/search.md index 9cfd8f1bba..bfdefdd175 100644 --- a/content/v3/search.md +++ b/content/v3/search.md @@ -1,76 +1,442 @@ --- -title: Search | GitHub API +title: Search --- # Search -This is a listing of the Search API features from API v2 that have been ported to API -v3. There should be no changes, other than the new URL and JSON output format. +{:toc} -## Search issues +### About the Search API -Find issues by state and keyword. +The Search API is optimized to help you find the specific item you're looking +for (e.g., a specific user, a specific file in a repository, etc.). Think of it +the way you think of performing a search on Google. It's designed to help you +find the one result you're looking for (or maybe the few results you're looking +for). Just like searching on Google, you sometimes want to see a few pages of +search results so that you can find the item that best meets your needs. To +satisfy that need, the {{ site.data.variables.product.product_name }} Search API provides **up to 1,000 results for each +search**. - GET /legacy/issues/search/:owner/:repository/:state/:keyword +### Ranking search results -### Parameters +Unless another sort option is provided as a query parameter, results are sorted +by best match, as indicated by the `score` field for each item returned. This +is a computed value representing the relevance of an item relative to the other +items in the result set. Multiple factors are combined to boost the most +relevant item to the top of the result list. + +{% if page.version == 'dotcom' %} + +### Rate limit + +The Search API has a custom rate limit. For requests using [Basic +Authentication](/v3/#authentication), [OAuth](/v3/#authentication), or [client +ID and secret](/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. + +See the [rate limit documentation](/v3/#rate-limiting) for details on +determining your current rate limit status. -state -: `open` or `closed` +{% endif %} -keyword -: Search term +### Timeouts and incomplete results -<%= headers 200 %> -<%= json(:issue_search_results) %> +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. + +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. ## Search repositories -Find repositories by keyword. Note, this legacy method does not follow the -v3 pagination pattern. This method returns up to 100 results per page and -pages can be fetched using the `start_page` parameter. +Find repositories via various criteria. This method returns up to 100 results [per page](/v3/#pagination). - GET /legacy/repos/search/:keyword + GET /search/repositories ### Parameters -keyword -: Search term +Name | Type | Description +-----|------|-------------- +`q`|`string`| The search keywords, as well as any qualifiers. +`sort`|`string`| The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. +`order`|`string`| The sort order if `sort` parameter is provided. One of `asc` or `desc`. Default: `desc` -language -: _Optional_ Filter results by [language](https://github.com/languages) +The `q` search term can also contain any combination of the supported repository search qualifiers as described by the in-browser [repository search documentation](https://help.github.com/articles/searching-repositories/) and [search syntax documentation](https://help.github.com/articles/search-syntax/): -start_page -: _Optional_ Page number to fetch +* [`in`](https://help.github.com/articles/searching-repositories#scope-the-search-fields) + Qualifies which fields are searched. With this qualifier you can restrict the + search to just the repository name, description, readme, or + any combination of these. +* [`size`](https://help.github.com/articles/searching-repositories#search-based-on-the-size-of-a-repository) + Finds repositories that match a certain size (in kilobytes). +* [`forks`](https://help.github.com/articles/searching-repositories#search-based-on-the-number-of-forks-the-parent-repository-has) + Filters repositories based on the number of forks. +* [`fork`](https://help.github.com/articles/searching-repositories#search-based-on-the-number-of-forks-the-parent-repository-has) Filters whether forked repositories should be included (`true`) or only forked repositories should be returned (`only`). +* [`created` or `pushed`](https://help.github.com/articles/searching-repositories#search-based-on-when-a-repository-was-created-or-last-updated) + Filters repositories based on date of creation, or when they were last updated. +* [`user` or `repo`](https://help.github.com/articles/searching-repositories#search-within-a-users-or-organizations-repositories) + Limits searches to a specific user or repository. +* [`language`](https://help.github.com/articles/searching-repositories#search-based-on-the-main-language-of-a-repository) + Searches repositories based on the language they're written in. +* [`stars`](https://help.github.com/articles/searching-repositories#search-based-on-the-number-of-stars-a-repository-has) + Searches repositories based on the number of stars. -<%= headers 200 %> -<%= json(:repo_search_results) %> +
Example
-## Search users +Suppose you want to search for popular Tetris repositories written in Assembly. +Your query might look like this. + + https://api.github.com/search/repositories?q=tetris+language:assembly&sort=stars&order=desc + +In this request, we're searching for repositories with the word `tetris` in the +name, the description, or the README. We're limiting the results to only find +repositories where the primary language is Assembly. We're sorting by stars in +descending order, so that the most popular repositories appear first in the +search results. + +<%= headers 200, {:pagination => default_pagination_rels{% if page.version == 'dotcom' %}, 'X-RateLimit-Limit' => 20, 'X-RateLimit-Remaining' => 19{% endif %}} %> +<%= json(:repo_search_v3_results) %> + +### Highlighting Repository Search Results + +Some API consumers will want to highlight the matching search terms when +displaying search results. The API offers additional metadata to support this +use case. To get this metadata in your search results, specify the `text-match` +media type in your Accept header. For example, via curl, the above query would +look like this: + +``` command-line +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ + 'https://api.github.com/search/repositories?q=tetris+language:assembly&sort=stars&order=desc' +``` + +This produces the same JSON payload as above, with an extra key called +`text_matches`, an array of objects. These objects provide information such as +the position of your search terms within the text, as well as the property that +included the search term. + +When searching for repositories, you can get text match metadata for the +**name** and **description** fields. (See the section on [text match metadata +](#text-match-metadata) for full details.) + +Here's an example response: + +<%= json(:repo_search_v3_results_highlighting) %> + +## Search code + +Find file contents via various criteria. (This method returns up to 100 results [per page](/v3/#pagination).) + + GET /search/code + +### Considerations for code search -Find users by keyword. +Due to the complexity of searching code, there are a few restrictions on how searches are performed: - GET /legacy/user/search/:keyword +-
+
- Only the default branch is considered. In most cases, this will be the
masterbranch.
+ - Only files smaller than {% if page.version != 'dotcom' and page.version >= 2.2 %} 10 MB {% else %} 384 KB {% endif %} are searchable. +{% if page.version == 'dotcom' %} +
- You must always include at least one search term when searching source code. For example, searching for
language:gois not valid, whileamazing language:gois.
+{% endif %}
+
Example
- GET /legacy/user/email/:email +Suppose you want to find the definition of the `addClass` function inside +[jQuery](https://github.com/jquery/jquery). Your query would look something like +this: + + https://api.github.com/search/code?q=addClass+in:file+language:js+repo:jquery/jquery + +Here, we're searching for the keyword `addClass` within a file's contents. We're +making sure that we're only looking in files where the language is JavaScript. +And we're scoping the search to the `repo:jquery/jquery` repository. + +<%= headers 200, {:pagination => default_pagination_rels,{% if page.version == 'dotcom' %} 'X-RateLimit-Limit' => 20, 'X-RateLimit-Remaining' => 19{% endif %}} %> +<%= json(:code_search_v3_results) %> + +### Highlighting Code Search Results + +Some API consumers will want to highlight the matching search terms when +displaying search results. The API offers additional metadata to support this +use case. To get this metadata in your search results, specify the `text-match` +media type in your Accept header. For example, via curl, the above query would +look like this: + +``` command-line +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ + https://api.github.com/search/code?q=addClass+in:file+language:js+repo:jquery/jquery +``` + +This produces the same JSON payload as above, with an extra key called +`text_matches`, an array of objects. These objects provide information such as +the position of your search terms within the text, as well as the property that +included the search term. + +When searching for code, you can get text match metadata for the file +**content** and file **path** fields. (See the section on +[text match metadata](#text-match-metadata) for full details.) + +Here's an example response: + +<%= json(:code_search_v3_results_highlighting) %> + +## Search issues + +Find issues by state and keyword. (This method returns up to 100 results [per page](/v3/#pagination).) + + GET /search/issues ### Parameters -email -: Email address +Name | Type | Description +-----|------|-------------- +`q`|`string`| The search terms. +`sort`|`string`| The sort field. Can be `comments`, `created`, or `updated`. Default: results are sorted by best match. +`order`|`string`| The sort order if `sort` parameter is provided. One of `asc` or `desc`. Default: `desc` + +The `q` search term can also contain any combination of the supported issue search qualifiers as described by the in-browser [issue search documentation](https://help.github.com/articles/searching-issues/) and [search syntax documentation](https://help.github.com/articles/search-syntax/): + + * [`type`](https://help.github.com/articles/searching-issues#search-issues-or-pull-requests) + With this qualifier you can restrict the search to issues (`issue`) or pull request (`pr`) only. + * [`in`](https://help.github.com/articles/searching-issues#scope-the-search-fields) + Qualifies which fields are searched. With this qualifier you can restrict the + search to just the title (`title`), body (`body`), comments (`comments`), or any combination of these. + * [`author`](https://help.github.com/articles/searching-issues#search-by-the-author-of-an-issue-or-pull-request) + Finds issues or pull requests created by a certain user. + * [`assignee`](https://help.github.com/articles/searching-issues#search-by-the-assignee-of-an-issue-or-pull-request) + Finds issues or pull requests that are assigned to a certain user. + * [`mentions`](https://help.github.com/articles/searching-issues#search-by-a-mentioned-user-within-an-issue-or-pull-request) + Finds issues or pull requests that mention a certain user. + * [`commenter`](https://help.github.com/articles/searching-issues#search-by-a-commenter-within-an-issue-or-pull-request) + Finds issues or pull requests that a certain user commented on. + * [`involves`](https://help.github.com/articles/searching-issues#search-by-a-user-thats-involved-within-an-issue-or-pull-request) + Finds issues or pull requests that were either created by a certain user, assigned to that + user, mention that user, or were commented on by that user. + * [`team`](https://help.github.com/articles/searching-issues/#search-by-a-team-thats-mentioned-within-an-issue-or-pull-request) + For organizations you're a member of, finds issues or pull requests that @mention a team within the organization. + * [`state`](https://help.github.com/articles/searching-issues#search-based-on-whether-an-issue-or-pull-request-is-open) + Filter issues or pull requests based on whether they're open or closed. + * [`labels`](https://help.github.com/articles/searching-issues#search-by-the-labels-on-an-issue) + Filters issues or pull requests based on their labels. + * [`no`](https://help.github.com/articles/searching-issues#search-by-missing-metadata-on-an-issue-or-pull-request) + Filters items missing certain metadata, such as `label`, `milestone`, or `assignee` + * [`language`](https://help.github.com/articles/searching-issues#search-by-the-main-language-of-a-repository) + Searches for issues or pull requests within repositories that match a certain language. + * [`is`](https://help.github.com/articles/searching-issues#search-based-on-the-state-of-an-issue-or-pull-request) + Searches for items within repositories that match a certain state, such as `open`, `closed`, or `merged` + * [`created` or `updated`](https://help.github.com/articles/searching-issues#search-based-on-when-an-issue-or-pull-request-was-created-or-last-updated) + Filters issues or pull requests based on date of creation, or when they were last updated. + * [`merged`](https://help.github.com/articles/searching-issues#search-based-on-when-a-pull-request-was-merged) + Filters pull requests based on the date when they were merged. + * [`status`](https://help.github.com/articles/searching-issues#search-based-on-commit-status) + Filters pull requests based on the commit status. + * [`head` or `base`](https://help.github.com/articles/searching-issues#search-based-on-branch-names) + Filters pull requests based on the branch that they came from or that they are modifying. + * [`closed`](https://help.github.com/articles/searching-issues#search-based-on-when-an-issue-or-pull-request-was-closed) + Filters issues or pull requests based on the date when they were closed. + * [`comments`](https://help.github.com/articles/searching-issues#search-by-the-number-of-comments-an-issue-or-pull-request-has) + Filters issues or pull requests based on the quantity of comments. + * [`user` or `repo`](https://help.github.com/articles/searching-issues#search-within-a-users-or-organizations-repositories) + Limits searches to a specific user or repository. + + +If you know the specific SHA hash of a commit, you can use also [use it to search for pull requests](https://help.github.com/articles/searching-issues#search-by-the-commit-shas-within-a-pull-request) that contain that SHA. Note that the SHA syntax must be at least seven characters. + +Example
+ +Let's say you want to find the oldest unresolved Python bugs on Windows. Your +query might look something like this. + + https://api.github.com/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc + +In this query, we're searching for the keyword `windows`, within any open issue +that's labeled as `bug`. The search runs across repositories whose primary +language is Python. We’re sorting by creation date in ascending order, so that +the oldest issues appear first in the search results. + +<%= headers 200, {:pagination => default_pagination_rels,{% if page.version == 'dotcom' %} 'X-RateLimit-Limit' => 20, 'X-RateLimit-Remaining' => 19{% endif %}} %> +<%= json(:issue_search_v3_results) %> + +### Highlighting Issue Search Results + +Some API consumers will want to highlight the matching search terms when +displaying search results. The API offers additional metadata to support this +use case. To get this metadata in your search results, specify the `text-match` +media type in your Accept header. For example, via curl, the above query would +look like this: + +``` command-line +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ + 'https://api.github.com/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' +``` + +This produces the same JSON payload as above, with an extra key called +`text_matches`, an array of objects. These objects provide information such as +the position of your search terms within the text, as well as the property that +included the search term. + +When searching for issues, you can get text match metadata for the issue +**title**, issue **body**, and issue **comment body** fields. (See the section +on [text match metadata ](#text-match-metadata) for full details.) + +Here's an example response: + +<%= json(:issue_search_v3_results_highlighting) %> + +## Search users + +Find users via various criteria. (This method returns up to 100 results [per page](/v3/#pagination).) + + GET /search/users + +### Parameters + +Name | Type | Description +-----|------|-------------- +`q`|`string`| The search terms. +`sort`|`string`| The sort field. Can be `followers`, `repositories`, or `joined`. Default: results are sorted by best match. +`order`|`string`| The sort order if `sort` parameter is provided. One of `asc` or `desc`. Default: `desc` + +The `q` search term can also contain any combination of the supported user search qualifiers as described by the in-browser [user search documentation](https://help.github.com/articles/searching-users/) and [search syntax documentation](https://help.github.com/articles/search-syntax/): + + * [`type`](https://help.github.com/articles/searching-users#search-for-users-or-organizations) + With this qualifier you can restrict the search to just personal accounts (`user`) or + just organization accounts (`org`). + * [`in`](https://help.github.com/articles/searching-users#scope-the-search-fields) + Qualifies which fields are searched. With this qualifier you can restrict + the search to just the username (`login`), public email (`email`), full name (`fullname`), or any + combination of these. + * [`repos`](https://help.github.com/articles/searching-users#search-based-on-the-number-of-repositories-a-user-has) + Filters users based on the number of repositories they have. + * [`location`](https://help.github.com/articles/searching-users#search-based-on-the-location-where-a-user-resides) + Filter users by the location indicated in their profile. + * [`language`](https://help.github.com/articles/searching-users#search-based-on-the-languages-of-a-users-repositories) + Search for users that have repositories that match a certain language. + * [`created`](https://help.github.com/articles/searching-users#search-based-on-when-a-user-joined-github) + Filter users based on when they joined. + * [`followers`](https://help.github.com/articles/searching-users#search-based-on-the-number-of-followers-a-user-has) + Filter users based on the number of followers they have. + +Example
+ +Imagine you're looking for a list of popular users. You might try out this query: + + https://api.github.com/search/users?q=tom+repos:%3E42+followers:%3E1000 + +Here, we're looking at users with the name Tom. We're only interested in those +with more than 42 repositories, and only if they have over 1,000 followers. + +<%= headers 200, {:pagination => default_pagination_rels,{% if page.version == 'dotcom' %} 'X-RateLimit-Limit' => 20, 'X-RateLimit-Remaining' => 19{% endif %}} %> +<%= json(:user_search_v3_results) %> + +### Highlighting User Search Results + +Some API consumers will want to highlight the matching search terms when +displaying search results. The API offers additional metadata to support this +use case. To get this metadata in your search results, specify the `text-match` +media type in your Accept header. For example, via curl, the above query would +look like this: + +``` command-line +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ + https://api.github.com/search/users?q=tom+repos:%3E42+followers:%3E1000 +``` + +This produces the same JSON payload as above, with an extra key called +`text_matches`, an array of objects. These objects provide information such as +the position of your search terms within the text, as well as the property that +included the search term. + +When searching for users, you can get text match metadata for the issue +**login**, **email**, and **name** fields. (See the section on [text match +metadata](#text-match-metadata) for full details.) + +<%= json(:user_search_v3_results_highlighting) %> + +## Text match metadata + +On github.com, we enjoy the context provided by code snippets and highlights in +search results. + +[](https://f.cloud.github.com/assets/865/819651/959a4826-efb5-11e2-8af8-46c4a3857cdf.png) + +API consumers have access to that information as well. Requests can opt to +receive those text fragments in the response, and every fragment is accompanied +by numeric offsets identifying the exact location of each matching search term. + +To get this metadata in your search results, specify the `text-match` media type +in your Accept header. + + application/vnd.github.v3.text-match+json + +The results will provide the same JSON payloads as shown above, with an extra +key called `text_matches`. Inside the `text_matches` array, each object includes +the following attributes: + + +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) + +### Example + +Using curl, and the [example issue search](#issue-search-example) above, our API +request would look like this: + +``` command-line +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ + 'https://api.github.com/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' +``` + +The response will include a `text_matches` array for each search result. In the +JSON below, we have two objects in the `text_matches` array. + +The first text match occurred in the `body` property of the issue. We see a +fragment of text from the issue body. The search term (`windows`) appears twice +within that fragment, and we have the indices for each occurrence. + +The second text match occurred in the `body` property of one of the issue's +comments. We have the URL for the issue comment. And of course, we see a +fragment of text from the comment body. The search term (`windows`) appears once +within that fragment. -<%= headers 200 %> -<%= json(:email_search_results) %> +<%= json(:issue_search_v3_results_highlighting) %> diff --git a/content/v3/search/legacy.md b/content/v3/search/legacy.md new file mode 100644 index 0000000000..bcae61c3ff --- /dev/null +++ b/content/v3/search/legacy.md @@ -0,0 +1,97 @@ +--- +title: Legacy Search +--- + +# Legacy Search + +{:toc} + +This is a listing of the Legacy Search API features from API v2 that have been ported to API +v3. There should be no changes, other than the new URL and JSON output format. + +### Legacy Search API is Deprecated + +{{#warning}} + +The Legacy Search API (described below) is deprecated and is scheduled for removal in the next major version of the API. + +We recommend using the v3 Search API instead. It contains new endpoints and much more functionality. + +{{/warning}} + +## Search issues + +Find issues by state and keyword. + + GET /legacy/issues/search/:owner/:repository/:state/:keyword + +### Parameters + +Name | Type | Description +-----|------|-------------- +`state`|`string` | Indicates the state of the issues to return. Can be either `open` or `closed`. +`keyword`|`string`| The search term. + + +<%= headers 200 %> +<%= json(:issue_search_results) %> + +## Search repositories + +Find repositories by keyword. Note, this legacy method does not follow the +v3 pagination pattern. This method returns up to 100 results per page and +pages can be fetched using the `start_page` parameter. + + GET /legacy/repos/search/:keyword + +### Parameters + +Name | Type | Description +-----|------|-------------- +`keyword`|`string`| The search term| +`language`|`string` | Filter results by language +`start_page`|`string` | The page number to fetch +`sort`|`string` | The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. +`order`|`string` | The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + + +<%= headers 200 %> +<%= json(:repo_search_results) %> + +## Search users + +Find users by keyword. + + GET /legacy/user/search/:keyword + +### Parameters + +Name | Type | Description +-----|------|-------------- +`keyword`|`string`| The search term +`start_page`|`string` | The page number to fetch +`sort`|`string`| The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. +`order`|`string`| The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + + +<%= headers 200 %> +<%= json(:user_search_results) %> + +## Email search + +This API call is added for compatibility reasons only. There's no guarantee +that full email searches will always be available. The `@` character in the +address must be left unencoded. Searches only against public email addresses +(as configured on the user's {{ site.data.variables.product.product_name }} profile). + + GET /legacy/user/email/:email + +### Parameters + +Name | Type | Description +-----|------|-------------- +`email`|`string`| The email address + + +<%= headers 200 %> +<%= json(:email_search_results) %> diff --git a/content/v3/troubleshooting.md b/content/v3/troubleshooting.md new file mode 100644 index 0000000000..09a0d04864 --- /dev/null +++ b/content/v3/troubleshooting.md @@ -0,0 +1,48 @@ +--- +title: Troubleshooting +--- + +# Troubleshooting + +{:toc} + +If you're encountering some oddities in the API, here's a list of resolutions to +some of the problems you may be experiencing. + +## Why am I getting a `404` error on a repository that exists? + +Typically, we send a `404` error when your client isn't properly authenticated. +You might expect to see a `403 Forbidden` in these cases. However, since we don't +want to provide _any_ information about private repositories, the API returns a +`404` error instead. + +To troubleshoot, ensure [you're authenticating correctly](/guides/getting-started/), [your OAuth access token has the required scopes](/v3/oauth/#scopes), and [third-party application restrictions][oap-guide] are not blocking access. + +## Why am I not seeing all my results? + +Most API calls accessing a list of resources (_e.g._, users, issues, _etc._) support +pagination. If you're making requests and receiving an incomplete set of results, you're +probably only seeing the first page. You'll need to request the remaining pages +in order to get more results. + +It's important to *not* try and guess the format of the pagination URL. Not every +API call uses the same structure. Instead, extract the pagination information from +[the Link Header](/v3/#pagination), which is sent with every request. + +{% if page.version == 'dotcom' %} + +## Can I get my rate limits bumped? + +The {{ site.data.variables.product.product_name }} API has a pretty lenient quota for rate limits, for your enjoyment and +our safety. You can read more about it [here](/v3/#rate-limiting). + +If you're using OAuth or Basic Authentication and are hitting your rate limits, +you might be able to fix the issue by either caching our results, or [using conditional requests](/v3/#conditional-requests). + +In certain exceptional cases, we may temporarily bump your rate limit higher. You +should be prepared to answer technical questions about your goal and your planned usage of the API. We may still choose not to bump your limit if we feel that you can achieve your wildest +dreams with the current rate limit (but don't worry, we'll help you out). + +{% endif %} + +[oap-guide]: /changes/2015-01-19-an-integrators-guide-to-organization-application-policies/ diff --git a/content/v3/users.md b/content/v3/users.md index b111d651af..11e5479a4c 100644 --- a/content/v3/users.md +++ b/content/v3/users.md @@ -1,21 +1,26 @@ --- -title: Users | GitHub API +title: Users --- -# Users API +# Users + +{:toc} Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL -does not include a `:user` parameter then the response will be for the +does not include a `:username` parameter then the response will be for the logged in user (and you must pass [authentication information](/v3/#authentication) with your request). ## Get a single user - GET /users/:user + GET /users/:username ### Response +Note: The returned email is the user's publicly visible email address +(or `null` if the user has not [specified a public email address in their profile](https://github.com/settings/profile)). + <%= headers 200 %> <%= json :full_user %> @@ -32,28 +37,19 @@ information](/v3/#authentication) with your request). PATCH /user -### Input - -name -: _Optional_ **string** - -email -: _Optional_ **string** - Publicly visible email address. +### Parameters -blog -: _Optional_ **string** +Name | Type | Description +-----|------|-------------- +`name`|`string` | The new name of the user +`email`|`string` | Publicly visible email address. +`blog`|`string` | The new blog URL of the user. +`company`|`string` | The new company of the user. +`location`|`string` | The new location of the user. +`hireable`|`boolean` | The new hiring availability of the user. +`bio`|`string` | The new short biography of the user. -company -: _Optional_ **string** - -location -: _Optional_ **string** - -hireable -: _Optional_ **boolean** - -bio -: _Optional_ **string** +#### Example <%= json \ :name => "monalisa octocat", @@ -70,3 +66,24 @@ bio <%= headers 200 %> <%= json :private_user %> +## Get all users + +Lists all users, in the order that they signed up on {{ site.data.variables.product.product_name }}. This list includes personal user accounts and organization accounts. + +Note: Pagination is powered exclusively by the `since` parameter. +Use the [Link header](/v3/#link-header) to get the URL for the next page of +users. + + GET /users + +### Parameters + +Name | Type | Description +-----|------|-------------- +`since`|`string`| The integer ID of the last User that you've seen. + + +### Response + +<%= headers 200, :pagination => { :next => 'https://api.github.com/users?since=135' } %> +<%= json(:user) { |h| [h] } %> diff --git a/content/v3/users/administration.md b/content/v3/users/administration.md new file mode 100644 index 0000000000..f918e2f38c --- /dev/null +++ b/content/v3/users/administration.md @@ -0,0 +1,199 @@ +--- +title: User Administration +--- + +# Administration (Enterprise) + +{:toc} + +The User Administration API allows you to promote, demote, suspend, and unsuspend users on a GitHub Enterprise appliance. *It is only available to [authenticated](/v3/#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. + +Prefix all the endpoints for this API with the following URL: + +``` command-line +http(s)://hostname/api/v3 +``` + +{% if page.version != 'dotcom' and page.version >= 2.3 %} + +## Create a new user + +{{#warning}} + +If an external authentication mechanism is used, the login name should match the +login name in the external system. If you are using LDAP authentication, you should also +[update the LDAP mapping](/v3/enterprise/ldap/#update-ldap-mapping-for-a-user) +for the user. + +{{/warning}} + + POST /admin/users + +### Parameters + +Name | Type | Description +-----|------|-------------- +`login`|`string` | **Required.** The user's username. +`email`|`string` | **Required.** The user's email address. + +The login name will be normalized to only contain alphanumeric characters or +single hyphens. For example, if you send `"octo_cat"` as the login, a user named +`"octo-cat"` will be created. + +If the login name or email address is already associated with an account, the server will return a `422` response. + +#### Example + +<%= json \ + :login => "monalisa", + :email => "octocat@github.com" +%> + +### Response + +<%= headers 201 %> +<%= json :user %> + +## Rename an existing user + + PATCH /admin/users/:username + +### Parameters + +Name | Type | Description +-----|------|-------------- +`login`|`string` | **Required.** The user's new username. + +#### Example + +<%= json \ + :login => "thenewmonalisa" +%> + +### Response + +<%= headers 202 %> +<%= json \ + :message => "Job queued to rename user. It may take a few minutes to complete.", + :url => "https://api.github.com/user/1" +%> + +## Create an impersonation OAuth token + + POST /admin/users/:username/authorizations + +### Parameters + +Name | Type | Description +---- | ---- | ------------- +`scopes`|`array` | A list of [scopes](/v3/oauth/#scopes). + +### Response + +<%= headers 201 %> +<%= json(:oauth_access) %> + +## Delete an impersonation OAuth token + + DELETE /admin/users/:username/authorizations + +### Response + +<%= headers 204 %> + +{% endif %} + +## Promote an ordinary user to a site administrator + + PUT /users/:username/site_admin + +<%= fetch_content(:put_content_length) %> + +### Response + +<%= headers 204 %> + +## Demote a site administrator to an ordinary user + + DELETE /users/:username/site_admin + +You can demote any user account except your own. + +### Response + +<%= headers 204 %> + +## Suspend a user + +{{#warning}} + +If your GitHub Enterprise appliance has [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Users managed by an external account cannot be suspended via the API. + +{{/warning}} + + PUT /users/:username/suspended + +You can suspend any user account except your own. + +<%= fetch_content(:put_content_length) %> + +### Response + +<%= headers 204 %> + +## Unsuspend a user + +{{#warning}} + +If your GitHub Enterprise appliance has [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Users managed by an external account cannot be unsuspended via the API. + +{{/warning}} + + DELETE /users/:username/suspended + +### Response + +<%= headers 204 %> + +{% if page.version != 'dotcom' and page.version >= 2.3 %} + +## List all public keys + + GET /admin/keys + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:all_keys) { |public_key, deploy_key| \ + [public_key, deploy_key.merge("id" => "2", "url" => "https://api.github.com/repos/octocat/Hello-World/keys/2")] \ +} %> + +{% if page.version != 'dotcom' and page.version >= 2.4 %} + +## Delete a user + +{{#warning}} + +Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](/v3/users/administration/#suspend-a-user) is often a better option. + +{{/warning}} + + DELETE /admin/users/:username + +You can delete any user account except your own. + +### Response + +<%= headers 204 %> + +{% endif %} + +## Delete a public key + + DELETE /admin/keys/1 + +### Response + +<%= headers 204 %> + +{% endif %} diff --git a/content/v3/users/emails.md b/content/v3/users/emails.md index 7015dc1ea1..0de8cb90b6 100644 --- a/content/v3/users/emails.md +++ b/content/v3/users/emails.md @@ -1,23 +1,37 @@ --- -title: User Emails | GitHub API +title: User Emails --- -# User Emails API +# Emails + +{:toc} Management of email addresses via the API requires that you are -authenticated. +authenticated through basic auth or OAuth with the user scope. ## List email addresses for a user GET /user/emails +This endpoint is accessible with the user:email scope. + ### Response -<%= headers 200 %> -<%= json ["octocat@github.com", "support@github.com"] %> +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:user_email) {|e| [e]} %> ## Add email address(es) +{% if page.version != 'dotcom' && page.version >= 2.1 %} + +{{#warning}} + +If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize emails enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add an email address via the API with these options enabled. + +{{/warning}} + +{% endif %} + POST /user/emails ### Input @@ -29,10 +43,31 @@ You can post a single email address or an array of addresses: ### Response <%= headers 201 %> -<%= json ["octocat@github.com", "support@github.com"] %> +<%= json [ + { + "email" => "octocat@github.com", + "primary" => false, + "verified" => false + }, + { + "email" => "support@github.com", + "primary" => false, + "verified" => false + }, +] %> ## Delete email address(es) +{% if page.version != 'dotcom' && page.version >= 2.1 %} + +{{#warning}} + +If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize emails enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to remove an email address via the API with these options enabled. + +{{/warning}} + +{% endif %} + DELETE /user/emails ### Input @@ -45,3 +80,5 @@ You can include a single email address or an array of addresses: <%= headers 204 %> + +[media-types]: /v3/media diff --git a/content/v3/users/followers.md b/content/v3/users/followers.md index eb32126e10..258d8d5e31 100644 --- a/content/v3/users/followers.md +++ b/content/v3/users/followers.md @@ -1,14 +1,16 @@ --- -title: User Followers | GitHub API +title: User Followers --- -# User Followers API +# Followers + +{:toc} ## List followers of a user List a user's followers: - GET /users/:user/followers + GET /users/:username/followers List the authenticated user's followers: @@ -16,14 +18,14 @@ List the authenticated user's followers: ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> -## List users following another user +## List users followed by another user List who a user is following: - GET /users/:user/following + GET /users/:username/following List who the authenticated user is following: @@ -31,12 +33,12 @@ List who the authenticated user is following: ### Response -<%= headers 200, :pagination => true %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user) { |h| [h] } %> ## Check if you are following a user - GET /user/following/:user + GET /user/following/:username ### Response if you are following this user @@ -46,9 +48,26 @@ List who the authenticated user is following: <%= headers 404 %> +## Check if one user follows another + + GET /users/:username/following/:target_user + +### Response if user follows target user + +<%= headers 204 %> + +### Response if user does not follow target user + +<%= headers 404 %> + ## Follow a user - PUT /user/following/:user + PUT /user/following/:username + +<%= fetch_content(:put_content_length) %> + +Following a user requires the user to be logged in and authenticated with basic +auth or OAuth with the `user:follow` scope. ### Response @@ -56,7 +75,10 @@ List who the authenticated user is following: ## Unfollow a user - DELETE /user/following/:user + DELETE /user/following/:username + +Unfollowing a user requires the user to be logged in and authenticated with basic +auth or OAuth with the `user:follow` scope. ### Response diff --git a/content/v3/users/gpg_keys.md b/content/v3/users/gpg_keys.md new file mode 100644 index 0000000000..448737dc56 --- /dev/null +++ b/content/v3/users/gpg_keys.md @@ -0,0 +1,78 @@ +--- +title: User GPG Keys +--- + +{% if page.version == 'dotcom' %} + +# GPG Keys + +{{#tip}} + + + + APIs for managing user GPG keys are currently available for developers to preview. + During the preview period, the APIs may change without advance notice. + Please see the [blog post](/changes/2016-04-04-git-signing-api-preview) for full details. + + To access the API you must provide a custom [media type](/v3/media) in the `Accept` header: + + application/vnd.github.cryptographer-preview + +{{/tip}} + +{:toc} + +## List your GPG keys + + GET /user/gpg_keys + +Lists the current user's GPG keys. Requires that you are authenticated via +Basic Auth or via OAuth with at least `read:gpg_key` +[scope](/v3/oauth/#scopes). + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:gpg_key) { |h| [h] } %> + +## Get a single GPG key + +View extended details for a single GPG key. Requires that you are +authenticated via Basic Auth or via OAuth with at least `read:gpg_key` +[scope](/v3/oauth/#scopes). + + GET /user/gpg_keys/:id + +### Response + +<%= headers 200 %> +<%= json :gpg_key %> + +## Create a GPG key + +Creates a GPG key. Requires that you are authenticated via Basic Auth, +or OAuth with at least `write:gpg_key` [scope](/v3/oauth/#scopes). + + POST /user/gpg_keys + +### Input + +<%= json :armored_public_key => "-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----" %> + +### Response + +<%= headers 201, :Location => get_resource(:gpg_key)['url'] %> +<%= json :gpg_key %> + +## Delete a GPG key + +Removes a GPG key. Requires that you are authenticated via Basic Auth +or via OAuth with at least `admin:gpg_key` [scope](/v3/oauth/#scopes). + + DELETE /user/gpg_keys/:id + +### Response + +<%= headers 204 %> + +{% endif %} diff --git a/content/v3/users/keys.md b/content/v3/users/keys.md index 646a8840d7..25378d75f4 100644 --- a/content/v3/users/keys.md +++ b/content/v3/users/keys.md @@ -1,23 +1,42 @@ --- -title: User Public Keys | GitHub API +title: User Public Keys --- -# User Public Keys API +# Public Keys -Management of public keys via the API requires that you are -authenticated. +{:toc} ## List public keys for a user + GET /users/:username/keys + +Lists the _verified_ public keys for a user. This is accessible by anyone. + +### Response + +<%= headers 200, :pagination => default_pagination_rels %> +<%= json(:simple_public_key) { |h| [h] } %> + + +## List your public keys + GET /user/keys +Lists the current user's keys. Requires that you are authenticated via +Basic Auth or via OAuth with at least `read:public_key` +[scope](/v3/oauth/#scopes). + ### Response -<%= headers 200 %> +<%= headers 200, :pagination => default_pagination_rels %> <%= json(:public_key) { |h| [h] } %> ## Get a single public key +View extended details for a single public key. Requires that you are +authenticated via Basic Auth or via OAuth with at least `read:public_key` +[scope](/v3/oauth/#scopes). + GET /user/keys/:id ### Response @@ -27,6 +46,19 @@ authenticated. ## Create a public key +Creates a public key. Requires that you are authenticated via Basic Auth, +or OAuth with at least `write:public_key` [scope](/v3/oauth/#scopes). + +{% if page.version != 'dotcom' && page.version >= 2.1 %} + +{{#warning}} + +If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add an SSH key address via the API with these options enabled. + +{{/warning}} + +{% endif %} + POST /user/keys ### Input @@ -35,23 +67,29 @@ authenticated. ### Response -<%= headers 201, :Location => "https://api.github.com/user/keys/1" %> +<%= headers 201, :Location => get_resource(:public_key)['url'] %> <%= json :public_key %> ## Update a public key - PATCH /user/keys/:id +Public keys are immutable. If you need to update a public key, [remove the +key](#delete-a-public-key) and [create a new one](#create-a-public-key) +instead. -### Input +## Delete a public key -<%= json :title => "octocat@octomac", :key => "ssh-rsa AAA..." %> +Removes a public key. Requires that you are authenticated via Basic Auth +or via OAuth with at least `admin:public_key` [scope](/v3/oauth/#scopes). -### Response +{% if page.version != 'dotcom' && page.version >= 2.1 %} -<%= headers 200 %> -<%= json :public_key %> +{{#warning}} -## Delete a public key +If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to remove an SSH key address via the API with these options enabled. + +{{/warning}} + +{% endif %} DELETE /user/keys/:id diff --git a/content/v3/versions.md b/content/v3/versions.md new file mode 100644 index 0000000000..53c7cf6f33 --- /dev/null +++ b/content/v3/versions.md @@ -0,0 +1,198 @@ +--- +title: Versions +--- +# Versions + +There are two stable versions of the GitHub API: the [v3](#v3) version and the deprecated [beta](#beta) version. There are just a few [differences between these two versions](#differences-from-beta-version). + +By default, all requests receive the v3 version. We encourage you to [request a specific version via the `Accept` header](/v3/media/#request-specific-version). + +# v3 + +The [v3 API](/v3) is stable, and we strive to ensure that all [changes](/changes) are backwards compatible. Please [file a support issue][support] if you have problems. + +Some v3 functionality is [deprecated](#v3-deprecations) and will be removed in the next major version of the API. + +## Differences from beta version + +The v3 media type differs from the beta media type in just a few places: + +### Gist JSON + +For [Gists](/v3/gists/#get-a-single-gist), the v3 media type renames the `user` attribute to `owner`. + +### Issue JSON + +When an [issue](/v3/issues/#get-a-single-issue) is not a pull request, the v3 media type omits the `pull_request` attribute. + +### Repository JSON + +For [Repositories](/v3/repos/#get), the v3 media type omits the `master_branch` attribute. API clients should use the `default_branch` attribute to obtain the repository's default branch. + +### User Emails JSON + +For [User Emails](/v3/users/emails/#list-email-addresses-for-a-user), the v3 media type returns an array of objects (instead of an array of strings). + +## v3 deprecations + +The following functionality is deprecated. For backwards compatibility purposes, +v3 will continue to provide this functionality. However, this deprecated +functionality _will be removed_ in the next major version of the API. + +The recommendations below will help you prepare your application for the next major version of the API. + +1. Method: /gists/:id/fork + + Recommendation: Use **/gists/:id/forks** (plural) instead. + +1. Method: /legacy/issues/search/:owner/:repository/:state/:keyword + + Recommendation: Use [v3 Issue Search API](/v3/search/#search-issues) instead. + +1. Method: /legacy/repos/search/:keyword + + Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead. + +1. Method: /legacy/user/search/:keyword + + Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead. + +1. Method: /legacy/user/email/:email + + Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead. + +1. Method: /repos/:owner/:repo/hooks/:id/test + + Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead. + +1. Method: /teams/:id/members/:username + + Recommendation: Use [Get Team Membership](/v3/orgs/teams/#get-team-membership), [Add Team Membership](/v3/orgs/teams/#add-team-membership), and [Remove Team Membership](/v3/orgs/teams/#remove-team-membership) instead. + +1. Query parameters when POSTing to /repos/:owner/:repo/forks + + Recommendation: Use JSON to POST to this method instead. + +1. Query parameter value: Passing "watchers" as the value for the "sort" parameter in a GET request to /repos/:owner/:repo/forks + + Recommendation: Use **stargazers** as the value instead. + +1. Pull Request attribute: merge_commit_sha + + Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/). + +1. Rate Limit attribute: rate + + Recommendation: Use **resources["core"]** instead. + +1. Repository attribute: forks + + Recommendation: Use **forks_count** instead. + +1. Repository attribute: master_branch + + Recommendation: Use **default_branch** instead. + +1. Repository attribute: open_issues + + Recommendation: Use **open_issues_count** instead. + +1. Repository attribute: public + + Recommendation: When [creating a repository](/v3/repos/#create), use the + **private** attribute to indicate whether the repository should be public or + private. Do not use the **public** attribute. + +1. Repository attribute: watchers + + Recommendation: Use **watchers_count** instead. + +1. User attribute: bio + + Recommendation: Do not use this attribute. It is obsolete. + +1. User attribute: plan["collaborators"] + + Recommendation: Do not use this attribute. It is obsolete. + +1. User attribute: gravatar_id + + Recommendation: Use **avatar_url** instead. + +1. Feed attribute: current_user_organization_url + + Recommendation: Use **current_user_organization_urls** instead. + +1. Feed attribute: current_user_organization + + Recommendation: Use **current_user_organizations** instead. + +1. Pagination parameters `top` and `sha` for method: /repos/:owner/:repo/commits + + Recommendation: When fetching [the list of commits for a repository](/v3/repos/commits/#list-commits-on-a-repository) + use the [standard `per_page` and `page` parameters](/v3/#pagination) for pagination, instead of `per_page`, + `top`, and `sha`. + +1. Authorization attribute: token + + Recommendation: This attribute will return an empty string in the majority of + the Authorizations API responses. Please see + [the deprecation blog post](/changes/2015-04-20-authorizations-api-response-changes-are-now-in-effect/) + and the [Authorizations API deprecation notice](/v3/oauth_authorizations/#deprecation-notice) + for full details. + +1. Team attribute: permission + + Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add or update team repository](/v3/orgs/teams/#add-or-update-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add or update team repository](/v3/orgs/teams/#add-or-update-team-repository) with a `permission` attribute to update each repository's permission separately. + +1. Issue attribute: assignee + + Recommendation: Use the [`assignees`](https://developer.github.com/v3/issues/#create-an-issue) key instead, since issues can have more than one assignee. Alternatively, you can use the + [assignees](https://developer.github.com/v3/issues/assignees/) endpoints. + + + +# beta (Deprecated) + +The [beta API](/v3) is deprecated. Its current functionality is stable, and we strive to ensure that any [changes](/changes) are backwards compatible. Please [file a support issue][support] if you have problems. + +{{#tip}} + +Note: We recommend using the v3 API instead of the deprecated beta version of the API. + +The beta media type differs from the v3 media type in just a few places. In most cases, migrating an application from the beta media type to the v3 media type is smooth and painless. + +We will eventually retire the beta version, but we have no official retirement date to announce at the moment. When the time comes, rest assured that we'll announce the retirement with plenty of notice. + +{{/tip}} + +## Breaking beta changes + +### June 15th, 2011: + +* `gravatar_url` is being deprecated in favor of `avatar_url` for all + responses that include users or orgs. A default size is no longer + included in the URL. +* Creating new gists (both anonymously and with an authenticated user) + should use `POST /gists` from now on. `POST /users/:username/gists` is no + longer supported. + +### June 1st, 2011: + +* Removed support for PUT verb on update requests. Use POST or PATCH + instead. +* Removed `.json` extension from all URLs. +* No longer using the X-Next or X-Last headers. Pagination info is + returned in the Link header instead. +* JSON-P response has completely changed to a more consistent format. +* Starring gists now uses PUT verb (instead of POST) and returns 204. + +# v2 + +We removed support for API v2 on June 12, 2012. + +# v1 + +We removed support for API v1 on June 12, 2012. + +[support]: https://github.com/contact?form[subject]=APIv3 diff --git a/content/webhooks/configuring.md b/content/webhooks/configuring.md new file mode 100644 index 0000000000..c48be12ffb --- /dev/null +++ b/content/webhooks/configuring.md @@ -0,0 +1,86 @@ +--- +title: Configuring your server +layout: webhooks +--- + +# Configuring Your Server + +{:toc} + +Now that our webhook is ready to deliver messages, we'll set up a basic Sinatra server +to handle incoming payloads. + +Recall that we specifically set our webhook URL to `http://localhost:4567/payload`. +Since we're developing locally, we'll need to expose our local development environment +to the Internet, so that GitHub can send out messages, and our local server can +process them. + +Note: you can download the complete source code for this project +[from the platform-samples repo][platform samples]. + +## Using ngrok + +First, we'll install a program to expose our local host to the Internet. We'll use +ngrok to do this. [ngrok is a free download](https://ngrok.com/download) available +for all major operating systems. + +When you're done with that, you can expose your localhost by running `./ngrok http 4567` +on the command line. You should see a line that looks something like this: + +``` command-line +$ Forwarding http://7e9ea9dc.ngrok.io -> 127.0.0.1:4567 +``` + +Copy that funky `*.ngrok.io` URL! We're now going to go *back* to the Payload +URL and pasting this server into that field. It should look something like `http://7e9ea9dc.ngrok.io/payload`. + +By doing this, we've set ourselves up to expose our localhost at path `/payload` +to the Internet. + +## Writing the server + +Now comes the fun part! We want our server to listen to `POST` requests, at `/payload`, +because that's where we told GitHub our webhook URL was. Since ngrok is exposing +our local environment, we don't need to set up a real server somewhere online, and +can happily test out our code locally. + +Let's set up a little Sinatra app to do something with the information. Our initial +setup might look something like this: + +``` ruby +require 'sinatra' +require 'json' + +post '/payload' do + push = JSON.parse(request.body.read) + puts "I got some JSON: #{push.inspect}" +end +``` + +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra].) + +Start this server up. + +Since we set up our webhook to listen to events dealing with `Issues`, go ahead +and create a new Issue on the repository you're testing with. Once you create +it, switch back to your terminal. You should see something like this in your output: + +``` command-line +$ ~/Developer/platform-samples/hooks/ruby/configuring-your-server $ ruby server.rb +> == Sinatra/1.4.4 has taken the stage on 4567 for development with backup from Thin +> >> Thin web server (v1.5.1 codename Straight Razor) +> >> Maximum connections set to 1024 +> >> Listening on localhost:4567, CTRL+C to stop +> I got some JSON: {"action"=>"opened", "issue"=>{"url"=>"... +``` + +Success! You've successfully configured your server to listen to webhooks. Your +server can now process this information any way you see fit. For example, if you +were setting up a "real" web application, you might want to log some of the JSON +output to a database. + +For additional information on working with webhooks for fun and profit, head on +over to the [Testing Webhooks](/webhooks/testing) guide. + +[platform samples]: https://github.com/github/platform-samples/tree/master/hooks/ruby/configuring-your-server +[Sinatra]: http://www.sinatrarb.com/ diff --git a/content/webhooks/creating.md b/content/webhooks/creating.md new file mode 100644 index 0000000000..06170155d1 --- /dev/null +++ b/content/webhooks/creating.md @@ -0,0 +1,65 @@ +--- +title: Creating webhooks +layout: webhooks +--- + +# Creating Webhooks + +{:toc} + +Now that we understand [the basics of webhooks][webhooks-overview], let's go +through the process of building out our own webhook powered integration. In +this tutorial, we'll create a repository webhook that will be responsible for +listing out how popular our repository is, based on the number of Issues it +receives per day. + +Creating a webhook is a two-step process. You'll first need to set up how you want +your webhook to behave through {{ site.data.variables.product.product_name }}--what events should it listen to. After that, +you'll set up your server to receive and manage the payload. + +## Setting up a Webhook + +To set up a repository webhook on {{ site.data.variables.product.product_name }}, head over to the **Settings** page of +your repository, and click on **Webhooks & services**. After that, click on +**Add webhook**. + +Alternatively, you can choose to build and manage a webhook [through the Webhooks API][webhook-api]. + +Webhooks require a few configuration options before you can make use of them. +We'll go through each of these settings below. + +## Payload URL + +This is the server endpoint that will receive the webhook payload. + +Since we're developing locally for our tutorial, let's set it to `http://localhost:4567/payload`. +We'll explain why in the [Configuring Your Server](/webhooks/configuring/) docs. + +## Content Type + +Webhooks can be delivered using different content types: + +- The `application/json` content type will deliver the JSON payload directly as the body of the POST. +- The `application/x-www-form-urlencoded` content type will send the JSON payload as a form parameter + called "payload". + +Choose the one that best fits your needs. For this tutorial, the default content type of +`application/json` is fine. + +## Events + +Events are at the core of webhooks. These webhooks fire whenever a certain action is +taken on the repository, which your server's payload URL intercepts and acts upon. + +A full list of webhook events, and when they execute, can be found in [the webhooks API][hooks-api] reference. + +Since our webhook is dealing with Issues in a repository, we'll click on **Issues**, +and toggle the options there. + +When you're finished, click on **Add webhook**. Phew! Now that the webhook is created, +it's time to set up our local server to test the webhook. Head on over to +[Configuring Your Server](/webhooks/configuring/) to learn how to do that. + +[webhooks-overview]: /webhooks/ +[webhook-api]: /v3/repos/hooks/ +[hooks-api]: /webhooks/#events diff --git a/content/webhooks/index.md b/content/webhooks/index.md new file mode 100644 index 0000000000..03fc42d1ca --- /dev/null +++ b/content/webhooks/index.md @@ -0,0 +1,188 @@ +--- +title: Webhooks +layout: webhooks +--- + +# Webhooks + +{:toc} + + +Webhooks allow you to build or set up integrations which subscribe to certain +events on GitHub.com. When one of those events is triggered, we'll send a HTTP +POST payload to the webhook's configured URL. Webhooks can be used to update +an external issue tracker, trigger CI builds, update a backup mirror, or even +deploy to your production server. You're only limited by your imagination. + +Each webhook can be installed [on an organization][org-hooks] or [a specific +repository][repo-hooks]. Once installed, they will be triggered each time one +or more subscribed events occurs on that organization or repository. + +You can create up to 20 webhooks for each event on each installation target +(specific organization or specific repository). + +## Events + +When configuring a webhook, you can choose which events you would like to +receive payloads for. You can [even opt-in to all current and future +events][wildcard-section]. Only subscribing to the specific events you plan on +handling is useful for limiting the number of HTTP requests to your server. You +can change the list of subscribed events through the API or UI anytime. By +default, webhooks are only subscribed to the `push` event. + +Each event corresponds to a certain set of actions that can happen to your +organization and/or repository. For example, if you subscribe to the `issues` +event you'll receive [detailed payloads][payloads-section] every time an issue +is opened, closed, labeled, etc. + + +The available events are: + +Name | Description +-----|-----------| +`*` | Any time any event is triggered ([Wildcard Event][wildcard-section]). +[`commit_comment`][event-types-commit_comment] | Any time a Commit is commented on. +[`create`][event-types-create] | Any time a Branch or Tag is created. +[`delete`][event-types-delete] | Any time a Branch or Tag is deleted. +[`deployment`][event-types-deployment] | Any time a Repository has a new deployment created from the API. +[`deployment_status`][event-types-deployment_status] | Any time a deployment for a Repository has a status update from the API. +[`fork`][event-types-fork] | Any time a Repository is forked. +[`gollum`][event-types-gollum] | Any time a Wiki page is updated. +[`issue_comment`][event-types-issue_comment] | {% if page.version == 'dotcom' or page.version > 2.6 %}Any time a [comment on an issue](/v3/issues/comments/) is created, edited, or deleted.{% else %}Any time an [issue is commented on](/v3/issues/comments).{% endif %} +[`issues`][event-types-issues] | Any time an Issue is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, or reopened. +[`member`][event-types-member] | Any time a User is added as a collaborator to a Repository. +[`membership`][event-types-membership] | Any time a User is added or removed from a team. **Organization hooks only**. +[`page_build`][event-types-page_build] | Any time a Pages site is built or results in a failed build. +[`public`][event-types-public] | Any time a Repository changes from private to public. +[`pull_request_review_comment`][event-types-pull_request_review_comment] | {% if page.version == 'dotcom' or page.version > 2.6 %}Any time a [comment on a Pull Request's unified diff](/v3/pulls/comments) is created, edited, or deleted{% else %}Any time a [Pull Request's unified diff is commented on](/v3/pulls/comments){% endif %} (in the Files Changed tab). +[`pull_request`][event-types-pull_request] | Any time a Pull Request is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, reopened, or synchronized (updated due to a new push in the branch that the pull request is tracking). +[`push`][event-types-push] | Any Git push to a Repository, including editing tags or branches. Commits via API actions that update references are also counted. **This is the default event.** +[`repository`][event-types-repository] | Any time a Repository is created{% if page.version == 'dotcom' or page.version > 2.6 %}, deleted, made public, or made private{% else %}. **Organization hooks only**{% endif %}. +[`release`][event-types-release] | Any time a Release is published in a Repository. +[`status`][event-types-status] | Any time a Repository has a status update from the API +[`team_add`][event-types-team_add] | Any time a team is added or modified on a Repository. +[`watch`][event-types-watch] | Any time a User stars a Repository. + +### Wildcard Event + +We also support a wildcard (`*`) that will match all supported events. When you +add the wildcard event, we'll replace any existing events you have configured +with the wildcard event and send you payloads for all supported events. You'll +also automatically get any new events we might add in the future. + + +## Payloads + +Each event type has a specific payload format with the relevant event +information. All event payloads mirror [the payloads for the Event +types][event-types], with the exception of [the original `push` +event][event-types-push], which has a more detailed webhook payload. + +In addition to the fields [documented for each event][event-types], webhook +payloads include the user who performed the event (`sender`) as well as the +organization (`organization`) and/or repository (`repository`) which the event +occurred on. + +{{#tip}} + +**Note:** Payloads are capped at 5 MB. If your event generates a larger payload, a webhook will not be fired. This may happen, for example, on a `create` event if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. + +{{/tip}} + +### Delivery headers + +HTTP requests made to your webhook's configured URL endpoint will contain +several special headers: + +Header | Description +-------|-------------| +`X-GitHub-Event`| Name of the [event][events-section] that triggered this delivery. +`X-Hub-Signature`| HMAC hex digest of the payload, using [the hook's `secret`][repo-hooks-create] as the key (if configured). +`X-GitHub-Delivery`| Unique ID for this delivery. + +Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. + +### Example delivery + +``` command-line +> POST /payload HTTP/1.1 + +> Host: localhost:4567 +> X-Github-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958 +> User-Agent: GitHub-Hookshot/044aadd +> Content-Type: application/json +> Content-Length: 6615 +> X-GitHub-Event: issues + +> { +> "action": "opened", +> "issue": { +> "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", +> "number": 1347, +> ... +> }, +> "repository" : { +> "id": 1296269, +> "full_name": "octocat/Hello-World", +> "owner": { +> "login": "octocat", +> "id": 1, +> ... +> }, +> ... +> }, +> "sender": { +> "login": "octocat", +> "id": 1, +> ... +> } +> } +``` + +## Ping Event + +When you create a new webhook, we'll send you a simple `ping` event to let you +know you've set up the webhook correctly. This event isn't stored so it isn't +retrievable via the [Events API][events-api]. You can trigger a `ping` again by +calling the [ping endpoint][repo-hooks-ping]. + +### Ping Event Payload + +Key | Value | +----| ----- | +zen | Random string of GitHub zen | +hook_id | The ID of the webhook that triggered the ping | +hook | The [webhook configuration][repo-hooks-show] | + +[service-hooks-section]: #service-hooks +[events-section]: #events +[wildcard-section]: #wildcard-event +[payloads-section]: #payloads +[org-hooks]: /v3/orgs/hooks/ +[repo-hooks]: /v3/repos/hooks/ +[repo-hooks-show]: /v3/repos/hooks/#get-single-hook +[repo-hooks-create]: /v3/repos/hooks/#create-a-hook +[repo-hooks-ping]: /v3/repos/hooks/#ping-a-hook +[events-api]: /v3/activity/events/ +[event-types]: /v3/activity/events/types/ +[event-types-commit_comment]: /v3/activity/events/types/#commitcommentevent +[event-types-create]: /v3/activity/events/types/#createevent +[event-types-delete]: /v3/activity/events/types/#deleteevent +[event-types-deployment]: /v3/activity/events/types/#deploymentevent +[event-types-deployment_status]: /v3/activity/events/types/#deploymentstatusevent +[event-types-fork]: /v3/activity/events/types/#forkevent +[event-types-gollum]: /v3/activity/events/types/#gollumevent +[event-types-issue_comment]: /v3/activity/events/types/#issuecommentevent +[event-types-issues]: /v3/activity/events/types/#issuesevent +[event-types-member]: /v3/activity/events/types/#memberevent +[event-types-membership]: /v3/activity/events/types/#membershipevent +[event-types-page_build]: /v3/activity/events/types/#pagebuildevent +[event-types-public]: /v3/activity/events/types/#publicevent +[event-types-pull_request]: /v3/activity/events/types/#pullrequestevent +[event-types-pull_request_review_comment]: /v3/activity/events/types/#pullrequestreviewcommentevent +[event-types-push]: /v3/activity/events/types/#pushevent +[event-types-release]: /v3/activity/events/types/#releaseevent +[event-types-repository]: /v3/activity/events/types/#repositoryevent +[event-types-status]: /v3/activity/events/types/#statusevent +[event-types-team_add]: /v3/activity/events/types/#teamaddevent +[event-types-watch]: /v3/activity/events/types/#watchevent diff --git a/content/webhooks/securing.md b/content/webhooks/securing.md new file mode 100644 index 0000000000..407ea1f26b --- /dev/null +++ b/content/webhooks/securing.md @@ -0,0 +1,71 @@ +--- +title: Securing your webhooks +layout: webhooks +--- + +# Securing your webhooks + +{:toc} + +Once your server is configured to receive payloads, it'll listen for any payload sent to the endpoint you configured. For security reasons, you probably want to limit requests to those coming from GitHub. There are a few ways to go about this--for example, you could opt to whitelist requests from GitHub's IP address--but a far easier method is to set up a secret token and validate the information. + + +## Setting your secret token + +You'll need to set up your secret token in two places: GitHub and your server. + +To set your token on GitHub: + +1. Navigate to the repository where you're setting up your webhook. +2. Fill out the Secret textbox. Use a random string with high entropy (e.g., by taking the output of `ruby -rsecurerandom -e 'puts SecureRandom.hex(20)'` at the terminal). + +3. Click **Update Webhook**. + +Next, set up an environment variable on your server that stores this token. Typically, this is as simple as running: + +``` command-line +$ export SECRET_TOKEN=your_token +``` + +**Never** hardcode the token into your app! + +## Validating payloads from GitHub + +When your secret token is set, GitHub uses it to create a hash signature with each payload. + +This hash signature is passed along with each request in the headers as `X-Hub-Signature`. Suppose you have a basic server listening to webhooks that looks like this: + +``` ruby +require 'sinatra' +require 'json' + +post '/payload' do + push = JSON.parse(params[:payload]) + puts "I got some JSON: #{push.inspect}" +end +``` + +The goal is to compute a hash using your `SECRET_TOKEN`, and ensure that the hash from GitHub matches. GitHub uses an HMAC hexdigest to compute the hash, so you could change your server to look a little like this: + +``` ruby +post '/payload' do + request.body.rewind + payload_body = request.body.read + verify_signature(payload_body) + push = JSON.parse(params[:payload]) + puts "I got some JSON: #{push.inspect}" +end + +def verify_signature(payload_body) + signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body) + return halt 500, "Signatures didn't match!" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_HUB_SIGNATURE']) +end +``` + +Obviously, your language and server implementations may differ than this code. There's a couple of very important thing to point out, however: + +* No matter which implementation you use, the hash signature starts with `sha1=`, using the key of your secret token and your payload body. + +* Using a plain `==` operator is **not advised**. A method like [`secure_compare`][secure_compare] performs a "constant time" string comparison, which renders it safe from certain timing attacks against regular equality operators. + +[secure_compare]: http://rubydoc.info/github/rack/rack/master/Rack/Utils.secure_compare diff --git a/content/webhooks/testing.md b/content/webhooks/testing.md new file mode 100644 index 0000000000..c57a2ba788 --- /dev/null +++ b/content/webhooks/testing.md @@ -0,0 +1,43 @@ +--- +title: Testing webhooks +layout: webhooks +--- + +# Testing Webhooks + +{:toc} + +Now that you've [configured your local server](/webhooks/configuring/), you might +be interested in pushing your code to the limits. To that end, GitHub's webhooks +view provides some tooling for testing your deployed payloads. + + +## Listing recent deliveries + +Every webhook has its own "Recent Deliveries" section, which lists, at a glance +whether a deployment was successful (green check) or failed (red x). + + + +You can also identify when each delivery was attempted. + +## Digging into results + +By expanding an individual delivery, you'll be able to witness *precisely* +what information GitHub is attempting to send to your server. This includes +both the HTTP Request and Response. + +### Request + +The webhook delivery view provides information on which Headers were sent by GitHub. +It also includes details about the JSON payload. + + + +### Response + +The response tab lists how your server replied once it received the payload from +GitHub. This includes the status code, the headers, and any additional data +within the response body. + + diff --git a/data/variables/contact.yml b/data/variables/contact.yml new file mode 100644 index 0000000000..6728eb4501 --- /dev/null +++ b/data/variables/contact.yml @@ -0,0 +1,6 @@ +contact_support: + {% if page.version == 'dotcom' %} + '[GitHub support](https://github.com/contact)' + {% else %} + 'your GitHub Enterprise site administrator' + {% endif %} diff --git a/data/variables/product.yml b/data/variables/product.yml new file mode 100644 index 0000000000..221100b3ca --- /dev/null +++ b/data/variables/product.yml @@ -0,0 +1,20 @@ +api_url_pre: + {% if page.version == 'dotcom' %} + 'https://api.github.com' + {% else %} + 'http(s)://[hostname]/api/v3' + {% endif %} + +api_url_code: + {% if page.version == 'dotcom' %} + 'https://api.github.com' + {% else %} + 'http(s)://[hostname]/api/v3' + {% endif %} + +product_name: + {% if page.version == 'dotcom' %} + 'GitHub' + {% else %} + 'GitHub Enterprise' + {% endif %} diff --git a/gulpfile.js b/gulpfile.js new file mode 100644 index 0000000000..8b858f499b --- /dev/null +++ b/gulpfile.js @@ -0,0 +1,107 @@ +var gulp = require("gulp"), + gulpif = require("gulp-if"), + sass = require("gulp-sass"), + minifyCss = require("gulp-minify-css"), + replace = require("gulp-replace"), + coffee = require("gulp-coffee"), + concat = require("gulp-concat"), + uglify = require("gulp-uglify"), + yaml = require("js-yaml"), + + exec = require('child_process').exec, + + fs = require('fs'), + path = require("path"); + +CONFIG = yaml.safeLoad(fs.readFileSync("nanoc.yaml", "utf8")); +IS_PRODUCTION = process.env.NODE_ENV == "production"; + +var transformCS = function (file) { + return path.extname(file.path) == ".coffee"; +}; + +gulp.task("css", function() { + return gulp.src([ + "assets/stylesheets/reset.css", + "assets/stylesheets/documentation.css", + "assets/stylesheets/pagination.css", + "assets/stylesheets/pygments.css", + "assets/vendor/octicons/octicons/octicons.css" + ]) + .pipe(concat("application.css")) + .pipe(gulpif(IS_PRODUCTION, minifyCss())) + .pipe(gulp.dest("output/assets/stylesheets/")); +}); + +gulp.task("javascript", function () { + gulp.src("assets/javascripts/dev_mode.js") + .pipe(gulp.dest("output/assets/javascripts/")); + return gulp.src([ + "assets/javascripts/initial.js", + "assets/javascripts/documentation.js", + "assets/javascripts/search.js", + "assets/javascripts/images.js", + "assets/vendor/retinajs/src/retinajs" + ]) + .pipe(gulpif(transformCS, coffee())) + .pipe(concat("application.js")) + .pipe(replace(/\{\{ site\.version \}\}/g, CONFIG.latest_enterprise_version)) + .pipe(gulpif(IS_PRODUCTION, uglify())) + .pipe(gulp.dest("output/assets/javascripts")); +}); + +gulp.task("javascript_workers", function () { + return gulp.src([ + "assets/javascripts/search_worker.js", + "assets/vendor/lunr.js/lunr.min.js" + ]) + .pipe(gulp.dest("output/assets/javascripts")); +}); + +gulp.task("octicons", function() { + return gulp.src("assets/vendor/octicons/octicons/**/*") + .pipe(gulp.dest("output/assets/stylesheets")); +}); + +gulp.task("images", function() { + return gulp.src("assets/images/**/*") + .pipe(gulp.dest("output/assets/images")); +}); + +gulp.task("nanoc:compile", function (cb) { + exec("bundle exec nanoc compile", {maxBuffer: 1024 * 1000}, function (err, stdout, stderr) { + console.log(stdout); + console.log(stderr); + cb(err); + }); +}); + +gulp.task("server", function() { + connect = require("gulp-connect"); + connect.server({ + port: 4000, + root: ["output"], + fallback: "output/404.html" + }); +}); + +gulp.task("watch:nanoc", function() { + gulp.watch([ + "nanoc.yaml", + "Rules", + "content/**/*", + "layouts/**/*", + "lib/**/*" + ], ["nanoc:compile"]); +}); + +gulp.task("watch:assets", function() { + gulp.watch([ + "assets/**/*" + ], ["assets"]); +}); + +gulp.task("serve", [ "server", "watch:nanoc", "watch:assets" ]); +gulp.task("assets", [ "css", "javascript", "javascript_workers", "octicons", "images" ]); +gulp.task("build", [ "nanoc:compile", "assets" ]); +gulp.task("default", [ "build", "serve" ]); diff --git a/layouts/_changes.html b/layouts/_changes.html new file mode 100644 index 0000000000..35b25d854e --- /dev/null +++ b/layouts/_changes.html @@ -0,0 +1,6 @@ +<% @changes.each do |article| %> +
+ <%= renderp '/_meta.*', :item => article %>
+ <%= article.compiled_content %>
+
+<% end %>
diff --git a/layouts/_meta.html b/layouts/_meta.html
new file mode 100644
index 0000000000..1e00f62367
--- /dev/null
+++ b/layouts/_meta.html
@@ -0,0 +1,19 @@
++ <%= @item[:title] %> +
+ + diff --git a/layouts/api.html b/layouts/api.html new file mode 100644 index 0000000000..3158b7c83e --- /dev/null +++ b/layouts/api.html @@ -0,0 +1,27 @@ +<%= renderp '/head.*' %> + + + <%= renderp '/header.*' %> + + + +
+
+
+ <%= renderp '/footer.*' %>
+
+
diff --git a/layouts/blog.html b/layouts/blog.html
new file mode 100644
index 0000000000..6e8e32a891
--- /dev/null
+++ b/layouts/blog.html
@@ -0,0 +1,20 @@
+<%= renderp '/head.*' %>
+
+
+ <%= renderp '/header.*' %>
+
+
+ <%= yield %>
+
+
+ <%= renderp '/sidebar.*' %>
+
+
+
+ <%= renderp '/footer.*' %>
+
+
+ <%= yield %>
+
+
+
+