Movatterモバイル変換

[0]ホーム
URL:

Libraries »piotrmurach/github(master) »Index (R) »Github »Client »GitData »References

Class: Github::Client::GitData::References

Inherits:
API
  • Object
  • API
  • Github::Client::GitData::References
show all
Defined in:
lib/github_api/client/git_data/references.rb

Constant Summarycollapse

VALID_REF_PARAM_NAMES =
%w[refshaforce].freeze
REQUIRED_REF_PARAMS =
%w[refsha].freeze
VALID_REF_PARAM_VALUES =
{'ref'=>%r{^refs\/\w+(\/\w+)*}# test fully qualified reference}

Constants included fromMimeType

MimeType::MEDIA_LOOKUP

Constants included fromGithub::Constants

Github::Constants::ACCEPT,Github::Constants::ACCEPTED_OAUTH_SCOPES,Github::Constants::ACCEPT_CHARSET,Github::Constants::CACHE_CONTROL,Github::Constants::CONTENT_LENGTH,Github::Constants::CONTENT_TYPE,Github::Constants::DATE,Github::Constants::ETAG,Github::Constants::HEADER_LAST,Github::Constants::HEADER_LINK,Github::Constants::HEADER_NEXT,Github::Constants::LOCATION,Github::Constants::META_FIRST,Github::Constants::META_LAST,Github::Constants::META_NEXT,Github::Constants::META_PREV,Github::Constants::META_REL,Github::Constants::OAUTH_SCOPES,Github::Constants::PARAM_PAGE,Github::Constants::PARAM_PER_PAGE,Github::Constants::PARAM_START_PAGE,Github::Constants::RATELIMIT_LIMIT,Github::Constants::RATELIMIT_REMAINING,Github::Constants::RATELIMIT_RESET,Github::Constants::SERVER,Github::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited fromAPI

#current_options

Instance Method Summarycollapse

Methods inherited fromAPI

after_callbacks,after_request,#api_methods_in,#arguments,before_callbacks,before_request,clear_request_methods!,#disable_redirects,#execute,extend_with_actions,extra_methods,#extract_basic_auth,extract_class_name,#filter_callbacks,inherited,#initialize,internal_methods,method_added,#method_missing,#module_methods_in,namespace,request_methods,require_all,#respond_to?,root!,#run_callbacks,#set,#yield_or_eval

Methods included fromRequest::Verbs

#delete_request,#get_request,#head_request,#options_request,#patch_request,#post_request,#put_request

Methods included fromRateLimit

#ratelimit,#ratelimit_remaining,#ratelimit_reset

Methods included fromMimeType

#lookup_media,#parse

Methods included fromAuthorization

#auth_code,#authenticated?,#authentication,#authorize_url,#basic_authed?,#client,#get_token

Constructor Details

This class inherits a constructor fromGithub::API

Dynamic Method Handling

This class handles dynamic methods through themethod_missing method in the classGithub::API

Instance Method Details

#create(*args) ⇒Object

Create a reference

Examples:

github=Github.newgithub.git_data.references.create'user-name','repo-name',ref:"refs/heads/master",sha:"827efc6d56897b048c772eb4087f854f46256132"

Parameters:

85868788899091929394
# File 'lib/github_api/client/git_data/references.rb', line 85defcreate(*args)arguments(args,required:[:user,:repo])dopermitVALID_REF_PARAM_NAMESassert_requiredREQUIRED_REF_PARAMSendparams=arguments.paramsvalidate_referenceparams['ref']post_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs",params)end

#delete(*args) ⇒ObjectAlso known as:remove

Delete a reference

Examples:

github=Github.newgithub.git_data.references.delete'user-name','repo-name',"heads/master"
130131132133134135
# File 'lib/github_api/client/git_data/references.rb', line 130defdelete(*args)arguments(args,required:[:user,:repo,:ref])params=arguments.paramsdelete_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}",params)end

#get(*args) ⇒ObjectAlso known as:find

Get a reference

The ref in the URL must be formatted asheads/branch, not just branch. For example, the call to get the data for a branch named sc/featureA would be formatted as heads/sc/featureA

Examples:

github=Github.newgithub.git_data.references.get'user-name','repo-name','heads/branch'
59606162636465
# File 'lib/github_api/client/git_data/references.rb', line 59defget(*args)arguments(args,required:[:user,:repo,:ref])validate_referencearguments.refparams=arguments.paramsget_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}",params)end

#list(*args) ⇒ObjectAlso known as:all

Get all references

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 the namespace, not justheads andtags, though that would be the most common.

Examples:

github=Github.newgithub.git_data.references.list'user-name','repo-name'
github.git_data.references.list'user-name','repo-name',ref:'tags'
313233343536373839404142434445
# File 'lib/github_api/client/git_data/references.rb', line 31deflist(*args)arguments(args,required:[:user,:repo])params=arguments.paramsuser=arguments.userrepo=arguments.reporesponse=if(ref=params.delete('ref'))formatted_ref=validate_referencerefget_request("/repos/#{user}/#{repo}/git/#{formatted_ref}",params)elseget_request("/repos/#{user}/#{repo}/git/refs",params)endreturnresponseunlessblock_given?response.each{|el|yieldel}end

#update(*args) ⇒Object

Update a reference

Examples:

github=Github.newgithub.git_data.references.update'user-name','repo-name','heads/master',sha:"827efc6d56897b048c772eb4087f854f46256132",force:true

Parameters:

113114115116117118119120
# File 'lib/github_api/client/git_data/references.rb', line 113defupdate(*args)arguments(args,required:[:user,:repo,:ref])dopermitVALID_REF_PARAM_NAMESassert_required%w[sha]endpatch_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}",arguments.params)end
Generated on Mon Dec 1 07:19:47 2025 byyard 0.9.37 (ruby-3.4.3).
[8]ページ先頭
©2009-2025 Movatter.jp