Skip to content
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

publish api endpoints #77179

Merged
merged 5 commits into from
Sep 13, 2024
Merged

publish api endpoints #77179

merged 5 commits into from
Sep 13, 2024

Conversation

@nhsiehgit nhsiehgit marked this pull request as ready for review September 9, 2024 19:40
@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Sep 9, 2024
def get(self, request: Request, organization) -> Response:
"""
List your Teams In the Current Organization
List your Teams in the Current Organization
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring here ends up as the endpoint description, so it should just be one sentence for all the endpoints

}
owner = ApiOwner.ENTERPRISE

@extend_schema(
operation_id="List an Organization's Teams for user",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
operation_id="List an Organization's Teams for user",
operation_id="List a User's Teams for an Organization",

Return a list of the teams available to the authenticated session and
with the supplied organization. If the user is a super user, then all
teams within the organization are returned.
List your Teams in the Current Organization
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
List your Teams in the Current Organization
Returns a list of teams the user has access to in the specified organization.
Note that this endpoint is restricted to [user auth tokens](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens).

}
owner = ApiOwner.ENTERPRISE

@extend_schema(
operation_id="List an Organization's Members for Project",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
operation_id="List an Organization's Members for Project",
operation_id="List a Project's Organization Members",

def get(self, request: Request, project) -> Response:
"""
List your Members in the requested Project
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
List your Members in the requested Project
Returns a list of active organization member's that belong to any team assigned to the project.

Comment on lines 44 to 45
# Return a list of active organization members that belong to any team assigned
# to the queried project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Return a list of active organization members that belong to any team assigned
# to the queried project.

Copy link
Member

@schew2381 schew2381 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, just one small typo!

def get(self, request: Request, project) -> Response:
"""
Returns a list of active organization member's that belong to any team assigned to the project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops I had a typo

Suggested change
Returns a list of active organization member's that belong to any team assigned to the project.
Returns a list of active organization members that belong to any team assigned to the project.

@nhsiehgit nhsiehgit merged commit bb5dc59 into master Sep 13, 2024
49 of 50 checks passed
@nhsiehgit nhsiehgit deleted the nhsieh/publish_api_endpoints branch September 13, 2024 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Backend Automatically applied to PRs that change backend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants