Improve OpenAPI schema coverage #3629
Merged
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
vadimkerr
added
pr:no public docs
vadimkerr
commented
Jan 10, 2024
| @@ -54,101 +58,62 @@ def get_user_queryset(request): | |||
| return User.objects.filter(organization=request.user.organization).distinct() | |||
|
|
|||
|
|
|||
| class AlertGroupFilterBackend(filters.DjangoFilterBackend): | |||
There was a problem hiding this comment.
Removing this as it doesn't work (the number of SQL queries is the same without this code)
| class AlertGroupFilter(DateRangeFilterMixin, ModelFieldFilterMixin, filters.FilterSet): | ||
| """ | ||
| Examples of possible date formats here https://docs.djangoproject.com/en/1.9/ref/settings/#datetime-input-formats | ||
| """ | ||
|
|
||
| FILTER_BY_INVOLVED_USERS_ALERT_GROUPS_CUTOFF = 1000 | ||
|
|
||
| started_at_gte = filters.DateTimeFilter(field_name="started_at", lookup_expr="gte") |
There was a problem hiding this comment.
Removing outdated fields:
started_at_gtestarted_at_lteresolved_at_gteresolved_at_lteid__in
Comment on lines
-140
to
-152
| class Meta: | ||
| model = AlertGroup | ||
| fields = [ | ||
| "id__in", | ||
| "started_at_gte", | ||
| "started_at_lte", | ||
| "resolved_at_lte", | ||
| "is_root", | ||
| "resolved_by", | ||
| "acknowledged_by", | ||
| ] | ||
|
|
There was a problem hiding this comment.
this is not needed, the filters work the same way without this
| @@ -305,15 +268,12 @@ class AlertGroupView( | |||
| "preview_template": [RBACPermission.Permissions.INTEGRATIONS_TEST], | |||
| } | |||
|
|
|||
| http_method_names = ["get", "post", "delete"] | |||
| @action(methods=["get"], detail=False) | ||
| def filters(self, request): | ||
| """ | ||
| Retrieve a list of valid filter options that can be used to filter alert groups | ||
| """ | ||
| filter_name = request.query_params.get("search", None) |
There was a problem hiding this comment.
this is outdated/not used by API clients
| @action(methods=["get"], detail=False) | ||
| def filters(self, request): | ||
| organization = self.request.auth.organization | ||
| filter_name = request.query_params.get("search", None) |
There was a problem hiding this comment.
this is outdated/not used by API clients
There was a problem hiding this comment.
simplifying paginators + adding schema for them
…into vadimkerr/openapi-improvements
# Conflicts: # engine/apps/api/views/user.py
mderynck
approved these changes
Jan 11, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
iskhakov
pushed a commit
that referenced
this pull request
Feb 20, 2024
Improves OpenAPI schema coverage for internal API: - Fixes/Improves `alert group` and `feature` endpoints - Adds `integration` and `user` endpoints #3444 - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
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.
What this PR does
Improves OpenAPI schema coverage for internal API:
alert groupandfeatureendpointsintegrationanduserendpointsWhich issue(s) this PR fixes
#3444
Checklist
pr:no public docsPR label added if not required)CHANGELOG.mdupdated (orpr:no changelogPR label added if not required)