Feature: return errors for invalid post API queries #344
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
odesenfans
added a commit
that referenced
this pull request
Oct 17, 2022
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
odesenfans
added a commit
that referenced
this pull request
Oct 27, 2022
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
odesenfans
added a commit
that referenced
this pull request
Jan 9, 2023
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
odesenfans
added a commit
that referenced
this pull request
Mar 21, 2023
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
odesenfans
added a commit
that referenced
this pull request
Mar 21, 2023
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
This was referenced Apr 14, 2023
Merged
Merged
Closed
odesenfans
added a commit
that referenced
this pull request
Apr 24, 2023
Problem: the posts.json endpoint is too permissive and allows users
to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
* The "endDate" field is now considered as exclusive.
Moreover, a 422 error code will now be returned in the following
situations, where the previous implementation would simply return a 200:
* if an invalid item hash (=not a hexadecimal sha256, CIDv0 or CIDv1)
is specified in the "hashes" or "contentHashes" field.
* if the "endDate" field is lower than the "startDate" field.
* if "endDate" or "startDate" are negative.
* if pagination parameters ("page" and "pagination") are negative.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem: the posts.json endpoint is too permissive and allows users to specify invalid hashes, time filters, pagination, etc.
Solution: detect these cases and return a 422 error.
Replaced the validation code by a Pydantic model.
Breaking changes:
Moreover, a 422 error code will now be returned in the following situations, where the previous implementation would simply return a 200: