Skip to content

teamgroups api list and create team openapi spec#1204

Open
bking-do wants to merge 2 commits into
digitalocean:mainfrom
bking-do:teamgroups-create-and-list-teams-endpoints
Open

teamgroups api list and create team openapi spec#1204
bking-do wants to merge 2 commits into
digitalocean:mainfrom
bking-do:teamgroups-create-and-list-teams-endpoints

Conversation

@bking-do

Copy link
Copy Markdown

adds openapi spec for new teamgroup/organization endpoints

post:
$ref: "resources/organizations/organizations_create_team.yml"

/v2/organizations/teams:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The create path /v2/organizations/team is singular while the list path /v2/organizations/teams is plural. Can you confirm this matches the backend API?

$ref: "resources/organizations/organizations_create_team.yml"

/v2/organizations/teams:
get:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This list endpoint has no page/per_page params and the response doesn't use the standard allOf + shared/pages.yml#/pagination + shared/meta.yml pagination pattern. Is the collection intentionally unpaginated? If not, please add pagination for consistency with other list endpoints.

properties:
id:
type: integer
format: uint64

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If status and team_invitation.role have a fixed set of backend values, adding an enum (like team_invitation_status) would make the docs clearer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants