- Notifications
You must be signed in to change notification settings - Fork1.1k
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Looks good. I just noticed we're inconsistent with HTTP verbs in the deprecations list, but that's another issue. |
I don't think that's true prior to this PR. Is it? I'll comment inline in the diff with a suggestion for restoring consistency. |
| : Recommendation: Use [Releases API](/v3/repos/releases) instead. | ||
| 1. Method: DELETE /repos/:owner/:repo/downloads/:id | ||
| : Recommendation: Use [Releases API](/v3/repos/releases) instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
For consistency with the existing deprecations above, I recommend replacing these bottom two deprecations with this verb-less deprecation:
Method: /repos/:owner/:repo/downloads/:id: Recommendation: Use[Releases API](/v3/repos/releases) instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
On second thought, giventhe fact that the Downloads API might not survive for the life of API v3, and given the fact that this list ⬆️ is for things thatwill survive for the life of API v3, maybe we shouldn't include the Downloads API in this particular list at all. Perhaps the notice at the top of the Downloads API page is sufficient.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yeah, I think it makes most sense to leave these entries out of this list and modify the copy on the Downloads API page. Thanks, guys. ⚡
@jasonrudolph Yeah, you're right. I just saw |
| <div class="alert"> | ||
| <p> | ||
| The Downloads API (described below) is <a href="/v3/#deprecations">deprecated</a> | ||
| and is scheduled for removal in the next version of the API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The Downloads APImight not survive even that long. When we announced the deprecation last year (on December 11, 2012), we announced that the Downloads API would be removed in 90 days (i.e., in March 2013). We haven't yet removed it, but we will eventually. There's no guarantee that it will survive until the next version of the API. So, I recommend something like this:
Recommendation:
The Downloads API (described below) was <a href="https://github.com/blog/1302-goodbye-uploads">deprecated on December 11, 2012.</a>It will be removed at a future date.See deprecation discussion here:github/developer.github.com#389
The Downloads API was deprecated December 11, 2012. It may bedisabled before the next major version of the API.For this reason it makes more sense to exclude these methods fromthe Deprecations list, which lists functionality which will beremoved in the next major version of the API.The copy of the alert on the Downloads API page has been modifiedto be:The Downloads API (described below) was deprecated on December 11,2012. It will be removed at a future date. We recommend usingReleases instead.
TheDownloads API has been officially deprecated since we said "Goodbye, Uploads".
This adds documentation for that deprecation.
An alert has been added to the Downloads API page:
And the appropriate deprecations have been added to the Deprecations list:
Related to this, today I also updated theblog post announcing this deprecation, to change the originally planned "disabled in 90 days" to "disabled at a future date".