Skip to content

Latest commit

 

History

History
267 lines (156 loc) · 7.06 KB

TeamApi.md

File metadata and controls

267 lines (156 loc) · 7.06 KB
Raw

\TeamApi

All URIs are relative to http://localhost

Method HTTP request Description
TeamCreate Post /1.0/teams
TeamDelete Delete /1.0/teams/{team}
TeamGet Get /1.4/teams/{team}
TeamGroupList Get /1.17/teams/{team}/groups
TeamQuotaChange Put /1.12/teams/{team}/quota
TeamQuotaGet Get /1.12/teams/{team}/quota
TeamUpdate Put /1.6/teams/{team}
TeamUserList Get /1.17/teams/{team}/users
TeamsList Get /1.0/teams

TeamCreate

TeamCreate(ctx, teamCreateArgs)

Create a team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamCreateArgs TeamCreateArgs

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamDelete

TeamDelete(ctx, team)

Delete a team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamGet

TeamInfo TeamGet(ctx, team)

Get a team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.

Return type

TeamInfo

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamGroupList

[]TeamGroup TeamGroupList(ctx, team)

Get groups of a team

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.

Return type

[]TeamGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamQuotaChange

TeamQuotaChange(ctx, team, limit)

Changes the team's apps limit.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.
limit float32 New limit of apps. Negative number indicates unlimited.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamQuotaGet

UserQuotaViewResponse TeamQuotaGet(ctx, team)

Get quota of a team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.

Return type

UserQuotaViewResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamUpdate

TeamUpdate(ctx, team, teamUpdateArgs)

Update a team.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.
teamUpdateArgs TeamUpdateArgs

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamUserList

[]TeamUser TeamUserList(ctx, team)

Get users of a team

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
team string Team name.

Return type

[]TeamUser

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeamsList

[]Team TeamsList(ctx, )

List teams.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Team

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]