Skip to content

Update documentation hyperlinks #448

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
merged 1 commit into from
Jul 25, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[unreleased]

* Add testing configuration to `REST_FRAMEWORK` configuration as described in [DRF](http://www.django-rest-framework.org/api-guide/testing/#configuration)
* Add testing configuration to `REST_FRAMEWORK` configuration as described in [DRF](https://www.django-rest-framework.org/api-guide/testing/#configuration)
* Add sorting configuration to `REST_FRAMEWORK` as defined in [json api spec](http://jsonapi.org/format/#fetching-sorting)
* Add `HyperlinkedRelatedField` and `SerializerMethodHyperlinkedRelatedField`. See [usage docs](docs/usage.md#related-fields)

Expand Down
15 changes: 11 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ JSON API and Django Rest Framework

.. image:: https://readthedocs.org/projects/django-rest-framework-json-api/badge/?version=latest
:alt: Read the docs
:target: http://django-rest-framework-json-api.readthedocs.org/
:target: https://django-rest-framework-json-api.readthedocs.org/

.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/django-json-api/django-rest-framework-json-api
Expand All @@ -19,7 +19,7 @@ Overview

**JSON API support for Django REST Framework**

* Documentation: http://django-rest-framework-json-api.readthedocs.org/
* Documentation: https://django-rest-framework-json-api.readthedocs.org/
* Format specification: http://jsonapi.org/format/


Expand Down Expand Up @@ -68,13 +68,20 @@ Goals

As a Django REST Framework JSON API (short DJA) we are trying to address following goals:

1. Support the [JSON API](http://jsonapi.org/) spec to compliance
2. Be as compatible with Django REST Framework as possible
1. Support the `JSON API`_ spec to compliance

2. Be as compatible with `Django REST Framework`_ as possible

e.g. issues in Django REST Framework should be fixed upstream and not worked around in DJA

3. Have sane defaults to be as easy to pick up as possible

4. Be solid and tested with good coverage

5. Be performant

.. _JSON API: http://jsonapi.org
.. _Django REST Framework: https://www.django-rest-framework.org/

------------
Requirements
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ REST_FRAMEWORK = {

### Pagination

DJA pagination is based on [DRF pagination](http://www.django-rest-framework.org/api-guide/pagination/).
DJA pagination is based on [DRF pagination](https://www.django-rest-framework.org/api-guide/pagination/).

When pagination is enabled, the renderer will return a `meta` object with
record count and a `links` object with the next, previous, first, and last links.
Expand Down
4 changes: 2 additions & 2 deletions rest_framework_json_api/pagination.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def __init__(self):
warnings.warn(
'PageNumberPagination is deprecated. Use JsonApiPageNumberPagination '
'or create custom pagination. See '
'http://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#pagination',
'https://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#pagination',
DeprecationWarning)
super(PageNumberPagination, self).__init__()

Expand All @@ -126,6 +126,6 @@ def __init__(self):
warnings.warn(
'LimitOffsetPagination is deprecated. Use JsonApiLimitOffsetPagination '
'or create custom pagination. See '
'http://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#pagination',
'https://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#pagination',
DeprecationWarning)
super(LimitOffsetPagination, self).__init__()