feat(incidents): implement models and client for /incidents/secrets/ #115
Conversation
This file contains 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
fnareoh
force-pushed
the
garancegourdel/scrt-4759-optimize-files-to-scan-on-merge-commits
branch
from
ccd992f to
4b05ac9
Compare
agateau-gg
requested changes
Aug 26, 2024
tests/test_models.py
Outdated
| if callable(schema_klass): | ||
| schema = schema_klass() | ||
| else: | ||
| schema = schema_klass |
There was a problem hiding this comment.
There is some kind of undocumented standard to declare our models and their schema. It looks like this:
@dataclass
class Foo(Base, FromDictMixin):
# fields
FooSchema = cast(
Type[BaseSchema], marshmallow_dataclass.class_schema(Foo, BaseSchema)
)
Foo.SCHEMA = FooSchema()If you do this for the schemas you are testing here, you won't need these changes and the code will be a little more consistent.
There was a problem hiding this comment.
Hum I was not entirely sure I understood your suggestion but I think successfully applied it ? 😅
changelog.d/20240823_170420_fnareoh_scrt_4759_optimize_files_to_scan_on_merge_commits.md
Outdated
Show resolved
Hide resolved
pygitguardian/client.py
Outdated
| retrieve_secret_incident handles the /incidents/secret/{incident_id} endpoint of the API | ||
|
|
||
| :param incident_id: incident id | ||
| :param with_occurrences: number of occurrences of the incident to retrieve (default 0) |
There was a problem hiding this comment.
Can you clarify whether 0 means no occurrences are retrieved or if it means the server uses its own default value?
There was a problem hiding this comment.
I had put 0 when I didn't think we wanted occurrences but I meant to change this default to 20 (which is the default of the API), done now.
fnareoh
force-pushed
the
garancegourdel/scrt-4759-optimize-files-to-scan-on-merge-commits
branch
from
4b05ac9 to
91cd3f8
Compare
fnareoh
force-pushed
the
garancegourdel/scrt-4759-optimize-files-to-scan-on-merge-commits
branch
from
91cd3f8 to
dce0ec3
Compare
agateau-gg
approved these changes
Aug 28, 2024
agateau-gg
deleted the
garancegourdel/scrt-4759-optimize-files-to-scan-on-merge-commits
branch
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.
Implement this endpoint to later display more information in ggshield.
After discussion with Aurélien, we chose to use Litteral when string values are known to be part of limited number of options. We chose not to use Enum in order not to be too restrictive and risk breaking change when a new return value is added in the API.