Ship API v3 #6169

humitos · 2019-09-11T14:25:30Z

Remove message about contacting support to get early API v3 access
Remove all mentions to API v3 beta in the docs
Mark API v2 as deprecated
Add a note about where to get the access Token
~~Creates a Token each time a new User is created~~
Allow the user to Generate/Revoke the Token under their profile page
Standardize documentation (show only relevant fields when describing endpoints)
Remove half-baked docstrings from Browsable API
Remove not useful filters (Project, Version)
Leave documentation for relevant fields only

~~Before merging this PR (or deploy it), we need to run a Python command to create a Token per User.~~

* Remove message about contacting support to get early API v3 access * Remove all mentions to API v3 beta in the docs * Mark API v2 as deprecated * Add a note about where to get the access Token

davidfischer · 2019-09-11T16:26:39Z

Before merging this PR (or deploy it), we need to run a Python command to create a Token per User.

I gave this PR a short try and there was no way for users to create or revoke access tokens. That was fine for beta but I think for general use users need to be able to create and revoke them. If users can create their own access tokens, we don't need to create them for users and we can probably remove the signal too.

humitos · 2019-09-11T20:27:44Z

@davidfischer makes sense. I will make the changes to allow Create/Delete from the profile settings. Thanks!

humitos · 2019-09-11T21:41:20Z

@davidfischer I updated the PR with the ability to Generate/Revoke API Tokens under the profile page. Currently, it allows the user to have only one Token max. Let me know if you think this is the path to go forward.

Eventually, when we implement scope-based tokens, we will allow the user to manage more than one token at the same time.

stsewd

LGTM

readthedocs/profiles/views.py

humitos · 2019-09-12T16:35:47Z

We may decide what to return in subprojects endpoint before shipping this as "stable": #6157

I'm blocking this for now so we can think about the proper approach first.

Co-Authored-By: Santos Gallegos <[email protected]>

humitos · 2019-09-30T16:17:56Z

Before shipping it, I'd like to do a second pass review to all the code (we may want to remove some non-useful filters, for example) and documentation (maybe a refactor or cleaning).

Just mention relevant fields (not obvious ones) and status codes.

…humitos/ship-api-v3

humitos · 2019-10-08T16:19:37Z

Removing "Status: blocked" label and calling for a last review of @readthedocs/core team before merging. I'd like to have this deployed in the next deploy hopefully.

stsewd · 2019-10-08T16:20:49Z

@humitos we should resolve what to do around privacy levels first

stsewd · 2019-10-08T19:31:01Z

The docs for redirects don't mention what kind of redirects can be created, and also, not all redirects require a from or to urls

Some fields are not used. I'm brining some changes from readthedocs#6169 to avoid merge conflicts.

…humitos/ship-api-v3

…ocs.org into humitos/apiv3-remove-privacy-level

Remove privacy_level field from APIv3

- 405 when authenticated performing a GET. - 302 when un-athenticated performing a GET.

humitos · 2019-10-14T08:28:32Z

Blocked on #6275 for now. We should merge that one first.

stsewd

Some examples from the docs are still showing privacy_level in the response.

docs/api/v3.rst

Co-Authored-By: Santos Gallegos <[email protected]>

humitos · 2019-10-22T17:40:59Z

Some examples from the docs are still showing privacy_level in the response.

Can you point me to them? I'm not finding anyone.

It was removed by mistake. Probably while solving a merge conflict

…humitos/ship-api-v3

…ocs.org into humitos/ship-api-v3

stsewd · 2019-10-22T21:01:59Z

Can you point me to them? I'm not finding anyone.

Can't see them anymore, guess merging master was missing?

stsewd · 2019-10-22T21:03:50Z

Looks like the failing tests are not related to the esling thing, btw

Ship API v3

b65098c

* Remove message about contacting support to get early API v3 access * Remove all mentions to API v3 beta in the docs * Mark API v2 as deprecated * Add a note about where to get the access Token

humitos requested a review from a team September 11, 2019 14:25

humitos added 2 commits September 11, 2019 23:26

Allow users to generate/revoke API Tokens

79f7740

Test cases for list/create/delete API Tokens

6d8b6cd

humitos force-pushed the humitos/ship-api-v3 branch from 98a5451 to 6d8b6cd Compare September 11, 2019 21:40

Lint

2163fed

stsewd approved these changes Sep 12, 2019

View reviewed changes

readthedocs/profiles/views.py Show resolved Hide resolved

readthedocs/profiles/views.py Outdated Show resolved Hide resolved

humitos added the Status: blocked Issue is blocked on another issue label Sep 12, 2019

humitos and others added 2 commits September 12, 2019 18:36

Update readthedocs/profiles/views.py

4d65213

Co-Authored-By: Santos Gallegos <[email protected]>

Use one step deletion to revoke the token

630cf84

humitos added 8 commits October 1, 2019 13:36

Remove redundant documentation and make it cleaner

f7e168f

Just mention relevant fields (not obvious ones) and status codes.

Mention where to find the token in the root API URL

1bb3742

Add a tip mentioning that it's possible to browse the API

5ab0c5e

Remove Project docstring (shown in browseable API resource)

9678048

Remove unuseful (Project, Version) filters

192fe2f

Remove half-baked docs from the Browsable API and make it consistent

5fe990c

Build trigger response docs

67ac5e5

Better docs for version update

8e59cf5

humitos requested a review from a team October 1, 2019 12:15

humitos added 3 commits October 1, 2019 14:16

Fix same page link

e6f711d

Merge branch 'master' of github.com:readthedocs/readthedocs.org into …

536d0a2

…humitos/ship-api-v3

Remove duplicated references docs

995287f

humitos removed the Status: blocked Issue is blocked on another issue label Oct 8, 2019

stsewd added a commit to stsewd/readthedocs.org that referenced this pull request Oct 8, 2019

Update doccs version detail (api v3)

8d0489a

Some fields are not used. I'm brining some changes from readthedocs#6169 to avoid merge conflicts.

stsewd mentioned this pull request Oct 8, 2019

Update doccs version detail (api v3) #6259

Merged

humitos added 8 commits October 9, 2019 11:51

Update docs for different Redirect types

8c3caf8

Add more redirect creation via APIv3 tests

03f2d29

Merge branch 'master' of github.com:readthedocs/readthedocs.org into …

ffab3b2

…humitos/ship-api-v3

Merge branch 'master' of github.com:readthedocs/readthedocs.org into …

06d31f6

…humitos/ship-api-v3

Merge branch 'humitos/ship-api-v3' of github.com:readthedocs/readthed…

558e143

…ocs.org into humitos/apiv3-remove-privacy-level

Remove privacy_level field from APIv3 (#6257)

9eb8df8

Remove privacy_level field from APIv3

Valid status codes for privacy URL tests

e3e5d73

- 405 when authenticated performing a GET. - 302 when un-athenticated performing a GET.

Update APIv3 design document

7aa32ca

humitos added Status: blocked Issue is blocked on another issue and removed Status: blocked Issue is blocked on another issue labels Oct 14, 2019

stsewd reviewed Oct 22, 2019

View reviewed changes

docs/api/v3.rst Outdated Show resolved Hide resolved

docs/api/v3.rst Outdated Show resolved Hide resolved

docs/api/v3.rst Outdated Show resolved Hide resolved

docs/api/v3.rst Outdated Show resolved Hide resolved

docs/api/v3.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

9bb7cb2

Co-Authored-By: Santos Gallegos <[email protected]>

humitos added 3 commits October 22, 2019 19:42

Re-add "Subproject details" section in docs

6b88986

It was removed by mistake. Probably while solving a merge conflict

Merge branch 'master' of github.com:readthedocs/readthedocs.org into …

5a398d4

…humitos/ship-api-v3

Merge branch 'humitos/ship-api-v3' of github.com:readthedocs/readthed…

afcfbf7

…ocs.org into humitos/ship-api-v3

humitos requested a review from a team October 22, 2019 17:47

humitos mentioned this pull request Oct 22, 2019

Intregration with Dash #662

Closed

4 tasks

humitos added 2 commits October 22, 2019 23:23

Fix tests introduced in merge conflict

b7adaf6

Ignore linting in a method override

4c40669

stsewd approved these changes Oct 28, 2019

View reviewed changes

stsewd requested a review from a team October 28, 2019 18:48

humitos merged commit 4dc1aa0 into master Oct 30, 2019

humitos deleted the humitos/ship-api-v3 branch October 30, 2019 13:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ship API v3 #6169

Ship API v3 #6169

humitos commented Sep 11, 2019 •

edited

Loading

davidfischer commented Sep 11, 2019

humitos commented Sep 11, 2019

humitos commented Sep 11, 2019

stsewd left a comment

humitos commented Sep 12, 2019 •

edited

Loading

humitos commented Sep 30, 2019

humitos commented Oct 8, 2019

stsewd commented Oct 8, 2019

stsewd commented Oct 8, 2019

humitos commented Oct 14, 2019

stsewd left a comment

humitos commented Oct 22, 2019

stsewd commented Oct 22, 2019

stsewd commented Oct 22, 2019

Ship API v3 #6169

Ship API v3 #6169

Conversation

humitos commented Sep 11, 2019 • edited Loading

davidfischer commented Sep 11, 2019

humitos commented Sep 11, 2019

humitos commented Sep 11, 2019

stsewd left a comment

Choose a reason for hiding this comment

humitos commented Sep 12, 2019 • edited Loading

humitos commented Sep 30, 2019

humitos commented Oct 8, 2019

stsewd commented Oct 8, 2019

stsewd commented Oct 8, 2019

humitos commented Oct 14, 2019

stsewd left a comment

Choose a reason for hiding this comment

humitos commented Oct 22, 2019

stsewd commented Oct 22, 2019

stsewd commented Oct 22, 2019

humitos commented Sep 11, 2019 •

edited

Loading

humitos commented Sep 12, 2019 •

edited

Loading