-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
chore(api): Update documentation for ProjectGroupIndexEndpoint
#101618
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
chore(api): Update documentation for ProjectGroupIndexEndpoint
#101618
Conversation
…`@extend_schema` decorator
|
|
||
| for path, endpoint in items: | ||
| if "{var}/{issue_id}" in path: | ||
| if "/{var}/" in path: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PUT /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/issues/ does not fit the "{var}/{issue_id}" pattern, so changing to be more general. I don't see any usages of "var" other than in the ISSUES_OR_GROUPS parameter.
| "PUT": ApiPublishStatus.EXPERIMENTAL, | ||
| "DELETE": ApiPublishStatus.PUBLIC, | ||
| "GET": ApiPublishStatus.PUBLIC, | ||
| "PUT": ApiPublishStatus.PUBLIC, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non-PUBLIC endpoints are filtered out in preprocessing for the OpenAPI generation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #101618 +/- ##
===========================================
+ Coverage 79.87% 80.98% +1.10%
===========================================
Files 8697 8703 +6
Lines 386780 387269 +489
Branches 24514 24514
===========================================
+ Hits 308958 313613 +4655
+ Misses 77474 73308 -4166
Partials 348 348 |
|
This pull request has gone three weeks without activity. In another week, I will close it. But! If you comment or otherwise update it, I will reset the clock, and if you add the label "A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀 |
Updates documentation for the
ProjectGroupIndexEndpoint(/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/issues/).GET (List a Project's Issues)
Before:

After:

PUT (Bulk Mutate a List of Issues)
Before:

After:

DELETE (Bulk Remove a List of Issues)
Before:

After:
