Comments (7)
* - refs (String): Required. 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.
I tested, this should be heads/master, not refs/heads/master, so, pls update this note.
from octokit.js.
How strange!! The docs clearly state that the refs
part is absolutely required: http://developer.github.com/v3/git/refs/ !
Do you have a reaction from the github devs that can make me feel sure that removing this from the docs is legit?
from octokit.js.
Maybe I didn't express clearly, I mean: when I set 'refs/heads/master' for key:ref, I opend the debug, and find: GET xxx/git/refs/refs/heads/master, I mean you have auto added refs in url or I make a fuss;)
from octokit.js.
Ah! I see what you mean now... in the api/v3.0.0/routes.json
file you can see the definition for this call:
"get-reference": {
"url": "/repos/:user/:repo/git/refs/:ref",
"method": "GET",
"params": {
"$user": null,
"$repo": null,
"$ref": null
}
},
You can see that the url is formatted like /repos/:user/:repo/git/refs/:ref
so if you remove refs
from the url, it'll be fine. I will update the documentation, as it makes more sense to specify the Git root instead of making you prepend refs/
in front of it.
from octokit.js.
or what do you think the best change to fix this should be? removing refs
from the url in the definition or removing it from the documentation?
from octokit.js.
I think getReference(or other related) has expressed the meaning of refs, so as before, just update the doc will be ok:)
from octokit.js.
fixed in the docs. thanks for reporting this!
from octokit.js.
Related Issues (20)
- [BUG]: Can't call the list users endpoint using an App instance HOT 2
- [BUG]: rest.packages.listPackagesForOrganization return 400 Invalid argument with package type 'container' HOT 2
- Any auth flow currently supported for SPA without backend? HOT 3
- [BUG]: Error authenticating API requests from Octokit JS client when using private key in Azure key vault HOT 4
- Web3 HOT 1
- [BUG]: Cannot create new commit with Octokit HOT 3
- Merge HOT 1
- [DOCS(readme)]: Missing Required Parameter `issue_number` in `issues.createComment ` HOT 2
- [BUG]: No Significant Difference with @octokit Submodules HOT 6
- [BUG]: Unable to get latest deployment for a workflow deployed to an environment HOT 1
- [FEAT]: notifications: filter done/undone HOT 2
- [BUG]: {"error":"Cannot read properties of undefined (reading 'getWebFlowAuthorizationUrl')"} HOT 1
- [BUG]: [@octokit/request-error] `error.code` is deprecated, use `error.status`. HOT 2
- [BUG]: CJS Loader "Unexpected token '{'" HOT 3
- [FEAT]: Do we have the CJS version? If not, are we considering supporting CJS? HOT 5
- Issues with Search REST API: Special Characters Handling HOT 1
- [BUG]: Octokit 4 can't be `import`ed or `require`d HOT 6
- [BUG]: Octokit v4 types HOT 8
- [BUG]: [Nestjs] [ERR_REQUIRE_ESM]: require() of ES Module not supported HOT 3
- @octokit/types is no longer available after 4.0.0 HOT 13
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from octokit.js.