Skip to content
This repository has been archived by the owner on Nov 1, 2017. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Announce plans to fix type value for submodules
Prior to 2013-04-30, you could not GET a submodule via the Repository
Contents API. (You could see the submodule listed when you GET the
directory that the submodule resides it, but you could not GET just the
submodule.) On 2013-04-30, we added the ability to GET a submodule.
(See 81c7e58.) When you GET a submodule, the "type" is returned as
"submodule".

Prior to 2013-04-30, when you listed the contents of a directory using
the Repository Contents API, the output included submodules, but it
returned the "type" as "file". The type *should* be "submodule". We are
leaving this behavior as is for v3, so as not to break any client code
that might depend on this behavior. In the next major version of the
API, the type will be returned as "submodule".
  • Loading branch information
jasonrudolph committed Apr 30, 2013
1 parent 81c7e58 commit 1b329b0
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions content/index.md
Expand Up @@ -46,6 +46,7 @@ objects.
* `[ ]` Use JSON to POST to the "repos/:owner/:repo/forks" endpoint, instead of a query string.
* `[✓]` <del>User Emails come back [as a hash][v3-email] instead of a string.</del>
* `[ ]` Remove the unused "bio" field for Users.
* `[ ]` When listing the contents of a directory in the [Repository Contents API](/v3/repos/contents/#get-contents), fix the `type` value returned for submodules: change the value to `"submodule"` (instead of `"file"`).

### Breaking Beta Changes

Expand Down

1 comment on commit 1b329b0

@robbo72
Copy link

@robbo72 robbo72 commented on 1b329b0 Nov 6, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.