Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

autogenerate API documentation #479

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

Merged
sliverc merged 46 commits into django-json-api:master from n2ygk:sphinx-apidoc
Sep 20, 2018
Merged
Changes from 1 commit
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
7b29f36
initial integration of JSONAPIDjangoFilter
n2ygk Aug 23, 2018
dc5ca38
documentation, isort, flake8
n2ygk Aug 24, 2018
6b0dc8c
Forgot to add django_filters to installed_apps
n2ygk Aug 24, 2018
d4fbf24
backwards compatibility for py27 + django-filter
n2ygk Aug 24, 2018
d86d217
handle optional django-filter package
n2ygk Aug 24, 2018
83c4cc0
fix travis to match new TOXENVs due to django-filter
n2ygk Aug 24, 2018
f5792c1
fixed a typo
n2ygk Aug 24, 2018
cbc9d55
add a warning if django-filter is missing and JSONAPIDjangoFilter is ...
n2ygk Aug 25, 2018
2f6ba1d
JSONAPIQueryValidationFilter implementation
n2ygk Aug 27, 2018
4f2b75b
improve filter_regex
n2ygk Aug 28, 2018
48b4c51
Merge branch 'JSONAPIDjangoFilter' into JSONAPIQueryValidationFilter
n2ygk Aug 28, 2018
2742d60
rename tests from filter to param
n2ygk Aug 29, 2018
6a8d7ae
easy changes recommended by @sliverc review
n2ygk Aug 29, 2018
db9e1f9
resolve @sliverc review method of using optional django-filter.
n2ygk Aug 29, 2018
68f5e02
Merge branch 'JSONAPIDjangoFilter' into JSONAPIQueryValidationFilter
n2ygk Aug 30, 2018
9eec004
initial attempt at sphinx-apidoc
n2ygk Sep 14, 2018
1475643
each module on a separate page and force overwrite of autogenerated a...
n2ygk Sep 15, 2018
eb486cd
move documentation from api.md into appropriate module docstrings
n2ygk Sep 15, 2018
a475425
minor reStructuredText tweaks to docstrings for sphinx-apidoc
n2ygk Sep 15, 2018
211577c
docs/apidoc needs to be in the repo
n2ygk Sep 15, 2018
6378985
rst tweaks for sphinx
n2ygk Sep 15, 2018
f0bdbd4
Merge branch 'master' into JSONAPIQueryValidationFilter
n2ygk Sep 17, 2018
64d4af0
remove JSONAPI prefix per #471
n2ygk Sep 17, 2018
23616a2
inadvertently removed when merging master
n2ygk Sep 17, 2018
2c476d9
add QueryValidation filter to NonPaginatedEntryViewset to avoid break...
n2ygk Sep 17, 2018
9b5ab9d
flake8
n2ygk Sep 17, 2018
dbd3d32
100% test coverage for QueryParamaterValidationFilter
n2ygk Sep 17, 2018
11aaf06
move QueryValidationFilter earlier and document how to extend query_r...
n2ygk Sep 17, 2018
57e95cc
QueryValidationFilter to README
n2ygk Sep 17, 2018
a22ca21
py2.7 fix for a non-ASCII quotation mark
n2ygk Sep 17, 2018
0252096
ugh I added back this junk file by mistake again
n2ygk Sep 17, 2018
e43e641
Merge branch 'JSONAPIQueryValidationFilter' into sphinx-apidoc
n2ygk Sep 17, 2018
642b2e0
merge in QueryValidationFilter
n2ygk Sep 17, 2018
7880bdb
run sphinx-autodoc as part of the RTD sphinx-build
n2ygk Sep 17, 2018
b8b5a78
change member order to bysource
n2ygk Sep 17, 2018
b6eb33c
don't inherit missing docstrings
n2ygk Sep 17, 2018
6c653fb
reST touchups
n2ygk Sep 17, 2018
9e715fa
Change "invalid filter" to "invalid query parameter" for malformed fi...
n2ygk Sep 18, 2018
af10543
renamed to QueryParameterValidationFilter to be clear that this is qu...
n2ygk Sep 18, 2018
c928d72
clearer language
n2ygk Sep 18, 2018
6e008ad
flake8 line length after renaming the class
n2ygk Sep 18, 2018
08518ac
Merge branch 'JSONAPIQueryValidationFilter' into sphinx-apidoc
n2ygk Sep 18, 2018
fc7d4f2
changelog
n2ygk Sep 18, 2018
8ad9bf5
Merge branch 'master' into sphinx-apidoc
n2ygk Sep 19, 2018
1427b5a
refactor filters subpackage into a single module to be consistent wit...
n2ygk Sep 19, 2018
0ac6c25
`autodoc_inherit_docstrings = False` fixes unwanted inherited docstri...
n2ygk Sep 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
py2.7 fix for a non-ASCII quotation mark
  • Loading branch information
n2ygk committed Sep 17, 2018
commit a22ca217340eab5b307bb31cc206d003e7d0e95f
2 changes: 1 addition & 1 deletion rest_framework_json_api/filters/queryvalidation.py
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class QueryValidationFilter(BaseFilterBackend):
If you want to add some additional non-standard query parameters,
simply override `.query_regex` adding the new parameters but, "with the additional
requirement that they MUST contain contain at least one non a-z character (U+0061 to U+007A).
It is RECOMMENDED that a U+002D HYPHEN-MINUS, "-", U+005F LOW LINE, "_", or capital letter is
It is RECOMMENDED that a U+002D HYPHEN-MINUS, "-", U+005F LOW LINE, "_", or capital letter is
used (e.g. camelCasing)." -- http://jsonapi.org/format/#query-parameters
"""
#: compiled regex that matches the allowed http://jsonapi.org/format/#query-parameters
Expand Down

AltStyle によって変換されたページ (->オリジナル) /