Page MenuHomePhabricator
Create Task
Maniphest T356523

[jobs-api] introduce OpenAPI to jobs framework
Closed, ResolvedPublic
Actions

Description

In the first iteration of the Toolforge jobs framework the API definition was done by hand.

There are now a number of indicators that having an OpenAPI definition (and generating the code from it) may be the right thing to introduce today.

See also:

Details

TitleReferenceAuthorSource BranchDest Branch
jobs-api: bump to 0.0.269-20240315104203-49ed38c0repos/cloud/toolforge/toolforge-deploy!222project_1317_bot_df3177307bed93c3f34e421e26c86e38bump_jobs-apimain
jobs-api: bump to 0.0.266-20240307133255-36e022bcrepos/cloud/toolforge/toolforge-deploy!216project_1317_bot_df3177307bed93c3f34e421e26c86e38bump_jobs-apimain
jobs-api: add /openapi.json endpointrepos/cloud/toolforge/jobs-api!66aborreroarturo-3288-jobs-api-add-api-vmain
job: adjust max job name lengthrepos/cloud/toolforge/jobs-api!65aborreroarturo-4288-job-adjust-max-jobmain
jobs-api: add openapi schemarepos/cloud/toolforge/jobs-api!59aborreroarturo-9921-jobs-api-add-openamain
Customize query in GitLab

Related Objects
Search...

Event Timeline

aborrero created this task.Feb 2 2024, 5:03 PM
aborrero claimed this task.Feb 2 2024, 5:07 PM
aborrero triaged this task as Medium priority.
aborrero moved this task from Backlog to Next on the User-aborrero board.
taavi added a project: Toolforge Jobs framework.Feb 2 2024, 5:10 PM
dcaro edited projects, added Toolforge (Toolforge iteration 05); removed Toolforge (Toolforge iteration 04).Feb 6 2024, 5:42 PM
aborrero moved this task from Next to Doing on the User-aborrero board.Feb 8 2024, 11:08 AM
CodeReviewBot added a project: Patch-For-Review.Feb 9 2024, 1:49 PM

aborrero opened https://gitlab.wikimedia.org/repos/cloud/toolforge/jobs-api/-/merge_requests/59

jobs-api: add openapi schema

Iluvatar subscribed.Feb 12 2024, 11:25 AM
aborrero merged a task: T327279: Toolforge jobs framework: introduce swagger to the API.Feb 12 2024, 1:27 PM
aborrero added subscribers: Wbm1058, Raymond_Ndibe, • Bstorm and 2 others.
aborrero added a comment.Feb 12 2024, 4:10 PM

Out of curiosity, I generated the server code using https://openapi-generator.tech/ , and I got this https://gitlab.wikimedia.org/aborrero/jobs-api-gen

aborrero moved this task from Doing to Blocked on the User-aborrero board.Feb 16 2024, 12:06 PM
dcaro removed a parent task: T356377: [toolforge] simplify calling the different toolforge apis from within the containers.Feb 19 2024, 4:12 PM
dcaro added a parent task: T354745: [jobs-api,buildservice-api,envvars-api] Investigate ways to present our multiple Openapi definitions to a future consolidated CLI client.
aborrero changed the task status from Open to In Progress.Feb 20 2024, 2:30 PM
aborrero moved this task from Next Up to In Progress on the Toolforge (Toolforge iteration 05) board.
dcaro edited projects, added Toolforge (Toolforge iteration 06); removed Toolforge (Toolforge iteration 05).Feb 21 2024, 10:10 AM
dcaro moved this task from Next Up to In Progress on the Toolforge (Toolforge iteration 06) board.
Slst2020 added a parent task: T358100: [toolforge API] expose all backend APIs OpenAPI specs.Feb 21 2024, 1:17 PM
dcaro edited projects, added Toolforge; removed Toolforge (Toolforge iteration 06), Toolforge Jobs framework.Feb 21 2024, 4:38 PM
dcaro edited projects, added Toolforge (Toolforge iteration 06); removed Toolforge.
Don-vip subscribed.Mar 5 2024, 11:20 AM
CodeReviewBot added a comment.Mar 5 2024, 2:43 PM

aborrero merged https://gitlab.wikimedia.org/repos/cloud/toolforge/jobs-api/-/merge_requests/59

jobs-api: add openapi schema

aborrero added a comment.Mar 5 2024, 2:44 PM

follow up:

  • make sure all jobs (regardless of type) accept the same length for the job name
  • review the /healthz endpoint
  • serve the openapi file via the corresponding API endpoint
aborrero moved this task from Blocked to Next on the User-aborrero board.Mar 5 2024, 2:44 PM
Maintenance_bot removed a project: Patch-For-Review.Mar 5 2024, 3:30 PM
CodeReviewBot added a project: Patch-For-Review.Mar 5 2024, 4:24 PM

aborrero opened https://gitlab.wikimedia.org/repos/cloud/toolforge/jobs-api/-/merge_requests/65

job: adjust max job name length

dcaro edited projects, added Toolforge (Toolforge iteration 07); removed Toolforge (Toolforge iteration 06).Mar 5 2024, 5:12 PM
dcaro moved this task from Next Up to In Progress on the Toolforge (Toolforge iteration 07) board.
CodeReviewBot added a comment.Mar 6 2024, 1:18 PM

aborrero opened https://gitlab.wikimedia.org/repos/cloud/toolforge/jobs-api/-/merge_requests/66

jobs-api: add /api/v1/openapi.json endpoint

aborrero moved this task from Next to Doing on the User-aborrero board.Mar 6 2024, 1:27 PM
CodeReviewBot added a comment.Mar 7 2024, 1:32 PM

aborrero merged https://gitlab.wikimedia.org/repos/cloud/toolforge/jobs-api/-/merge_requests/65

job: adjust max job name length

CodeReviewBot added a comment.Mar 7 2024, 1:35 PM

project_1317_bot_df3177307bed93c3f34e421e26c86e38 opened https://gitlab.wikimedia.org/repos/cloud/toolforge/toolforge-deploy/-/merge_requests/216

jobs-api: bump to 0.0.266-20240307133255-36e022bc

CodeReviewBot added a comment.Mar 7 2024, 1:41 PM

aborrero merged https://gitlab.wikimedia.org/repos/cloud/toolforge/toolforge-deploy/-/merge_requests/216

jobs-api: bump to 0.0.266-20240307133255-36e022bc

dcaro renamed this task from toolforge: introduce OpenAPI to jobs framework to [jobs-api] introduce OpenAPI to jobs framework.Mar 12 2024, 1:19 PM
CodeReviewBot added a comment.Mar 15 2024, 10:41 AM

aborrero merged https://gitlab.wikimedia.org/repos/cloud/toolforge/jobs-api/-/merge_requests/66

jobs-api: add /openapi.json endpoint

CodeReviewBot added a comment.Mar 15 2024, 10:43 AM

project_1317_bot_df3177307bed93c3f34e421e26c86e38 opened https://gitlab.wikimedia.org/repos/cloud/toolforge/toolforge-deploy/-/merge_requests/222

jobs-api: bump to 0.0.269-20240315104203-49ed38c0

CodeReviewBot added a comment.Mar 15 2024, 10:54 AM

aborrero merged https://gitlab.wikimedia.org/repos/cloud/toolforge/toolforge-deploy/-/merge_requests/222

jobs-api: bump to 0.0.269-20240315104203-49ed38c0

aborrero added a comment.Mar 15 2024, 10:55 AM

The openapi JSON can now be fetched from the API:

toolsbeta.test@toolsbeta-sgebastion-05:~$ curl --insecure --silent --cert ~/.toolskube/client.crt --key ~/.toolskube/client.key https://k8s.svc.toolsbeta.eqiad1.wikimedia.cloud:30003/jobs/openapi.json | jq 
{
  "components": {
    "schemas": {
      "DefinedJob": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NewJob"
          },
[..]

tools.arturo-test-tool@tools-sgebastion-11:~$ curl --silent --insecure --cert ~/.toolskube/client.crt --key ~/.toolskube/client.key https://k8s.svc.tools.eqiad1.wikimedia.cloud:30003/jobs/openapi.json | jq
{
  "components": {
    "schemas": {
      "DefinedJob": {
        "allOf": [

[...]
``
Maintenance_bot removed a project: Patch-For-Review.Mar 15 2024, 11:30 AM
aborrero closed this task as Resolved.Mar 15 2024, 11:34 AM
Slst2020 moved this task from In Progress to Done on the Toolforge (Toolforge iteration 07) board.Mar 15 2024, 11:45 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL