Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restrict doc & schema shortcuts to a subset of urls #4979

Merged
merged 5 commits into from Apr 27, 2017

Conversation

xordoquy
Copy link
Collaborator

@xordoquy xordoquy commented Mar 15, 2017

This change will help removing a lot of boilerplate code to restrict the documentation and schema to a single subset of urls:

doc_url_patterns = [
    url(r'^api/v1/', include('invoices.api.urls')),
]

urlpatterns = [
    url(r'^api/v1/docs/', include_docs_urls(title='My API title', patterns=doc_url_patterns)),
]

This will prove helpful when the site exposes different APIs.

closes #4751

@tomchristie
Copy link
Member

tomchristie commented Mar 17, 2017

Yup, makes sense. Let's get that into the docs too and then good to go 👍

@xordoquy
Copy link
Collaborator Author

xordoquy commented Mar 23, 2017

Seems it went a bit off radar.

@tomchristie
Copy link
Member

tomchristie commented Mar 24, 2017

Sure. Just needs including in docs then it's good to go. 👍

xordoquy added 4 commits Mar 24, 2017
…schema_shortcut

* reference/master:
  use django 1.11rc1 in tox
  Leave parameters with regex pattern as String
  restored original formatting
  Do not hint BigAutoField as integer (outside of range)
  Mention where the mixins live
  Try to improve browser support
  Cleanup and refactor docs api.js script
  Move bootstrap modal data attrs to anchor
  Remove unused base.js script
  Correctly set scheme in coreapi TokenAuthentication
  reverted to fix the issue without changing setting
  DEFAULT_PAGINATION_CLASS is changed to 'None'
  add content block and breadcrumbs_empty block to allow base.html to be reused
  Update 7-schemas-and-client-libraries.md
  Updated testimonial name on funding site
  ID must start from 1 again
…schema_shortcut

* reference/master: (22 commits)
  Clarify get_schema_fields signature
  Updated monthly report link on funding page
  Bumped django-guardian version.
  remove django 1.11 from allow_failure matrix
  update django 1.11 to stable release in tox
  Update existing vary headers in response instead of overwriting them.
  Update links after moving to encode org
  Use overridden settings exception handler
  Pass initkwargs stored on view to instance
  Update 7-schemas-and-client-libraries.md
  Update Boolean field to more closely match python library
  Fix parser names in docstring.
  Fix typo at docstring
  update test case
  update test case
  fix unique=True validation for ChoiceField
  Added drfpasswordless to Authentication docs
  Document adding django_filters to installed apps
  Added drfpasswordless to third party packages topic page.
  Added drfpasswordless to authentication topic page.
  ...
@xordoquy
Copy link
Collaborator Author

xordoquy commented Apr 19, 2017

PR updated with master and documentation included.

@tomchristie tomchristie merged commit aafd0a6 into encode:master Apr 27, 2017
1 check passed
@tomchristie
Copy link
Member

tomchristie commented Apr 27, 2017

Thanks @xordoquy & apologies for the delay!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants