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

Apiv2 #1128

Merged
merged 50 commits into from
Nov 14, 2024
Merged

Apiv2 #1128

merged 50 commits into from
Nov 14, 2024

Conversation

jessevz
Copy link
Contributor

@jessevz jessevz commented Nov 13, 2024

APIv2 changes to adhere to JSON API standard version 1.1.

resolves #1018 #993 #733 #923

Rick van der Zwet and others added 30 commits October 25, 2023 20:11
JSON:API responses can be potentially be quite large, especially
since no minification to the JSON output is performed.

Adding deflate compression with reduce transfer sizes.
Focus on  working on Users, GlobalPermissionGroups and AccessGroups
…i-standard' into feature/1018-convert-homebrew-apiv2-interface-to-jsonapi-standard
Rename to reflect new naming (include)
It is confusing to mix expand with include. Thus rename all
 variables in  python test code from expand to include.
The hashtopolis.py cannot be debugged with default Interactive
debugging of VScode debugging of pytests.

Thus make a small workaround based of the idea:
https://stackoverflow.com/questions/62419998/how-can-i-get-pytest-to-not-catch-exceptions/62563106#62563106
Should be 404, how-ever this trow was not captured, due to incorrect ordering.
- PATCH/DELETE requires mapping to new format.
- Helpers need some thinking on request/response.
- Relation updates needs to be implemented.
When creating an object the ER relations are sent via JSON:API
how-ever without an formal definition, there is no way of knowing
whether something is considered an relation.
Add PoC conversion using Django tooling for reference purposes.
This could be used as base for creating objects within the python libary
(also to do some client-side checking as well).
- Updated pagination parameters from 'page[after]' and 'page[size]' to 'page[offset] and 'page[limit']
- This change aligns with the JSON:API specification for pagination (https://jsonapi.org/format/#fetching-pagination)
-changed 'page[after]' and 'page[size] to 'page[offset]' and
'page[limit]'  in the link objects
@gluafamichl
Copy link
Contributor

Like discussed, I will just merge this PR and we will start reviewing and testing the new API on our local machines.

@gluafamichl gluafamichl merged commit 64d1a1b into hashtopolis:dev Nov 14, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants