Feature/make swagger json links browsable [OSF-6163] #6099

NyanHelsing · 2016-08-04T18:11:18Z

Purpose

Make any links in JSON responses in Swagger docks clickable.
Causes docs to open/scroll to the pertinent response.

Changes

Modify swagger-ui.js to make links in JSON clickable/browsable
Upgrade Swagger spec to 2.0 -- OpenAPI compatibility
CoreAPI compatibility
Upgrade DRF to 3.4
DRS to 2.0.4
update some OSF files to use unicode strings by default

Side effects

Swagger docs render two separate endpoints as if they were one;
node-file-list and node-file-detail as well as registration-file-list and registration-file-detail appear as though they were a single endpoint. This is due to the fact that the way django renders uritemplates from router regexes cannot account for certain aspects of regular expressions. Both file-list and file-detail are operable from the operation 'try it out' panel in the swagger docs.

Ticket

https://openscience.atlassian.net/browse/OSF-6163

Merge branch 'develop' of https://github.com/CenterForOpenScience/osf.io into feature/make-swagger-json-links-browsable

t Please enter the commit message for your changes. Lines starting

into feature/make-swagger-json-links-browsable

brianjgeiger · 2016-08-22T19:28:52Z

api/base/urls.py

@@ -19,8 +20,16 @@
                url(r'^applications/', include('api.applications.urls', namespace='applications')),
                url(r'^collections/', include('api.collections.urls', namespace='collections')),
                url(r'^comments/', include('api.comments.urls', namespace='comments')),
-                url(r'^docs/', include('rest_framework_swagger.urls')),
+                url(r'^nodes/', include('api.nodes.urls', namespace='nodes')),


See L12 and please keep this list alphabetized (unless the new version of DRS auto-alphabetizes regardless if this list order, in which remove L12).

DRS does alphabetize on the actual API -> Core api transition, though something weird happens between there and rendering on the documentation page.

Sorted out the alphabetization thing.

NyanHelsing · 2016-08-23T18:38:12Z

Not sure what I'm missing. All tests run fine locally... I think there's something I haven't committed somehow.

brianjgeiger · 2016-08-23T18:43:04Z

======================================================================
FAIL: test_get_absolute_url (tests.test_models.TestNode)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/travis/build/CenterForOpenScience/osf.io/tests/test_models.py", line 1625, in test_get_absolute_url
    .format(settings.API_DOMAIN, self.node._id)
AssertionError: 'http://localhost:8000/nodes/v5q9y/' != 'http://localhost:8000/v2/nodes/v5q9y/'

Did you change anything in there that you shouldn't have? Such as settings.API_DOMAIN? And are you running the api tests?

NyanHelsing · 2016-08-23T19:06:03Z

I do have API_DOMAIN set to something different, only in local.py defaults is set to localhost:8000, which seems correct.

Huh. api settings is different.

brianjgeiger · 2016-08-24T01:22:50Z

Based on the test failures, I'm guessing that the new version of DRF is causing problems. Did you invoke test_api or otherwise run the api tests?

…ithub.com/HalcyonChimera/osf.io into feature/make-swagger-json-links-browsable

… feature/make-swagger-json-links-browsable

brianjgeiger · 2016-08-31T20:18:10Z

api/nodes/urls.py

 from django.conf.urls import url

 from api.nodes import views
 from website import settings

+#nodeProviderDetailView = views.NodeProviderDetailView.as_view()


No commented out lines, please.

Not certain I remember what I was trying here...

brianjgeiger · 2016-08-31T20:25:12Z

What happens when the next version of django-rest-swagger or the swagger-ui comes out?

brianjgeiger · 2016-08-31T20:28:32Z

api_tests/base/test_root.py

            }
        )
        mock_auth.return_value = self.user, mock_cas_resp
-        res = self.app.get(self.url, headers={'Authorization': 'Bearer {}'.format(token.token_id)})
+        res = self.app.get(self.url, headers={'Authorization': str('Bearer {}'.format(token.token_id))})


What's the chain of event that lead to these changes? The need for unicode_literals? The new version of DRF?

The new version of DRF requires unicode rather than bytestrings, so it was easier to change strings to unicode strings with the import unicode literals. A few things need to be explicitly bytestrings, like the (context?) dicts that are created from the headers here.

brianjgeiger · 2016-08-31T20:36:49Z

Pass done. 🐧 Most stuff in this pass is simple, except for the one big question.

NyanHelsing · 2016-09-01T18:31:29Z

Regarding what happens when DRS and swagger-ui get updated; the code in swagger-ui just need to gets inserted at the right spot. The code inserted is contiguous, and should be able to be placed in one location. as long as too much doesn't change all should be fine. The codebase here (barring the swagger-ui js) is relatively small, so it's fairly straightforward to understand what they may have changed. the big difference in the new version of DRS was updating the version of the spec to openapi from swagger.

brianjgeiger · 2016-09-01T20:42:22Z

Part of why I ask about the swagger-ui is because:

So if you're adding the whole file plus the patch in one go, it's very difficult to see what's happening. When we talked at the beginning of the summer, you described this as a monkey-patch, which is generally a runtime patch rather than the whole file. If you haven't put your code directly into swagger-ui, then ideally it should be being brought in by another mechanism that doesn't involve a file put directly in /static/js/, and then you can patch that as a smaller diff?

If we have to maintain a modification to a static file, then we'll want to fork the repo and then make changes there, then import it with one build tool or another.

And if we have to be super careful about updating DRS / swagger-ui, it would be good to include a note next to where someone might do that update describing what would need to happen during that upgrade.

NyanHelsing · 2016-09-01T21:31:02Z

At the beginning of the summer this was a monkey patch, but this new version isn't as nice to play around with. I can fork swagger-ui.

brianjgeiger · 2016-10-04T13:57:16Z

It's Autumn Cleaning time, so I'm closing this PR. Feel free to re-open when development becomes active again.

NyanHelsing and others added 23 commits May 20, 2016 18:03

Set up links to raw json responses of links in json responses.(what)

effc3f3

Getting branch up to date

559694f

Merge branch 'develop' of https://github.com/CenterForOpenScience/osf.io into feature/make-swagger-json-links-browsable

saving changes

eee8ae2

Browsable json links!

14e677f

Tidy up JSON browsing script

808b9c4

Fix an issue with the way swagger (introspects?) one of the routes.

7755b3a

Fixes the way the node views interpret arguments embedded in the url

896c136

formatting link correctly for waterbutler

e9e9d8e

flake8 fixes

69fd94b

Update views.py

3fafac4

Forgot asterisks.

d9f3890

fixes

66741d5

fix merge conflict

abc4370

fix merge conflicts

2c73ff1

fix node arguments formatting

d642954

ng osf to unicode strings

d2ad2f7

t Please enter the commit message for your changes. Lines starting

Merge branch 'develop' of https://github.com/CenterForOpenScience/osf.io

5032f7a

into feature/make-swagger-json-links-browsable

fix flake8 errors

f462407

monkeypatch simplify_regex

c91f90c

fix flake8 errors

64095a6

define path_components array

ce77528

setting correct permissions for endpoints

2ff8bd6

fix whitespace

6b25d6a

brianjgeiger reviewed Aug 22, 2016
View reviewed changes

fix flake errors

6bd9fe1

updating to unicode, fix typo

b29e1ad

Joshua Bird and others added 13 commits August 25, 2016 23:10

relocating swagger-ui js file

2be2170

Wierd. git doesn't want to do the things...

1f07750

removing dead code

4c462a6

Merge branch 'feature/make-swagger-json-links-browsable' of https://g…

4eab556

…ithub.com/HalcyonChimera/osf.io into feature/make-swagger-json-links-browsable

fix tests

78279a9

endpoint categories are now sorted in swagger-ui.

ca3ab5b

debugging missing paths

7ce405a

Merge branch 'develop' of github.com:CenterForOpenScience/osf.io into…

5ae48ee

… feature/make-swagger-json-links-browsable

fix regex. fix api schema generation.

f20e453

fix flake8 stuff

392a4ac

Merge branch 'develop' of github.com:CenterForOpenScience/osf.io into…

f5cb930

… feature/make-swagger-json-links-browsable

Updating docs

21283c3

make model list alphabetical

18ff1aa

brianjgeiger reviewed Aug 31, 2016
View reviewed changes

Joshua Bird added 2 commits September 1, 2016 14:40

code cleanup

7a9664b

missing comma

c727d60

brianjgeiger closed this Oct 4, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/make swagger json links browsable [OSF-6163] #6099

Feature/make swagger json links browsable [OSF-6163] #6099

NyanHelsing commented Aug 4, 2016 •

edited

Loading

brianjgeiger Aug 22, 2016

NyanHelsing Aug 22, 2016

NyanHelsing Aug 31, 2016

NyanHelsing commented Aug 23, 2016 •

edited

Loading

brianjgeiger commented Aug 23, 2016

NyanHelsing commented Aug 23, 2016

brianjgeiger commented Aug 24, 2016

brianjgeiger Aug 31, 2016

NyanHelsing Aug 31, 2016

brianjgeiger commented Aug 31, 2016

brianjgeiger Aug 31, 2016

NyanHelsing Aug 31, 2016

brianjgeiger commented Aug 31, 2016

NyanHelsing commented Sep 1, 2016 •

edited

Loading

brianjgeiger commented Sep 1, 2016

NyanHelsing commented Sep 1, 2016

brianjgeiger commented Oct 4, 2016

Feature/make swagger json links browsable [OSF-6163] #6099

Feature/make swagger json links browsable [OSF-6163] #6099

Conversation

NyanHelsing commented Aug 4, 2016 • edited Loading

Purpose

Changes

Side effects

Ticket

brianjgeiger Aug 22, 2016

Choose a reason for hiding this comment

NyanHelsing Aug 22, 2016

Choose a reason for hiding this comment

NyanHelsing Aug 31, 2016

Choose a reason for hiding this comment

NyanHelsing commented Aug 23, 2016 • edited Loading

brianjgeiger commented Aug 23, 2016

NyanHelsing commented Aug 23, 2016

brianjgeiger commented Aug 24, 2016

brianjgeiger Aug 31, 2016

Choose a reason for hiding this comment

NyanHelsing Aug 31, 2016

Choose a reason for hiding this comment

brianjgeiger commented Aug 31, 2016

brianjgeiger Aug 31, 2016

Choose a reason for hiding this comment

NyanHelsing Aug 31, 2016

Choose a reason for hiding this comment

brianjgeiger commented Aug 31, 2016

NyanHelsing commented Sep 1, 2016 • edited Loading

brianjgeiger commented Sep 1, 2016

NyanHelsing commented Sep 1, 2016

brianjgeiger commented Oct 4, 2016

NyanHelsing commented Aug 4, 2016 •

edited

Loading

NyanHelsing commented Aug 23, 2016 •

edited

Loading

NyanHelsing commented Sep 1, 2016 •

edited

Loading