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

Maintain compatibility in export APIs #1643

Merged

Conversation

dchiller
Copy link
Contributor

@dchiller dchiller commented Oct 1, 2024

In updating our source and institution identification scheme and in changing "office" to "service" on chants, we made a number of changes to keys in APIs used by external applications. These changes are reversed here so as not to cause issues with those services.

We can discuss whether making changes to the external APIs should proceed -- I do want to avoid breaking something on Cantus Index without giving time for relevant changes to occur there.

Also fixes a variety of typing issues in views/api.py and does some refactoring.

Closes #1641. Closes #1638.

The addition of the institution model and the change from office to
service introduced changes in external APIs (the JSON CID export, 
the JSON melody export, and the cached concordances command).
This commit rolls back those changes to maintain compatibility. 
The modifications may be reintroduced at a later date if notice is given 
to external users (in particular, Cantus Index).

Also simplifies the logic and adjusts the typing of functions related to the
JSON melody export and the AJAX melody list views to address DDMAL#1638.

Makes relevant changes to associated tests.

Fixes additional type errors in views/api.py.

Refs DDMAL#1641.
@dchiller dchiller merged commit 9282e98 into DDMAL:develop Oct 4, 2024
1 check passed
@dchiller dchiller deleted the i1641-fix-external-api-compatability branch October 4, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants