Remove the v1 API #5293

davidfischer · 2019-02-14T20:53:22Z

Remove the v1 API
No longer rely on tastypie

Open questions

~~The embed API is still under /api/v1/embed/. This does not remove that. Perhaps that endpoint should be moved or mirrored under /api/v2? The embed API does not use tastypie.~~ Update: Moved to /api/v2/embed/...

stsewd · 2019-02-18T17:01:55Z

Shouldn't we at least left the docs page with a warning explaining that v1 was completely removed? Maybe linking to the post or redirect to v2/v3?

stsewd · 2019-02-18T17:15:59Z

The embed API is still under /api/v1/embed/. This does not remove that. Perhaps that endpoint should be moved or mirrored under /api/v2? The embed API does not use tastypie.

There are some discussions about that in #5207 and #2667 (comment)

davidfischer · 2019-02-18T22:13:23Z

Shouldn't we at least left the docs page with a warning explaining that v1 was completely removed? Maybe linking to the post or redirect to v2/v3?

I'm not opposed to leaving the v1 doc and putting a large note there that it has been removed. It also should not be in the toctree.

davidfischer · 2019-02-18T22:14:38Z

At the same time, I'm not sure the v1 docs are that useful. After this PR, they won't work at all.

ericholscher

At the same time, I'm not sure the v1 docs are that useful. After this PR, they won't work at all.

I think it's worth keeping the v1.rst around with a note that it's been removed. We don't need the old content, but it shouldn't just "disappear".

The embed API is still under /api/v1/embed/. This does not remove that. Perhaps that endpoint should be moved or mirrored under /api/v2? The embed API does not use tastypie.

I'm 👍 on moving it to v2. Seems simple enough, but probably another PR.

Deployment

I do wonder about rolling this out slowly, if we can. Perhaps doing a brownout of these API's at the Nginx level for a day, then a week; similar to what GH did for webhooks. That would give anyone still depending on it time to migrate before we totally kill it.

ericholscher · 2019-02-19T15:18:45Z

readthedocs/projects/management/commands/import_project_from_live.py

@@ -1,72 +0,0 @@
-# -*- coding: utf-8 -*-


I still use this helper. I think it should be pretty simple to adopt it to v2.

ha, I use it too :(

Yes. This command is useful when debugging production projects locally.

I'd like to find a way to keep it.

I'll update this with an adapted version using the v2 API.

We can do it in another PR, tho :)

Nah, I think it isn't too onerous... Also, that way the single PR has the full set of changes.

I re-added this although there are some changes. The biggest one is that in order to get all the fields from an API response, the request needs to be authenticated and the user must be staff (See this). One key field that is only returned with the ProjectAdminSerializer is the requirements_file.

By default, the management command will be unauthenticated. However, if you have READ_THE_DOCS_USERNAME and READ_THE_DOCS_PASSWORD in your environment variables when you execute the management command, they'll be used.

- This is not publicly linked - It mentions that the API has been removed

davidfischer · 2019-02-19T23:16:56Z

I do wonder about rolling this out slowly, if we can. Perhaps doing a brownout of these API's at the Nginx level for a day, then a week; similar to what GH did for webhooks. That would give anyone still depending on it time to migrate before we totally kill it.

I think this is a good idea.

davidfischer · 2019-02-19T23:37:27Z

I think it's worth keeping the v1.rst around with a note that it's been removed. We don't need the old content, but it shouldn't just "disappear".

I re-added the page although it's blank except for noting that the API has been removed. I think that's good in case people have links to the API or whatnot but I think the content of the page ceases to have value once the API is turned off.

davidfischer · 2019-02-19T23:40:49Z

Also, the embed API has now been mirrored to https://readthedocs.org/api/v2/embed/.

humitos

Changes are good.

I like the idea of temporarily and gradually kill the APIv1.
I'd like to rewrite the management command that uses APIv1 to use APIv2. I think this is possible now that we have the ?project__slug filter on some endpoints.

humitos · 2019-02-21T10:19:47Z

readthedocs/projects/management/commands/import_project_from_live.py

            )

            for attribute in project_data:
                if attribute not in exclude_attributes:
                    setattr(project, attribute, project_data[attribute])
+                    self.stdout.write(' - Setting {key} to {val}'.format(
+                        key=attribute,
+                        val=project_data[attribute]),


This one is a nice improvement!

humitos · 2019-02-21T10:22:57Z

readthedocs/projects/management/commands/import_project_from_live.py

        user1 = User.objects.filter(pk__gt=0).order_by('pk').first()

+        if 'READ_THE_DOCS_USERNAME' in os.environ and 'READ_THE_DOCS_PASSWORD' in os.environ:


I have a personal preference for READTHEDOCS_USERNAME (to follow the same pattern from https://docs.readthedocs.io/en/latest/builds.html#build-environment).

I think that's pretty reasonable to stay consistent.

davidfischer · 2019-02-21T16:58:03Z

docs/api/index.rst

-    Originally, the Read the Docs API allowed connections over insecure HTTP.
-    Starting in January 2019, requests over HTTP
-    will be automatically redirected to HTTPS
-    and non-GET/HEAD requests over insecure HTTP will fail.


I removed this while I was here, but technically this change is not due to API v1 but rather due to https://github.com/rtfd/readthedocs-ops/pull/461.

stsewd · 2019-03-04T22:48:08Z

Looks like we can remove more dependencies here

https://github.com/rtfd/readthedocs.org/pull/5389/files#r262275644

stsewd · 2019-03-04T22:53:46Z

And guessing that we can remove some dependencies from the installation guide

https://github.com/rtfd/readthedocs.org/blob/master/docs/install.rst#L41-L42

davidfischer · 2019-03-12T21:36:37Z

We've been returning failures for API v1 for over a week and I haven't heard anything. I think this is ok to go. I'll see if I can remove those deps.

davidfischer · 2019-03-12T21:57:33Z

I'll see if I can remove those deps.

lxml is required by pyquery but I'll update the comments and move it to a more appropriate spot in the requirements file.

davidfischer · 2019-03-12T21:58:36Z

I should also add that while defusedxml is not strictly required, I think that we should install defusedxml as long as lxml is used. DefusedXML is a library that attempts to mitigate or remove XML parsing vulnerabilities and in many cases it monkeypatches other libraries.

stsewd

I'm dying to see our coverage after this :)

humitos

Looks good! Thanks David for taking care of this ;)

Remove the v1 API

2d3af1f

davidfischer requested a review from a team February 14, 2019 20:53

Remove tastypie from settings

67b7223

humitos mentioned this pull request Feb 18, 2019

Design APIv3 #4286

Closed

ericholscher reviewed Feb 19, 2019

View reviewed changes

Re-add API v1 docs

15aa854

- This is not publicly linked - It mentions that the API has been removed

ericholscher mentioned this pull request Feb 20, 2019

Move this to rtfd org agjohnson/readthedocs-client-js#3

Open

humitos reviewed Feb 20, 2019

View reviewed changes

Re-add the management command for importing via API

1094e78

humitos previously approved these changes Feb 21, 2019

View reviewed changes

humitos reviewed Feb 21, 2019

View reviewed changes

Consistency in the environment variables

8f2b320

davidfischer dismissed humitos’s stale review via 8f2b320 February 21, 2019 16:57

davidfischer commented Feb 21, 2019

View reviewed changes

stsewd mentioned this pull request Mar 4, 2019

Removed un-needed python dependencies #5389

Merged

Merge branch 'master' into davidfischer/remove-apiv1

9927925

Update requirements and comments for lxml

c99b06d

stsewd approved these changes Mar 12, 2019

View reviewed changes

humitos approved these changes Mar 13, 2019

View reviewed changes

humitos merged commit 54397a0 into master Mar 13, 2019

delete-merged-branch bot deleted the davidfischer/remove-apiv1 branch March 13, 2019 16:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove the v1 API #5293

Remove the v1 API #5293

davidfischer commented Feb 14, 2019 •

edited

Loading

stsewd commented Feb 18, 2019

stsewd commented Feb 18, 2019

davidfischer commented Feb 18, 2019

davidfischer commented Feb 18, 2019

ericholscher left a comment

ericholscher Feb 19, 2019

stsewd Feb 19, 2019

humitos Feb 20, 2019

davidfischer Feb 20, 2019

stsewd Feb 20, 2019

davidfischer Feb 20, 2019

davidfischer Feb 21, 2019

davidfischer commented Feb 19, 2019

davidfischer commented Feb 19, 2019

davidfischer commented Feb 19, 2019

humitos left a comment

humitos Feb 21, 2019

humitos Feb 21, 2019

davidfischer Feb 21, 2019

davidfischer Feb 21, 2019

stsewd commented Mar 4, 2019

stsewd commented Mar 4, 2019

davidfischer commented Mar 12, 2019

davidfischer commented Mar 12, 2019

davidfischer commented Mar 12, 2019

stsewd left a comment

humitos left a comment

		user1 = User.objects.filter(pk__gt=0).order_by('pk').first()

		if 'READ_THE_DOCS_USERNAME' in os.environ and 'READ_THE_DOCS_PASSWORD' in os.environ:

Remove the v1 API #5293

Remove the v1 API #5293

Conversation

davidfischer commented Feb 14, 2019 • edited Loading

Open questions

stsewd commented Feb 18, 2019

stsewd commented Feb 18, 2019

davidfischer commented Feb 18, 2019

davidfischer commented Feb 18, 2019

ericholscher left a comment

Choose a reason for hiding this comment

Deployment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidfischer commented Feb 19, 2019

davidfischer commented Feb 19, 2019

davidfischer commented Feb 19, 2019

humitos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stsewd commented Mar 4, 2019

stsewd commented Mar 4, 2019

davidfischer commented Mar 12, 2019

davidfischer commented Mar 12, 2019

davidfischer commented Mar 12, 2019

stsewd left a comment

Choose a reason for hiding this comment

humitos left a comment

Choose a reason for hiding this comment

davidfischer commented Feb 14, 2019 •

edited

Loading