Skip to content

[TEST] Messy autogen API docs test #495

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

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions api/docs/add-labels-to-actions.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: add-labels-to-actions
title: "Add labels to actions"
description: "Adds the given list of labels to the given pipeline actions. Existing labels are preserved."
sidebar_label: "Add labels to actions"
hide_title: true
hide_table_of_contents: true
api: eJy1VE1v2zAM/SuCzmmcbsWA5bR06IBixVq0GXYIcmBsJlErW6okJw2M/PeRkt04S9HtsothSY9fj49sZIE+d8oGZSo5lpOi8CKsUazUBiuhlQ/CLIWGBWp6ML03qyxqVaGAnI39UFy9EFxVqw4ODoV16NFtsBjKgTQWHTD4ukixbiJwaibJBUEsOCgxoPNyPGtkRQeCbo178hZyJMOBVJzpc41uR4fj/H91QFHVJTqVC1VgFdRSoSOwz9dYghw3MuwsO1ZVwFV8WhpXQkhXny7kfj8fSIcUxYdLU+zY5jjUTVtkUYgWR15yQw6rwGiwVqs8lps9ejZpTuObxSPmbGgdkxMU+mibJ5Z8DwrOAResApb9ex8ccU4JD2Tk/d+s3imcHAUVNKMm3ptcQcDUoFTyfVttRHLpyiH1M7ga44W31MpUx4fRxSlxt9/FmfhhRMcVGV2MPr6B69QiKhMEaG22FIeDesxrp8IuSuQSSWduUoc1HefcNtLP2rDCrIlNscBvMmuFmiV5ZtQ5efD1wK1JWfc9vhK2DsF2CuLzIoLoJv1861h83IaYI7f8/qCfqxcoLXN61NxZ1715v3mz0XzPKl+aGL/txQM+Ex9icnd9ovr2yWoI3E3BE6dy9C2Yiaag7Kx2uq3Fj7PMR7uhMgQiXSodVbA0Xw4PlMiGhjHFOR9+Ho74ioktIUq6nVAa5t6WgNd5Pkq0OczHf940bdMCvoSMaKGNQVnH4ptWDjN5SDJ5oR+WBLVizbohRNMswONPp/d7vk4rhzVXKA8Lzapfgvb4Tpl/WUhv5vmEu5OdtwFdM1KywDfgFMePgqd0EQryxokl068p/NmUvR9sTzbS0bDc3T5MWc7tsitNwTYOtnTJX4rNGzxxRoB41xB31aqGFWOTTxY/HM/OH7MSM+32U7XrZUiER8TUPGFFpHdcBD5TuuT8N1q+Tz8=
sidebar_class_name: "post api-method"
info_path: platform_versioned_docs/api/seqera-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Add labels to actions"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/actions/labels/add"}
context={"endpoint"}
>

</MethodEndpoint>



Adds the given list of labels to the given pipeline actions. Existing labels are preserved.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"description":"Labels add request","content":{"application/json":{"schema":{"type":"object","properties":{"actionIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateActionLabelsRequest"}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}}
>

</StatusCodes>



71 changes: 71 additions & 0 deletions api/docs/add-labels-to-pipelines.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: add-labels-to-pipelines
title: "Add labels to pipelines"
description: "Adds the given list of labels to the given pipelines. Existing labels are preserved."
sidebar_label: "Add labels to pipelines"
hide_title: true
hide_table_of_contents: true
api: eJy1VE1v2zAM/SuCzmmcbcWA5bR06IBgxVq0GXYoemBsJlEqS6okJw2M/PeRst04TbENGHYxLOnx6/GRtSww5F65qKyRYzkpiiDiCsVSbdAIrUIUdiE0zFHTg+29OeVQK4NhKC6fCafMssOBR+E8BvQbLIZyIK1DDxxiWjRBrhJwZm86JwRy4KHEiD7I8X0tDR0IvLX+MTjIkUwHUnGSTxX6HR2OU//ZAYWpSvQqF6pAE9VCoSdwyFdYghzXMu4cO1Ym4jI9LawvITZXH8/lfv8wkB4pSogXttixzXGoq7bMohAtjrzklhyayGhwTqs8FZytA5vUp/HtfI05GzrP9ERFJNBrR+u0CD0weA9csopYhr8rYiBTN/7ZDzmKKmpGTUKwuYKIXdsaIm5bDhKWCVEeqc/RV5gugrMmNNW9H52f0nn9TZyJ71Z0DJLR+ejDG7hORcLYKEBru6U4HDRgXnkVd0k4F0j685Mqruj4wM0kVa0sK8/Z1CoH/CazFwlnjXAz6qg8eLvjljV5932+kLaK0XXK4vM8geim+fnaMbnexpQlS+H2oKvLZygd8/qq6fejh37v6Lhn4S9sCt224g6fiAwxuZmeDEL75DREbqbgMVQ5hhbMLEOedFp53ZYRxlkWkt1QWQKRVJVOIljYz4cHSmRD89nEeTf8NBzxFbNaQlJ5O7Q04b2d4XpDfpRqfRia/7V52lZFfI4ZMUL7gxJOddetDO5lP7/GD/2wFKgPK1YMYep6DgF/eL3f83WzglhthQow16z3BeiAv6nwDwvqzUwfcXeyAzegK0ZKlvYGvOL4SeqULkJB3jixxvRLE/5sxt4Pticb6mhMbq7vZizjdvmVtmAbD1u65C/F5p3O1mk60l1N3JllBUvGNj5Z9HA8M69mJGXa7Saz62VIhCfEzD6iIdI7LiKfKV1y/gs1tlLD
sidebar_class_name: "post api-method"
info_path: platform_versioned_docs/api/seqera-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Add labels to pipelines"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/pipelines/labels/add"}
context={"endpoint"}
>

</MethodEndpoint>



Adds the given list of labels to the given pipelines. Existing labels are preserved.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"description":"Labels add request","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineIds":{"type":"array","items":{"type":"integer","format":"int64"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociatePipelineLabelsRequest"}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}}
>

</StatusCodes>



71 changes: 71 additions & 0 deletions api/docs/add-labels-to-workflows.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: add-labels-to-workflows
title: "Add labels to workflows"
description: "Adds the given list of labels to the given workflows. Existing labels are preserved."
sidebar_label: "Add labels to workflows"
hide_title: true
hide_table_of_contents: true
api: eJy1VE1v2zAM/SuCzmmcbsWA5bR06IBixVq0GXoIcmBsOlEqW6okJw2M/PeRst04TdHtsothSY9fj4+sZYY+dcoGZUo5lpMs8yKsUCzVBkuhlQ/C5ELDAjU9mN7b1rinXJutH4qrF8KpctnhwKGwDj26DWZDOZDGogMOcZ01QW4icGoeOycEsuCgwIDOy/GsliUdCMxhvIUUyXQgFSf5XKHb0eE49ccOKMqqQKdSoTIsg8oVOgL7dIUFyHEtw86yY1UGXMan3LgCQnP15ULu9/OBdEhRfLg02Y5tjkPdtGVmmWhx5CU15LAMjAZrtUpjwcnas0l9Gt8s1piyoXVMT1Do+bWj9TrzPTA4B1yyClj0731wxDulPJCR+3+z+qB0chRU0IyaeG9SBQG7JjVl37cVRyyXrxxSV4OrMF54a0rf1PJpdHFK3u1PcSZ+GdHxRUYXo8/v4DrNiNIEAZoSoDgc1GNaORV2USaXSGpzkyqs6Djn1pGGVoZ1Zk1sjAV+k0nHbNKoNKH2yYOzB+5Pk3bf5StnqxBsJyM+LyKIbpqfHx2R622ISXLf7w8iunqBwjKtbzo861o473dwNprvWey5iRm0DXnAZ6JETO6uT8TfPlkNgVsqePRUir4FM9eQRm1WTrfV+HGS+Gg3VIZAJE+loxRy8+3wQIlsaCabOOfDr8MRXzG3BURlt4NKU93bE9veYB+lWh8G5X9tm7ZjAV9CQozQzqCEY911K4bZaxNkSzvnyYKgNqxYNgSp6wV4/O30fs/XzdZhyWXKw0Kz6HPQHj8o8C876d1En3B3svY2oCtGStb3Bpzi+FHvlC5CRt44scb0exP+bMreD7YnS+loVu5uH6Ys5nbfFSZjGwdMEH8pNq9xto4zEu9q4q5cVrBkbOOTpQ/Hk/NmUmKm3YIqd70MifCImJonLIn0jovAZ0qXnP8Bt9lQUg==
sidebar_class_name: "post api-method"
info_path: platform_versioned_docs/api/seqera-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Add labels to workflows"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/workflow/labels/add"}
context={"endpoint"}
>

</MethodEndpoint>



Adds the given list of labels to the given workflows. Existing labels are preserved.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"description":"Labels add request","content":{"application/json":{"schema":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateWorkflowLabelsRequest"}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}}
>

</StatusCodes>



71 changes: 71 additions & 0 deletions api/docs/admin-allow-login.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: admin-allow-login
title: "Allow user login"
description: "Allows the given user to log in to Seqera Platform."
sidebar_label: "Allow user login"
hide_title: true
hide_table_of_contents: true
api: eJydU01v2zAM/SuCThsQxNlQDJhPyw4Dig1YsDanIAfFYWKusuRIdLrA8H8fKStt048ddhJFUo/vkVSvtxCrgC2hd7rUc2v9fVRUg9rjEZzqIgRFXlm/V+jEuoEDBKMW1tDOh2aqJ9q37BGE661gbBt0CeiH36PjeGuCaYAgRF2ueu34wnkCzQ8mGqVya6hm+5LOUqq7roGAlcItOMIdQuC8AIcOA3A9Ch1MdKxqaIwue02nVtDREexTqrA0NLo+XelhWMvz2HoXIcqLj7OZHJelf37Xw4RDVy9DzwQqTlJnQIZnMlB1AemU1H4FEyDMO5ZXrtZSnFtRe+lU21HqjoR0YQS2kK7Eoh+bMxRGyhQ2N/IMfCNqR/JP4R/E10Stzk2R+yYlsWc0vp078vueEmF0O5+eI1nJzzOeL65fjCSH2jx+xTyPWEHMyZV3ZCoSsC7YTCWWRRHTuyl6TuJJoU0D2fkvjwEmcmTxY50P08/TmbhaH6kxThDz4qTWj5t5bswFxz6x4GX574XObST4QwUr5RJMJOnp87hWOo2Lc9PA+Cwf9jnNjM+RHA+8ZgnypO83JsIy2GEQ96GDIDvC5tEENBvpPW/MFqPYvCE7YyP8Q927X/kbvFdvf5VXxWSncSct1W0nNzbv4PT4NYf18GRbF8tbEXe5ac82K/F/FZu1p4xbfweO9Z9Lkdyl0jD8BfO/jOI=
sidebar_class_name: "put api-method"
info_path: platform_versioned_docs/api/seqera-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Allow user login"}
>
</Heading>

<MethodEndpoint
method={"put"}
path={"/admin/users/{userId}/allow/login"}
context={"endpoint"}
>

</MethodEndpoint>



Allows the given user to log in to Seqera Platform.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"userId","in":"path","description":"User numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"204":{"description":"AdminAllowLogin 204 response"}}}
>

</StatusCodes>



71 changes: 71 additions & 0 deletions api/docs/admin-count-participant-roles.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: admin-count-participant-roles
title: "Count workspace participants"
description: "Returns the number of workspace participants. Append `?type=<user>` or `?type=<team>` to return results only for the given type."
sidebar_label: "Count workspace participants"
hide_title: true
hide_table_of_contents: true
api: eJzNVm1v0zAQ/iuWP4E0NQMhJCreuq0gxEZRV8SHaRJuem28JXZmX1pKlf/OnZOm6dpt5RufkvjOd88995aVnICPnc5RWyO7cghYOOMFJiBMkY3BCTsVC+tufa5iELlyqGOdK4O+I3p5DmYifn3AZQ7v3hYe3PtfwrrmBEFldIJWuGCYHr5I0Qtr0qWYkiY7muk5GME3OvJI2hycYjhfJgSoN8m0ObWFwe8b10ObgidVQqMyQHBedq9W0tAHXWnQkoEjqTmsXGFC79ux/myiokjB6VjoCRjUUw2OlB3cFdoBgUBXwJH0cQKZkt2VZKR0XxuEWVClQDKF1dHrV7IsjxowQbdGcVeAW+7AaMUVOBDPmEdmkdl7Lvd49ui0mZGfa4bpc2s88UHyl8fH/Nh2MPhKNmJLaA2yVOV5quNAcXTjWWW168KObyBG5thxQlBXDtCiSi/1HziIh5Chpl5aV5RzipnQCFk4V2k6mIYkPu6/ZY/L4yAMGXAdH6zO7H8Lydvhm9S18/igNFWPCIlfne6VWDfjit6V0SUqTaJF2oUJcKtYQj7TVI0tdYp1ksoANbIFOahtkVkun4OjZuUHoS98fihAxf3KQBWZVuE1VYWJk6oGTZXUuYZFG/XP2gEDCQ4ednTRvzjpD+lg1O9d0ON0cH7eOxkMe6PBsG2y1VYjNlXH2JsrVO6H258Jzv1jGuVe+2fjM7SSm/6J5iH/FyGBPky0w2ZJ2Qqqb2hMJTDZdd6GttY61749Nf2wHhWszfoe4sJpXIa+OwHlKPiCBmX36pqd0mRNLM/gGYRYeIZ2ZRQyHDVD1ker1sAto3bHR3EIc+PpksdMRUbbX0NDgpivBx5/j4MSnVQvn9bc3CwwJEObqQ3X68gv4Y6Wh+h9/7IzZmtRnipkigVleq4Jfq3M81HFISUFpz5A8d0o8uFeR1vZtHBw+3EjICBzymnl50XnTec4jD7rMVNhuta7ICT9gWV6H+9qM7H/h6Vc5wfhN0ZEIfU1d0vVI1VhXDWtvykN+uhub+N7IVf1QbWWEFlsY7UaKw/UfGXJx9XG5PKcaK/GKW/jqUo9PMLW0/t0bzC3sNys67lKC1aR3Adz5TT7/kccz4b1D8Rz8cSfxl48601plm08a5xtVstrUk9ATcgYQ6w0enEMObbu7qz9rR7/3B/x9N5ux3vt197P27gobUFjZG/BUOoaOvmbAZblX8LvmD0=
sidebar_class_name: "get api-method"
info_path: platform_versioned_docs/api/seqera-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Count workspace participants"}
>
</Heading>

<MethodEndpoint
method={"get"}
path={"/admin/workspaces/{workspaceId}/participants/count"}
context={"endpoint"}
>

</MethodEndpoint>



Returns the number of workspace participants. Append `?type=<user>` or `?type=<team>` to return results only for the given type.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"Participant type (user or team)","schema":{"type":"string"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64"},"participants":{"type":"array","items":{"allOf":[{"type":"object","properties":{"participantId":{"type":"integer","format":"int64"},"memberId":{"type":"integer","format":"int64"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"orgRole":{"type":"string","enum":["owner","member","collaborator"],"title":"OrgRole"},"teamId":{"type":"integer","format":"int64"},"teamName":{"type":"string"},"wspRole":{"type":"string","enum":["owner","admin","maintain","launch","connect","view"],"title":"WspRole"},"type":{"type":"string","enum":["MEMBER","TEAM","COLLABORATOR"],"title":"ParticipantType"},"teamAvatarUrl":{"type":"string"},"userAvatarUrl":{"type":"string"}},"title":"ParticipantDbDto"},{"type":"object","properties":{"teamMembersCount":{"type":"integer","format":"int64"}}}],"title":"EnrichedParticipantDbDto"}}},"title":"EnrichedListParticipantsResponse"}}}}}}
>

</StatusCodes>



Loading
Loading