implement get bulk report data in JSON Format (query) API endpoints and request/response models #45
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
…odels This: - add `BulkReportQueryEndPoint`, an endpoint class for handling specific bulk report query requests - add `BulkReportQueryParams` for serializing and validating request parameters - add `BulkReportQueryItem` and `BulkReportQueryResult` for deserializing and validating API responses - add `BulkFixedInfrastructureDataQueryEndPoint` for handling fixed infrastructure bulk report query requests - add `fixtures` and `unit tests` for `BulkReportQueryParams`, and `BulkFixedInfrastructureDataQueryEndPoint`
lykmapipo
requested review from
aperdizs,
giselamo,
rrequero,
tomaslink and
yaaNuamahGFW
lykmapipo
added
documentation
tomaslink
approved these changes
Dec 23, 2025
| The value to validate. | ||
| Returns: | ||
| Optional[datetime.datetime]: |
Collaborator
There was a problem hiding this comment.
The return type from the typehint is not he same as the one in the docstring.
An alternative to duplicate the types is just declare them in typehints but not in the docstrings (tools for autodocument the API should be able to pick them from typehints).
| """Initializes a new `FixedInfrastructureDataResult`. | ||
| Args: | ||
| data (List[FixedInfrastructureDataItem]): |
Collaborator
There was a problem hiding this comment.
Same here about the type.
| Additional keyword arguments. | ||
| Returns: | ||
| FixedInfrastructureDataResult: |
Collaborator
There was a problem hiding this comment.
Same here about the type
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This:
BulkReportQueryEndPoint, an endpoint class for handling specific bulk report query requests (i.e/bulk-reports/:id/query)BulkReportQueryParamsfor serializing and validating request parametersBulkReportQueryItemandBulkReportQueryResultfor deserializing and validating API responsesBulkFixedInfrastructureDataQueryEndPointfor handlingfixed infrastructure databulk report query requestsBulkFixedInfrastructureDataQueryItemandBulkFixedInfrastructureDataQueryResultfor deserializing and validatingfixed infrastructure dataAPI responsesquery_bulk_fixed_infrastructure_data_reportpublic methods to queryfixed infrastructure datafixturesandunit testsforBulkReportQueryParams,BulkFixedInfrastructureDataQueryItem,BulkFixedInfrastructureDataQueryResult,BulkFixedInfrastructureDataQueryEndPointandquery_bulk_fixed_infrastructure_data_report