[builds-api] refactor build start response type
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Raymond_Ndibe
	Feb 6 2024, 12:59 AM

Description

with this we can notify a user when they are about to use up their quota.

Another alternative is to make a second request to the quota endpoint.

Details

Title	Reference	Author	Source Branch	Dest Branch
d/changelog: bump to 0.0.13	repos/cloud/toolforge/builds-cli!56	raymond-ndibe	bump_version	main
builds-api: bump to 0.0.126-20240212140328-9308d684	repos/cloud/toolforge/toolforge-deploy!195	project_1317_bot_df3177307bed93c3f34e421e26c86e38	bump_builds-api	main
[builds-cli] refactor build start response type	repos/cloud/toolforge/builds-cli!55	raymond-ndibe	refactor_build_start_response_type	main
[builds-api] refactor build_start response type	repos/cloud/toolforge/builds-api!75	raymond-ndibe	refactor_start_response	main
[builds-api] merge BuildStartParams and NewBuild_parameters	repos/cloud/toolforge/builds-api!74	raymond-ndibe	merge_newbuild_parameters_and_buildstartparams	main

Customize query in GitLab

Related Objects
Search...

Status	Assigned	Task
In Progress	None	T351092 [harbor,docs] Improve Harbor quota handling and docs
Resolved	Raymond_Ndibe	T353535 alert users when they are about to exceed their harbor quota
Resolved	Raymond_Ndibe	T356724 [builds-api] refactor build start response type

Event Timeline

@dcaro what's your opinion? anyone is fine by me

Can you elaborate?

What is the workflow that you imagine to alert users?

I'm guessing something like show a warning message when starting a new build?

If so, then probably the return value of Start is a good place yes, I think that could be useful for API users too, maybe we can add also the criteria for the warning to the API, instead of having it on the cli, as in return generic warnings or similar, so instead of adding stuff to NewBuild, we can add an object StartResponse, that inside has NewBuild and something else with the info, like:

StartResponse:
  type: object
  properties:
    messages:
      $ref: "#/components/schemas/ResponseMessages"
    new_build:
      $ref: "#/components/schemas/NewBuild"
ResponseMessages:
  type: object
  properties:
    warnings:
      type: array
      items:
        type: string
    errors:
      type: array
      items:
        type: string
    infos:
      type: array
      items:
        type: string

We could skip infos and errors for now until needed, but the idea would be that the client would not need to decide if something is a warning anymore, and just show the warnings (that would help for any/all the API calls btw.)

dcaro edited projects, added Toolforge (Toolforge iteration 05); removed Toolforge (Toolforge iteration 04).Feb 6 2024, 5:42 PM

In T356724#9516707, @dcaro wrote:
Can you elaborate?

What is the workflow that you imagine to alert users?

I'm guessing something like show a warning message when starting a new build?

If so, then probably the return value of Start is a good place yes, I think that could be useful for API users too, maybe we can add also the criteria for the warning to the API, instead of having it on the cli, as in return generic warnings or similar, so instead of adding stuff to NewBuild, we can add an object StartResponse, that inside has NewBuild and something else with the info, like:
StartResponse:
  type: object
  properties:
    messages:
      $ref: "#/components/schemas/ResponseMessages"
    new_build:
      $ref: "#/components/schemas/NewBuild"
ResponseMessages:
  type: object
  properties:
    warnings:
      type: array
      items:
        type: string
    errors:
      type: array
      items:
        type: string
    infos:
      type: array
      items:
        type: string
We could skip infos and errors for now until needed, but the idea would be that the client would not need to decide if something is a warning anymore, and just show the warnings (that would help for any/all the API calls btw.)

thanks @dcaro this is better since it can be reused if there is ever a need to use it elsewhere

raymond-ndibe opened https://gitlab.wikimedia.org/repos/cloud/toolforge/builds-api/-/merge_requests/74

[builds-api] merge BuildStartParams and NewBuild_parameters

Raymond_Ndibe renamed this task from [builds-api] add quota information to NewBuild struct to [builds-api] refactor build start response type.Feb 7 2024, 5:11 AM

raymond-ndibe opened https://gitlab.wikimedia.org/repos/cloud/toolforge/builds-api/-/merge_requests/75

[builds-api] refactor build_start response type

raymond-ndibe opened https://gitlab.wikimedia.org/repos/cloud/toolforge/builds-cli/-/merge_requests/55

[builds-cli] refactor build start response type

dcaro changed the task status from Open to In Progress.Feb 7 2024, 10:10 AM

dcaro triaged this task as High priority.

dcaro moved this task from Next Up to In Progress on the Toolforge (Toolforge iteration 05) board.

raymond-ndibe opened https://gitlab.wikimedia.org/repos/cloud/toolforge/builds-api/-/merge_requests/76

[builds-api] merge BuildStartParams and NewBuild_parameters

Raymond_Ndibe moved this task from In Progress to In Review on the Toolforge (Toolforge iteration 05) board.Feb 8 2024, 6:32 AM

raymond-ndibe merged https://gitlab.wikimedia.org/repos/cloud/toolforge/builds-cli/-/merge_requests/55

[builds-cli] refactor build start response type