Files

Kyle McCormick 36e5bd6b35 fix: delete ORA staff grader postman collection (#30704 )

This file was originally checked into
edx-platform so that other developers
could import it into Postman (https://postman.com)
in order to easily query the ORA staff grader API.

Unfortunately, it is very large (1.3 MB). This:
* slows down edx-platform shallow cloning,
* increases the minimum edx-platform image size,
* adds noise when text-searching the repo, and
* sets a precedent for other developers to
  check similar files into this repo.
This cost is not justifiable
for a closed-source 3rd-party developer tool.

2022-07-15 10:50:53 -04:00

mock

…

tests

feat: add text response type to ora config (#30721 )

2022-07-12 15:44:24 -04:00

__init__.py

…

constants.py

…

errors.py

feat: ESG logging updates (#29895 )

2022-02-11 13:56:25 -05:00

lms.postman_collection.json

…

ora_api.py

feat: add batch lock delete endpoint (#30161 )

2022-04-04 11:22:22 -04:00

README.md

…

serializers.py

feat: add text response type to ora config (#30721 )

2022-07-12 15:44:24 -04:00

urls.py

feat: get standalone file metadata (#30337 )

2022-05-02 14:18:18 -04:00

utils.py

feat: ESG logging updates (#29895 )

2022-02-11 13:56:25 -05:00

views.py

refactor!: update CourseWaffleFlag (#30351 )

2022-05-10 15:08:59 -04:00

README.md

Enhanced Staff Grader (ESG) App

A backend-for-frontend (BFF) for ESG. It provides endpoints at the path {lms-url}/api/ora_staff_grader/{endpoint}.

ESG is an application on top of Open Response Assessments (ORA) designed to simplify staff grading of assignments. The BFF is designed to service the ESG microfrontend (MFE) by aggregating and packaging requests to both edx-platform and edx-ora2.

The BFF includes both an API and mock API (/mock) for testing. Exercise either with the attached Postman collections (and included examples) or see Enhanced Staff Grader Data Flow Design for API reference.

Quickstart

Connect to or exercise endpoints at {lms-url}/api/ora_staff_grader/{endpoint}.

Alternatively, use the attached postman collections to perform headless testing of endpoints. Following the setup below:

Perform headless login: in lms.postman_collection.json perform the GET Login call to generate a new CSRF token followed by a POST Login with valid staff credentials to authenticate with LMS.
Configure needed envirionment variables including {{mock}} = False
Exercise endpoints: in ora_staff_grader.postman_collection.json