getReference error with 404

[iamsk]

getReference error with 404

[iamsk]

 *  - 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.

[mikedeboer]

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?

[iamsk]

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;)

[mikedeboer]

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.

[mikedeboer]

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?

[iamsk]

I think getReference(or other related) has expressed the meaning of refs, so as before, just update the doc will be ok:)

[mikedeboer]

fixed in the docs. thanks for reporting this!