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

fix: set JSONRenderer as the DEFAULT_RENDERER_CLASSES #403

Merged
merged 2 commits into from
May 6, 2024
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
39 changes: 18 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,42 +1,38 @@
Part of `edX code`__.

__ http://code.edx.org/

edX Student Notes API |build-status|
====================================
####################################

This is a backend store for edX Student Notes.

Overview
--------
********

The edX Notes API is designed to be compatible with the `Annotator <http://annotatorjs.org/>`__.

Getting Started
---------------
***************

1. Install `ElasticSearch 7.8.0 <https://www.elastic.co/blog/elasticsearch-7-8-0-released>`__.

2. Install the requirements:

::
.. code-block:: bash

$ make develop
make develop

3. Create index and put mapping:

::
.. code-block:: bash

$ make create-index
make create-index

4. Run the server:

::
.. code-block:: bash

$ make run
make run

Configuration:
--------------
Configuration
*************

``CLIENT_ID`` - OAuth2 Client ID, which is to be found in ``aud`` field of IDTokens which authorize users

Expand All @@ -49,40 +45,41 @@ Configuration:
``ELASTICSEARCH_DSL['default']['hosts']`` - Your ElasticSearch host

Running Tests
-------------
*************

Run ``make validate`` install the requirements, run the tests, and run
lint.

How To Resync The Index
-----------------------
***********************

edX Notes Store uses `Django elasticsearch DSL <https://django-elasticsearch-dsl.readthedocs.io/>`_ which comes with several management commands.

Please read more about ``search_index`` management commands
`here <https://django-elasticsearch-dsl.readthedocs.io/en/latest/management.html>`_.

License
-------
*******

The code in this repository is licensed under version 3 of the AGPL unless
otherwise noted.

Please see ``LICENSE.txt`` for details.

How To Contribute
-----------------
*****************

Contributions are very welcome.

Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.

Reporting Security Issues
-------------------------
*************************

Please do not report security issues in public. Please email [email protected]

Mailing List and IRC Channel
----------------------------
****************************

You can discuss this code on the `edx-code Google Group`__ or in the
``edx-code`` IRC channel on Freenode.
Expand Down
1 change: 1 addition & 0 deletions notesserver/settings/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
'DEFAULT_AUTHENTICATION_CLASSES': ['rest_framework.authentication.SessionAuthentication'],
'DEFAULT_PERMISSION_CLASSES': ['notesapi.v1.permissions.HasAccessToken'],
'DEFAULT_PAGINATION_CLASS': 'notesapi.v1.paginators.NotesPaginator',
'DEFAULT_RENDERER_CLASSES': ('rest_framework.renderers.JSONRenderer',),
}

# CORS is configured to allow all origins because requests to the
Expand Down
Loading