[codex] Add GCP machine guidance for Fusion Snapshots

fusion_docs/guide/snapshots/gcp.md

@@ -31,6 +31,17 @@ Fusion Snapshots work with sensible defaults (5 automatic retry attempts). For c
 
 [Incremental snapshots](./index.md#incremental-snapshots) are enabled by default on x86_64 instances and capture only changed memory pages between checkpoints. This is particularly beneficial for Google Batch's shorter reclamation window. Use x86_64 instances to enable incremental snapshots.
 
+## Machine type guidance
+
+Fusion Snapshots on Google Batch work best when the underlying compute environment uses machine types that provide local SSD support and enough memory bandwidth to complete checkpoints within the preemption window.
+
+- If you don't specify a machine type, Seqera Platform selects a VM from Google Cloud families that support local SSDs.
+- Any machine type you specify for Fusion Snapshots must support local SSDs.
+- For production workloads, start with an `n2-highmem-16-lssd` VM or larger, then validate checkpoint duration with your workload profile.
+- If your workload has larger memory footprints, increase the machine size conservatively and re-test snapshot and restore times before widening usage.
+
+See [Google Cloud Batch compute environment configuration](../../platform-cloud/docs/compute-envs/google-cloud-batch.md#use-fusion-v2) for the underlying Fusion v2 compute recommendations that also apply to Fusion Snapshots on Google Batch.
+
 ## Resource limits
 
 A single job can request more resources than are available on a single instance. To prevent this, set resource limits using the `process.resourceLimits` directive in your Nextflow configuration. See [Resource limits](./configuration.md#resource-limits) for more information.

platform-api-docs/docs/check-permission.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"operationId","in":"query","description":"Operation identifier to check in the selected context.","required":true,"schema":{"type":"string"}}]}

platform-api-docs/docs/check-permission.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body"}

platform-api-docs/docs/check-permission.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Result of checking whether the authenticated user can perform a given operation in the selected context.","properties":{"authorized":{"type":"boolean","description":"Whether the authenticated user is authorized to perform the requested operation."}},"title":"CheckPermissionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}}

platform-api-docs/docs/check-permission.api.mdx

@@ -0,0 +1,66 @@
+---
+id: check-permission
+title: "Check permission"
+description: "Checks whether the authenticated user is allowed to perform the given operation in the specified user, organization, or workspace context."
+sidebar_label: "Check permission"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNVU1v20YQ/SuLOTUAIdlp2oNOcYI0MHqo4aTowdBhvRyRa5O769mhXYXgfy9m+SHKUqwkyKEnidzhzHtv3s60wLqIsLqBgFTbGK13EdYZ5BgN2cDWO1jB+xLNfVRPJXKJpLhEpRsu0bE1mjFXTURSNipdVf4Jc8VeBaSNpzoFF/YRnfIBSUtGZV16HQMau7HD95nyVGhnv6QYeVJPnu5j0AaV8Y7xX15ABlOay3yEdjWBhwyCJl0jIwmvFpyuEVbgqbjMIQMrfB4apC08Z/nXrLxyTY1kjbK5sNxYJKkdTYm1hlULvA2S1jrGAgkyELKa+1e/v4Guy6baE41TCP6Z+P7M8nPBXhZg16CprLTSiMZT07BCIz2ftYTwobGEOayYGjyCMzJZV0DXrSU4Bu8iRjl/fXYmP89w/AkZpPSO5VSHUInRrHfLuygh7WEJf3uHhg84XWNsKlZ+07OwrjhlY6PdZF79VeseUSGQhLHtmUlmT/aLqDKBvPW+Qu0OG3/6Zk3pnl8uER+jxE4oF9J/YMsVHl6R60F/6DqJenOsA+90Pub9nlbsfHADNcaoC5Rh8rxD+0KNgUfcsuPwgcjTAfJfj3hn6pTzPM6jlCqiacjyNk2Fd6gJ6aLhElY3a7FljVx6mSgFJoxajmA5m4vL5CC5hkiP43hpqIIVlMwhrpZLHezCVL7JFxEfkPTC+oNef0on6qrSnHr4XuLVxdUlCIwR5ScRtRdojnXSSCqOEyE5KwVBNvz5YxwHd0+c2Fu38enzQdABhZQ9BVDoWoNxCBY3aJPcsE9+Thlrbas0jTb+7e6gy0CU6+ucL87Pf1ucycvgI9c6uWkYWsm0KswH+x7KdufK/9d6Gvojj8tQaeuEXxKqHUy1v2wz6G21zqD0keW4bW91xL+p6jp53Q9rMVtuo76t5H5tdBXxBUm+YZcdBXqP29myfNRVIzEg2+Tbi59aYy9U3l+VP1j/l+thDr1SP7zSXlJnb5/uMK7lgayATEMlgxJ1jpRa1396YQwGnn11ME/3RtHHD58hS5tkvkP2b3rKPhxpt53lbts+4rO/R9d1MOJneYZu3XXdf3bGgLk=
+sidebar_class_name: "get api-method"
+info_path: platform-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";
+import Translate from "@docusaurus/Translate";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Check permission"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"get"}
+  path={"/permissions/check"}
+  context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Checks whether the authenticated user is allowed to perform the given operation in the specified user, organization, or workspace context.
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+>
+  <Translate id="theme.openapi.request.title">Request</Translate>
+</Heading>
+
+<ParamsDetails
+  {...require("./check-permission.ParamsDetails.json")}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+  {...require("./check-permission.RequestSchema.json")}
+>
+
+</RequestSchema>
+
+<StatusCodes
+  {...require("./check-permission.StatusCodes.json")}
+>
+
+</StatusCodes>

platform-api-docs/docs/create-role.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]}

platform-api-docs/docs/create-role.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body","body":{"description":"Role create request","content":{"application/json":{"schema":{"type":"object","description":"Request payload for creating a custom role in an organization.","properties":{"name":{"type":"string","description":"Role name."},"description":{"type":"string","description":"Role description."},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permission names assigned to the role."}},"title":"CreateRoleRequest"}}},"required":true}}

platform-api-docs/docs/create-role.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","description":"Created role details.","properties":{"name":{"type":"string","description":"Role name."},"description":{"type":"string","description":"Role description."},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permission names assigned to the role."}},"title":"CreateRoleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate role name","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}}

platform-api-docs/docs/create-role.api.mdx

@@ -0,0 +1,66 @@
+---
+id: create-role
+title: "Create role"
+description: "Creates a custom role in the organization identified by `orgId`."
+sidebar_label: "Create role"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVktv4zYQ/ivEnFpAtZN2W6A+NUm3QIACCZL0ZBjYiTS2maVIhRwl6wr878WQki1b+0Kxhx56k8h5fDPfPNgB4ybAYgneGQqwKqCiUHrdsHYWFnDlCZmCQlW2gV2tRE5pq3hLyvkNWv03iqzSFVnWa02Vetypd85vrqt3MyjANeSTyHW1N3jnDEEBDXqsickLhA4s1gQLSKpQgBYAzy35HZzCuhl7tm1NXpcHBF7cenputacKFuxbKiCUW6oRFh3wrhE32jJtyEMBa+dr5Hz0yxuIcZXVKfClq3aic+xe4KsyRaJ6QSigdJbJsohj0xhdJnjzpyA63RSAe3yikiex3WWDqsGdcViptfPZl7abKQ9oj2iQyBsvKWdNQZzlpO6dBvbabqZOxZyIziCe3H2V6ugoWWjI1zoE7WwYWUDvUcjUTHWYWj71DH/qwMqt1cFawhgUhqA3lirFLlWiZGMGMRbAmg0d1VmfT4hyfVwV6SA0zoacqx/PzqdkZ0vVtyO4N5gprIhRm/A/bx/hLTMjxMUC3pydTbm5xOrfNOChCpZQUwi4IRl9p7QdEzIITsMfwX/rvfMT5D9Nkd8MU1FZxwqNca9UQZL+dSr9e5vDyRlLyfyvxhsLCFS2XvMuDfVLQk/+ouUtLJYrGa018dbJLmhcoq1BuYN5XkGi7l+GldB6AwvYMjdhMZ9jo2elcW01C/RMHmfaTcr6Pt2oW4Msc11diby6uL0G8T1Au5fc5DjHAPehikfol4b8PyYhKPqPP4aN8fTKKR+S87vDynj7AevG0KGPP9WE++OjxlsO56soa3DtErI+5X2AEtGXYpdM6pJCLyz1gmWql+O8jrNJNWqTduHa/Xa4iAUIKdnP+ez8/OfZWRoYLnCNdhTpVb8X84o/GUn7kv0WL4ueK6YPPG8MaiuAUmRdX1Sjd81Wim2xhK57xEB/eROjHOf3hZRapQM+GmmSNZpAn4H+3V3fT9+rr3iIfBTle9qNXjovaFqRSSX6gl4LkNQuBWwJK/IJYVa6yjh+eBC7B93JBIjFoHFRltTwZ2XHbXl7c/8gld4/fWpXiY7HV3lV4avglFcdD0sinXVg0G7aNDAg25S+wOO2OmmjFNWwY+xuhLDrssSDe082RhgyxvIPcRVj/AcSGbud
+sidebar_class_name: "post api-method"
+info_path: platform-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";
+import Translate from "@docusaurus/Translate";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Create role"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"post"}
+  path={"/roles"}
+  context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Creates a custom role in the organization identified by `orgId`.
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+>
+  <Translate id="theme.openapi.request.title">Request</Translate>
+</Heading>
+
+<ParamsDetails
+  {...require("./create-role.ParamsDetails.json")}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+  {...require("./create-role.RequestSchema.json")}
+>
+
+</RequestSchema>
+
+<StatusCodes
+  {...require("./create-role.StatusCodes.json")}
+>
+
+</StatusCodes>

platform-api-docs/docs/delete-role.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"roleName","in":"path","description":"Role name.","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]}

platform-api-docs/docs/delete-role.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body"}

platform-api-docs/docs/delete-role.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Role not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}}

platform-api-docs/docs/delete-role.api.mdx

@@ -0,0 +1,66 @@
+---
+id: delete-role
+title: "Delete role"
+description: "Deletes the custom role identified by `roleName` in the organization identified by `orgId`. Predefined roles cannot be deleted."
+sidebar_label: "Delete role"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNVF1vEzEQ/CvWPoFkkhQKD/dES4NUgUrVlqcqUp27TeLWZ1/tvZZw8n9H67vLt6BCQuIpOXvsmVnPbgOk5gGyW/DOYICJhAJD7nVF2lnI4AwNEgZBCxQMEbpAS3qmsRDTpbjjtQtV4p3QNoGcnyurfyo+vwt2fn5e3A1AgqvQJ8h5sSK5cgZBQqW8KpHQs6wGrCoRMuh5QIJmXZWiBeyK5RsEH2AKj4+19lhARr5GCSFfYKkga4CWFV8ZyGs7hxjliiUJ7Ckea/TLPY5vm/5sXaLX+dqnfxGztoRz9CBh5nypqF36cAwxTvh4qJwNGPjE29Ex/+xo+CLeiAsncmcJLUGUcDwa7eNOVSFYDAYCCT06a0BVldF58jC8D4xtNlSu9d9CiSGoOXIwOvFueo8531d5fkXSrdAeeKi+QJoML429d/6q8wcxxqT83QGHfT6EdSSUMe4Zi9bngXq07+5IzFxti//VapQQMK+9pmVK9ikqj/6kpgVktxN++RJp4bghitQQqRl4F4apO4dN3wUR+C7/1DdJ7Q1ksCCqQjYcqkoPcuPqYhDwEb0aaLcX4+u0Iy6NIs6g+MR4cXJ5Diyk13nNhWpNb6pd+WZG6ALO39MEAtn9+dyn+/6ZUnG0nbl0vCtSp4Jp/ySQ7eocQwfmF1Z5euFt85uWsVTapOaauY/rjSiBK9fyHA2Ojt4PRrxYuUClSgnp5kE7mNLg2xXYrEP2r4ZkV2TCHzSsjNKWRSa3TReMfmxLyFYDciJh4QLxZtNMVcDv3sTIy+1A47wUOqip4djPlAn4G2uvrroOeS1eMPkOKn7A5cZofVKmZkzK2ZPymoX8vaitkX+QvltUdrnJ3stalS1OooQFqgJ9UtNun+Q5VrRxcG+cbPXt2fjr+GYMEtR2n+z0RSI4qKtpWsSNe0Ab40om8TdrjPEXrVGkrw==
+sidebar_class_name: "delete api-method"
+info_path: platform-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";
+import Translate from "@docusaurus/Translate";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Delete role"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"delete"}
+  path={"/roles/{roleName}"}
+  context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Deletes the custom role identified by `roleName` in the organization identified by `orgId`. Predefined roles cannot be deleted.
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+>
+  <Translate id="theme.openapi.request.title">Request</Translate>
+</Heading>
+
+<ParamsDetails
+  {...require("./delete-role.ParamsDetails.json")}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+  {...require("./delete-role.RequestSchema.json")}
+>
+
+</RequestSchema>
+
+<StatusCodes
+  {...require("./delete-role.StatusCodes.json")}
+>
+
+</StatusCodes>

platform-api-docs/docs/describe-role.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"roleName","in":"path","description":"Role name.","required":true,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]}

platform-api-docs/docs/describe-role.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body"}

platform-api-docs/docs/describe-role.StatusCodes.json

@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Role description response.","properties":{"role":{"type":"object","description":"Role details with assigned permissions.","properties":{"name":{"type":"string","description":"Role name."},"description":{"type":"string","description":"Role description."},"isPredefined":{"type":"boolean","description":"Whether the role is predefined by the system."},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permission names assigned to the role."}},"title":"RoleDto"}},"title":"DescribeRoleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Role not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}}

platform-api-docs/docs/describe-role.api.mdx

@@ -0,0 +1,66 @@
+---
+id: describe-role
+title: "Describe role"
+description: "Retrieves the details of the role identified by `roleName` in the organization identified by `orgId`."
+sidebar_label: "Describe role"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNVktv20YQ/iuLOTUAIdmN2wNPcR4tjBSt4aTIwRDgFTkS1yF36Z2hXZXY/17M8iFKFBInh6AnSTuzM988vm/VAustQXoL3pVIsEogR8q8qdk4CyncIHuDj0iKC1Q5sjYlKbeJP+WOMjlaNhuDuVrv1J2c/akrvFPGRifnt9qaf7UEPHZ2fnuV3y0gAVejjy5XOaTwNmJY440rERKotdcVMnpB2oLVFUIKQyZIwAjUWnMBM/wCUS5IEo8PjfGYQ8q+wQQoK7DSkLbAu1pCEntjtxBCMmaJEIcUDw363SzHX9MKbVOhN9m+Uv+szMYybtFDAhvnK83d0a8XEMJKrlPtLCHJjZ/PzuTjCMN7SCBzltGyWHVdlyaLkJb3JC7tPKlb32PGp3s2OVJDeqmk9jIqNh0WmcGzA3a782S4UJrIbC3mqkZfGSLjLM2jdyM4ns4XRhyObM+6OjmKEQxde8xxY6zMawyxdq5EbWcxPhXIBfoJIUjVYwBZc7HQjhirGH9S8iS89l7LahnGik6s5HHaPwyx8HAfLfaA9q1lN2JayEoDG5Zpxarfsjs4mzLuph83hCAuF6f27bXOlSw1En/L4u15cAsVEuktiuYcr8/hGgyOp3g6FvDOe+dnyF+eYMqgNMo6Vros3RPmEL0v5t7dcjlWG9fY/P9aakiAMGu84V1UyNeoPfrLhgtIb1eiIBVy4URatxizilamsIyqv2wHKQ0ggfzjoLSNLyGFgrmmdLnUtVlkpWvyBeEDer0wbsaGD9GirkvNImTqjfiry+srEBQDyA/Spa7iKdSxaMkIvUpG7kUnSPovvw0Sef/EsTPGbly83neoRyFpvwZQyjUZUu8s49VZHO9h8dOSsdKmjAq9ca/2hpCAdK7Lc744P/9lcRYJ74grbfeKNrItkvMYYrvfsR/2/PZ9Z/yHl3WpjRXcsQFtvyvDP4QE0vHhXSVQOGIxtu1aE/7tyxDkuHsoZYVyQ3pdCg02uiT8Qq0/3fSMeaGe8aKeRPwZd5Mn+1GXjfjE1XvU3giQ7wd18FfiZPpByu1umn2ANbYtrEICBeocfUTTmS+zDGueXJzJywGPf3/3ERLQh7w54kmMfhJU23YeH91ntCGMGFl+C8AQ/gPQ14A9
+sidebar_class_name: "get api-method"
+info_path: platform-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";
+import Translate from "@docusaurus/Translate";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Describe role"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"get"}
+  path={"/roles/{roleName}"}
+  context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Retrieves the details of the role identified by `roleName` in the organization identified by `orgId`.
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+>
+  <Translate id="theme.openapi.request.title">Request</Translate>
+</Heading>
+
+<ParamsDetails
+  {...require("./describe-role.ParamsDetails.json")}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+  {...require("./describe-role.RequestSchema.json")}
+>
+
+</RequestSchema>
+
+<StatusCodes
+  {...require("./describe-role.StatusCodes.json")}
+>
+
+</StatusCodes>

platform-api-docs/docs/info/parameter-tables/orgs/parameters.yml

@@ -39,3 +39,8 @@
   Req/Opt: Optional
   Description: Optional array of specific quota names to include in the response.
     Omit to retrieve all quotas.
+- Name: "`userId`"
+  Type: integer
+  Location: path
+  Req/Opt: Required
+  Description: User numeric identifier.

platform-api-docs/docs/info/parameter-tables/permissions/parameters.yml

@@ -0,0 +1,15 @@
+- Name: "`orgId`"
+  Type: integer
+  Location: query
+  Req/Opt: Optional
+  Description: Organization numeric identifier.
+- Name: "`workspaceId`"
+  Type: integer
+  Location: query
+  Req/Opt: Optional
+  Description: Workspace numeric identifier.
+- Name: "`operationId`"
+  Type: string
+  Location: query
+  Req/Opt: Required
+  Description: Operation identifier to check in the selected context.

platform-api-docs/docs/info/parameter-tables/roles/parameters.yml

@@ -0,0 +1,30 @@
+- Name: "`orgId`"
+  Type: integer
+  Location: query
+  Req/Opt: Required
+  Description: Organization numeric identifier.
+- Name: "`max`"
+  Type: integer
+  Location: query
+  Req/Opt: Optional
+  Description: "Maximum number of results to return. Default: `50`. Maximum: `100`."
+- Name: "`offset`"
+  Type: integer
+  Location: query
+  Req/Opt: Optional
+  Description: "Number of results to skip for pagination. Default: `0`."
+- Name: "`name`"
+  Type: string
+  Location: query
+  Req/Opt: Optional
+  Description: Role name search filter.
+- Name: "`type`"
+  Type: string
+  Location: query
+  Req/Opt: Optional
+  Description: Role type filter.
+- Name: "`roleName`"
+  Type: string
+  Location: path
+  Req/Opt: Required
+  Description: Role name.

platform-api-docs/docs/info/parameter-tables/roles/request-bodies.yml

@@ -0,0 +1,32 @@
+- Name: "**CreateRole**"
+  Type: ""
+  Req/Opt: ""
+  Description: Create role
+- Name: name
+  Type: string
+  Req/Opt: Optional
+  Description: Role name.
+- Name: description
+  Type: string
+  Req/Opt: Optional
+  Description: Role description.
+- Name: permissions
+  Type: array
+  Req/Opt: Optional
+  Description: List of permission names assigned to the role.
+- Name: "**UpdateRole**"
+  Type: ""
+  Req/Opt: ""
+  Description: Update role
+- Name: name
+  Type: string
+  Req/Opt: Optional
+  Description: Role name.
+- Name: description
+  Type: string
+  Req/Opt: Optional
+  Description: Role description.
+- Name: permissions
+  Type: array
+  Req/Opt: Optional
+  Description: List of permission names assigned to the role.