Merge branch 'main' into mes-364-styling-improvements

api/camunda/camunda-openapi.yaml

@@ -1,3 +1,5 @@
+# Disclaimer: This is a modified version of the Camunda REST API specification, optimized for the documentation.
+
 openapi: "3.0.3"
 info:
  title: Camunda 8 REST API
@@ -3004,19 +3006,34 @@ components:
  description: The tenant ID of the decision requirements.
  EvaluateDecisionRequest:
  type: object
+ oneOf:
+ - $ref: "#/components/schemas/EvaluateDecisionRequestByKey"
+ - $ref: "#/components/schemas/EvaluateDecisionRequestById"
+ EvaluateDecisionRequestByKey:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/EvaluateDecisionRequestBase"
  properties:
  decisionDefinitionKey:
  description: |
  The unique key identifying the decision to be evaluated.
  Cannot be used together with decisionDefinitionId.
  type: integer
  format: int64
+ EvaluateDecisionRequestById:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/EvaluateDecisionRequestBase"
+ properties:
  decisionDefinitionId:
  description: |
  The ID of the decision to be evaluated.
  Cannot be used together with decisionDefinitionKey. When using the decision ID, the latest
  deployed version of the decision is used.
  type: string
+ EvaluateDecisionRequestBase:
+ type: object
+ properties:
  variables:
  description: The message variables as JSON document.
  additionalProperties: true
@@ -3532,13 +3549,25 @@ components:
 
  CreateProcessInstanceRequest:
  type: object
+ oneOf:
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestByKey"
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestById"
+ CreateProcessInstanceRequestByKey:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestBase"
  properties:
  processDefinitionKey:
  description: |
  The unique key identifying the process definition, e.g. returned for a process in the
  deploy resources endpoint. Cannot be used together with processDefinitionId.
  type: integer
  format: int64
+ CreateProcessInstanceRequestById:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestBase"
+ properties:
  processDefinitionId:
  description: |
  The BPMN process ID of the process definition to start an instance of.
@@ -3551,6 +3580,9 @@ components:
  type: integer
  format: int32
  default: -1
+ CreateProcessInstanceRequestBase:
+ type: object
+ properties:
  variables:
  description: |
  JSON object that will instantiate the variables for the root variable scope

api/camunda/generation-strategy.js

@@ -2,47 +2,214 @@ const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge")
 const replace = require("replace-in-file");
 const outputDir = "docs/apis-tools/camunda-api-rest/specifications";
 const specFile = "api/camunda/camunda-openapi.yaml";
+const fs = require("fs");
 
 function preGenerateDocs() {
- hackChangesetDescription();
+ const originalSpec = fs.readFileSync(specFile, "utf8");
+
+ console.log("adjusting C8 spec file...");
+
+ const specUpdates = [
+ addDisclaimer(),
+ ...redefineCreateProcessInstanceRequest(originalSpec),
+ ...redefineEvaluateDecisionRequest(originalSpec),
+ ];
+
+ replace.sync({
+ files: specFile,
+ from: specUpdates.map((x) => x.from),
+ to: specUpdates.map((x) => x.to),
+ });
 }
 
 function postGenerateDocs() {
  removeDuplicateVersionBadge(`${outputDir}/camunda-8-rest-api.info.mdx`);
 }
 
-module.exports = {
- outputDir,
- preGenerateDocs,
- postGenerateDocs,
-};
+function addDisclaimer() {
+ // Adds a disclaimer to the very beginning of the file, so that people know this isn't the true spec.
+ return {
+  from: /^/,
+ to: `# Disclaimer: This is a modified version of the Camunda REST API specification, optimized for the documentation.
 
-function hackChangesetDescription() {
- // This is a temporary hack, until https://github.com/camunda/camunda-docs/issues/3568 is resolved.
- // The OpenAPI generator plugin we're using does not use the correct `description` property
- // for the `UserTaskUpdateRequest` object. Instead of picking up the actual property description,
- // it picks up the description of the first merged schema in the `allOf` property (i.e. from the `Changeset` schema).
- // This adjustment replaces the description of the `Changeset` schema with the current description of
- // the `UserTaskUpdateRequest.changeset` property.
- console.log("hacking changeset description...");
- replace.sync({
- files: `${specFile}`,
- from: /^ description: A map of changes.$/m,
- to: ` description: |
- JSON object with changed task attribute values.
+`,
+ };
+}
 
- The following attributes can be adjusted with this endpoint, additional attributes
- will be ignored:
+function redefineCreateProcessInstanceRequest(originalSpec) {
+ // Redefines the CreateProcessInstanceRequest schema to describe a union of two possible request bodies.
+ // This union type does not work upstream, but we can rewrite it here to more clearly describe the schema.
 
- * \`candidateGroups\` - reset by providing an empty list
- * \`candidateUsers\` - reset by providing an empty list
- * \`dueDate\` - reset by providing an empty String
- * \`followUpDate\` - reset by providing an empty String
+ if (originalSpec.includes("CreateProcessInstanceRequestBase")) {
+ // Make this a repeatable task by checking if it's run already.
+ console.log("skipping redefineCreateProcessInstanceRequest...");
+ return [];
+ }
 
- Providing any of those attributes with a \`null\` value or omitting it preserves
- the persisted attribute's value.
+ // Diff created by these changes:
+ // CreateProcessInstanceRequest:
+ // type: object
+ //+ oneOf:
+ //+ - $ref: "#/components/schemas/CreateProcessInstanceRequestByKey"
+ //+ - $ref: "#/components/schemas/CreateProcessInstanceRequestById"
+ //+ CreateProcessInstanceRequestByKey:
+ //+ type: object
+ //+ allOf:
+ //+ - $ref: "#/components/schemas/CreateProcessInstanceRequestBase"
+ // properties:
+ // processDefinitionKey:
+ // ...
+ //+ CreateProcessInstanceRequestById:
+ //+ type: object
+ //+ allOf:
+ //+ - $ref: "#/components/schemas/CreateProcessInstanceRequestBase"
+ //+ properties:
+ // processDefinitionId:
+ // ...
+ // processDefinitionVersion:
+ // ...
+ //+ CreateProcessInstanceRequestBase:
+ //+ type: object
+ //+ properties:
+ // variables:
+ // ...
+ // tenantId:
+ // ...
+ // ...
 
- The assignee cannot be adjusted with this endpoint, use the Assign task endpoint.
- This ensures correct event emission for assignee changes.`,
- });
+ return [
+ // 1. Convert the main request to a oneOf union and define the first possible type.
+ {
+ // match the start of the CreateProcessInstanceRequest object
+ from: / CreateProcessInstanceRequest:\n type: object/m,
+
+ // append the `oneOf` declaration to define the union type.
+ // Then a definition for the first possible type, so that it includes the `processDefinitionKey` property.
+ to: ` CreateProcessInstanceRequest:
+ type: object
+ oneOf:
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestByKey"
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestById"
+ CreateProcessInstanceRequestByKey:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestBase"`,
+ },
+
+ // 2. Define the second possible type, to include the `processDefinitionId` property.
+ {
+ // match the start of the CreateProcessInstanceRequestByKey object, up until the `processDefinitionId` property (non-inclusive).
+ from: / CreateProcessInstanceRequestByKey:[\s\S]*?(?=\s*processDefinitionId:)/m,
+
+ // append the second possible type definition, so that it includes the `processDefinitionId`.
+ to: `$&
+ CreateProcessInstanceRequestById:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/CreateProcessInstanceRequestBase"
+ properties:`,
+ },
+
+ // 3. Define a base type to contain the common properties, starting before the `variables` property.
+ {
+ // match the start of the CreateProcessInstanceRequestById object, up until the `variables` property (non-inclusive).
+ from: / CreateProcessInstanceRequestById:[\s\S]*?(?=\s*variables:)/m,
+ // append the base type definition, so that it includes all remaining properties.
+ to: `$&
+ CreateProcessInstanceRequestBase:
+ type: object
+ properties:`,
+ },
+ ];
+}
+
+function redefineEvaluateDecisionRequest(originalSpec) {
+ // Redefines the EvaluateDecisionRequest schema to describe a union of two possible request bodies.
+ // This union type does not work upstream, but we can rewrite it here to more clearly describe the schema.
+
+ if (originalSpec.includes("EvaluateDecisionRequestBase")) {
+ // Make this a repeatable task by checking if it's run already.
+ console.log("skipping redefineEvaluateDecisionRequest...");
+ return [];
+ }
+
+ // Diff created by these changes:
+ // EvaluateDecisionRequest:
+ // type: object
+ //+ oneOf:
+ //+ - $ref: "#/components/schemas/EvaluateDecisionRequestByKey"
+ //+ - $ref: "#/components/schemas/EvaluateDecisionRequestById"
+ //+ EvaluateDecisionRequestByKey:
+ //+ type: object
+ //+ allOf:
+ //+ - $ref: "#/components/schemas/EvaluateDecisionRequestBase"
+ // properties:
+ // decisionDefinitionKey:
+ // ...
+ //+ EvaluateDecisionRequestById:
+ //+ type: object
+ //+ allOf:
+ //+ - $ref: "#/components/schemas/EvaluateDecisionRequestBase"
+ //+ properties:
+ // decisionDefinitionId:
+ // ...
+ //+ EvaluateDecisionRequestBase:
+ //+ type: object
+ //+ properties:
+ // variables:
+ // ...
+ // tenantId:
+ // ...
+ // ...
+
+ return [
+ // 1. Convert the main request to a oneOf union and define the first possible type.
+ {
+ // match the start of the EvaluateDecisionRequest object
+ from: / EvaluateDecisionRequest:\n type: object/m,
+
+ // append the `oneOf` declaration to define the union type.
+ // Then a definition for the first possible type, so that it includes the `decisionDefinitionKey` property.
+ to: ` EvaluateDecisionRequest:
+ type: object
+ oneOf:
+ - $ref: "#/components/schemas/EvaluateDecisionRequestByKey"
+ - $ref: "#/components/schemas/EvaluateDecisionRequestById"
+ EvaluateDecisionRequestByKey:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/EvaluateDecisionRequestBase"`,
+ },
+
+ // 2. Define the second possible type, to include the `decisionDefinitionId` property.
+ {
+ // match the start of the EvaluateDecisionRequestByKey object, up until the `decisionDefinitionId` property (non-inclusive).
+ from: / EvaluateDecisionRequestByKey:[\s\S]*?(?=\s*decisionDefinitionId:)/m,
+
+ // append the second possible type definition, so that it includes the `decisionDefinitionId`.
+ to: `$&
+ EvaluateDecisionRequestById:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/EvaluateDecisionRequestBase"
+ properties:`,
+ },
+
+ // 3. Define a base type to contain the common properties, starting before the `variables` property.
+ {
+ // match the start of the CreateProcessInstanceRequestById object, up until the `variables` property (non-inclusive).
+ from: / EvaluateDecisionRequestById:[\s\S]*?(?=\s*variables:)/m,
+ // append the base type definition, so that it includes all remaining properties.
+ to: `$&
+ EvaluateDecisionRequestBase:
+ type: object
+ properties:`,
+ },
+ ];
 }
+
+module.exports = {
+ outputDir,
+ preGenerateDocs,
+ postGenerateDocs,
+};

api/zeebe/generation-strategy.js

@@ -1,3 +1,4 @@
+const replace = require("replace-in-file");
 const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge");
 
 const outputDir = "docs/apis-tools/zeebe-api-rest/specifications";

docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx

@@ -5,7 +5,7 @@ description: "Iterate through all known partitions and activate jobs up to the r
 sidebar_label: "Activate jobs"
 hide_title: true
 hide_table_of_contents: true
-api: eJztWVtvGzcW/isHfNkYO5aUbtqmaruAaqdbZVvXsJW2gO0HzsyRhjaHnJAcyaqg/14ccm6SRomC7r7FgGDN8PBcv3MhtWGOLywb37G3OmYPEUvRJkYUTmjFxmzq0HCH4DKjy0UGXEp4UnqloODGCaKywFUKPHFiSZSPOrZQFuA0uAzB4PsSrcMUcv4s8jIf3CsWser1Dzpds/HGPwqDKRs7U2LEEq0cKkdLvCikSDhJGj5aUmrDbJJhzumbWxfIxkzHj5g4FrHC6AKNE2jb1c2eTaTWo46BViPgFlKcC4UpCOVV/uH6lysojE7QWniBg8UAvvsTMcax4/bpkoi94Z7B9/es4OsclTu3aJYiwXsGw3+feSsr7awzQi3YNmIrbZ7Q9KukeI6g516FQFc7VagFVErbCHJtnVxDaTGFuTYg9WJBFEVpCm3RHsiNmCql5LHE4N5txJzIUZfuUBHuPWPQlYY8wucODbhMWEgo9CshJSjtIMYm4inEa+BKuwxNoCqVE9JrXMmBF0JBbs8g4xZiRAUGeZJh2vWSUA4XaFjE5trk3IVXX70iv+X8+a2O7UxPKqH9LqwgFjDodAvKeB2MqGD3MaH/+oKEztEl2W/ciOC6Q1dJYR1FbFnReJl+F6Gqhlmz+i2IOWBeuHXk82gprIgldrZz13iN+Nbh18oHmpZsoosGJcTdRyTGJmRdj3Jj+Pog/BETDvNOfjT43DZ5OTuGj1mb0o3oROeFRALCKkNFRkjk5BkVVBS2gxVtGlA1nGa7KBnAdN63/D2MIuCUrbyUrsGWsD4Xju36jnZJTQmipaREERZSYckhqS9dnU201poj8hxTwR3KdQS4RBUMVPrArMFJQKbi6nVn41FfUqLiyk1T+yGsTS+tD7+ntR4Xq0wk2Q7cCf+HMDgW9gNVKhyEgnwXyNua0ZeND7TsiAG1kUmD25sq37bbwNQWWtlQm78YjfrhVVvaYobMGbBP6AqnMm19dKSBeKLWY8c8eWT3E67769QTUgmAUon3JYJIUTkxF2iaNH/U8WmF8XiHo5VuoXhhM11KasNUn1YZd7Ditu3PZ339quqCU2UdVwn+95hBjzr+h216pqjIyc7TzKh2tr11mvYLiotcNXKmlx0DO/LThs0HbGpl/YbGigChQ4HLsHi6oA91lAPRRx36hOu/KzJ4FiXScHLMn9xanQifEDTcQEUO08s+19XMPgaHCthkRAXudT3D7AmMatqVcFk1f+30uH1MnToxJKV1Ov8JeYqmt6Ba9AUh0EEWCJtRMC3JZsh1ir5pfNuZiSzQbiO4FH9iCm9vf72CVCcluaanovA09fHi8rpTHaqa/4kDYSj1bRHzQ81OsWiDZdCZqhD1xD3XpfIOqMhA4tyFoT2wbAoGlyu+prENCm2FE0s8Ow3tKfJUCtVTn3wbrQtTwtXuOMkXXKgILOHQO/vd1fQPwEJTlxM5Wsfz4jQUNKPVoQ4TmsCayauexapTi88Fj8PIzwOl18t1JzLS5FOjXXf4/h7VlrNAB46KtF4pe9gTOiNb3XjrZpzSQW7bXdlryaEJVz351bE2XBi9FCmlAnechh0a+5dcimrYOdKMC6Njifk/P9aUJ3AdKCFFx4WE4MFwHCPCOBzI7m5+vIBvXn359cOLzLnCjofD1Wo1MPPkHFPhtBlosxiaeUIfojsbwCxDQ4eBtcdVExBouzPYAhMxF0kd8Ept3zV3hrmPnCz3T1oNBEsj2P5hegLvbqYHFXFHdHdGZDzWpRvHkqsn1obzUOi+FFvmOTfrTgntCNhGzDruyu78cjSL93kTMH6aza4hsIBEp1gNLcLWgsiIXCg6ibHxq9HID4zh6avRyBcGivgJlijA50JyFTJuzxw6LGiDFX68YXWT+B9FRhuxEPtyBztJV4H4MlgUUurLvpSaKCAvG8IhGqMN6CQpjfGnJiGbRlfLruayz7n2Odc+59qxXKObIXSZTtmYFdrf6xTcZWzMhnRyG7btmkWMruf8LHi3YaWRbMw2IWG24+Fwk2nrtuNNoY3bDpcUjZ3ZgZZDYtWAkTrhMgtCDwNHC9357YLnpUo5vIabN7cz+A93uOJr70gSucv69ej1qJcrkR7hOLmeQrAwwK5TCmq2lNO9bAPxKYy32wdyZFIa4da3tC24J0Zu0ExK8n0Dh0qe507PgYhF1Zcfa5C8/X3m40xl7Ka9F37zzOkipg9f9dTcvmkuNEe9l4Wjg9u8u3rvw+Gl12jnLqal9Kifa69RhclDZxFy6gMlGw1eHuL/eurTONF5Xipfy9XCn3+Ad5yfyNI6cnrEpEiQJrbxhhGmOmJ/DitQHWHh5YCAE9Bdl/CFcFkZDxKdD5OwrfkfSx0Pcy7UsBJhhxeTX95dXU7Of55evLm6fXP+cjAauGfnA0QplnPV0WOyd+O0Y+mm7Vv/t98RKmQ4fHbDQnKhCPze/k1VCu5YpVunGDxEVULfsc0m5hbfGbnd0uv3JZo1G989tPlPT9uIhROirx7+XoddBOPOZ+F6bMll6e+I9m+mtlG9Y5IkWLgP0j50Ktr1r7czypbqNxI6i7IxM3xFv5/wFRuze3bPWMS0d7hPRP9+wyRXi5IviD7wpb+/APJLCPs=
+api: eJztWVtz2zYW/isYvmwylSW1m7ZZ9TKj2mmrtHU9ttLdGccPIAlJiEmCBUDJqkb/vd8BeJNIJcrs7lucsSMSB+f6nQugXWD50gST++C1CoOHQRALE2mZW6myYBLMrNDcCmZXWhXLFeNJwh4ztclYzrWVRGUYz2LGIyvXRPlOhYYVObMKmwTT4s9CGCtilvInmRbp8G0WDILy9Q8q3gaTnXuUWsTBxOpCDIJIZVZklpZ4nicy4iRp9M6QUrvARCuRcvpkt7mAmip8JyILvrlWuYBiwjSruyObSC1oyWh1wLhhsVjIDBrKzKn8w81v1wyMImEMeyaGyyH79i8hQjGx3DxeEbEz3DH47m2Q820KZS+M0GsZibcBG33/3FlZamesltky2A+CjdKPQverlPFUMLVwKni6yqnYzEqlzYClythkywoDjRdKs0Qtl0SRFzpXBoYfyx0EWZEkPEyEdy/0sDIVqrBdRbjzjBa20OQRvkD8IVsaFlHoNxJ/MmVZKOqIxyzcAgIKGmpPVWRWJk7jUg57Btem5jlbwduhEBkkcMQwbntJIuRLOGcQwKqUW//qqxfkN2AH8DRzNS2F9ruwhJjHIABYgxIaOiNK2H1I6D+/IKELYaPVH1xL77quqxJpLEVsXdI4mW4XoaqCWb36DZMLJtLcbgcuj9bSSLxvbee29hrxrcIPqFGgaclEwHeFEuLuIhKKOmRtj3Kt+bYT/kEgrUhb+VHjc1/n5fwUPuZNSteiI5XmiSAgbFYILYxIBCfPZF5F+L3BCuyoQFVzmh+iZMhmi77l79gYjqNs5UVia2yBPeXCqV3f0q5EUYKoJKFEwYZYGnJI7EpXaxOtNebINBWxhNoJIibWsM0ZmKmOWcOzgEzF1ekeTMZ9SSkyntlZbN6HtdmVceF3tMbhYrOSQFwb7oT/LgxOhb2jSokDX5DvPXlTM/qy8YGWLTGgNjKtcXtb5tt+75maHP3C1+YvxuN+eFWWNpghc4bBR3SFc5k2PjrRQBxR47FTnjyx+1Fs++sUFgjJRSbhHiZjGCUXEklRpTnknlcYT3c4WmkXimdmpYqE2jDVp80KabrhpunPz/v6VdkFZ5mxPIvEL6cMgoB/mLpnypKc7DzPjHJn01tncb+gME+zWs7sqmVgS35cs3mPTY2sP4Q20kOoK3DtF88X9L6O0hF90qHw3H8r0ntWJIKGk1P+5MaoSLqEoOGGleRwbZ/rKmYfgkMJbDKiBPe2mmGOBA4q2o1Eg866Pe4YU+dODFFhrEp/FjxGAPsKqhGuIHg6tvKE9SgYF2QzZq1YuKbxTWsmQt3HbvTsRP6F59d3v1+zWEUFuaanovA4dvHiyU2rOpQ1/yMHQl/qmyLmhpqDYtEECwrrshD1xD1VmNKIe0mGnr2wfmj3LOuCwZMN39LYhgZqYMlaPD8P7TF8Ct/11CfXRqvCFPHscJzkSy6zAVwMBZ2z31zP/sNErqjLoQkBCGl+Hgrq0aqrw5QmsHryqmax8tTicsHhcODmgcLpZdsTGWnysdGuOnx/j2rKmafDR4jEWct0e0JrZKsab9WMYzrI7dsrRy3ZN+GyJ7841YaReGskL1KBW07DDo39a2C+HHZONGNsgx/Tzz7UlKfsxlMi5SzHccF70B/HiDD0B7L72x8v2b9efPn1w7OVtbmZjEabzWaoF9EFZjOr9FDp5QiP9Et0GB+hvqbDwNbhqg4Ia7ozM7mI0HKjKuCl2q5rHgxzHzhZHp+0agiifgTHh+kpe3M761TEA9HtGTHgIeatSZjw7DFowtkVeizFFGnK9bZVQlsCwAgJZIv2/HIyi495EzB+ns9vmGeB3IhFObRIUwkiI1I0KZzEggnw5QZG//TVeOwKA0X8DEsyJp5ymO8z7sgcOiwoxNlzc4ZVTeJ/FBmlJU7WR3KHB0lXgvjKW+RT6su+lIIt5GVNOBRaw2Uqigqt3alJJnWjq2SXc9mnXPuUa59y7VSu0c2QsCuFhhpgOHHQ4XaFpxGd3EZNu8YKXc+5WfB+B73gkmDnE2YPnO9W2L6f7HKl7X60pmgczA607BOrAkyiIp6svNBu4GihPb9d8rTIYs5esttXd3P2E/o0pirnSBJ5yPrl+OW4lyuRnuA4vZkxb6GHXasUVGwpp3vZeuJzGO/3D+RIFC5pt3e0zbsnFFwLPS3I9zUcSnmOOz17IrzxH36sQPL633MXZypjt8298KsnThcxffiqpubmTX2hOe69LBx3bvPuq70P3Uuv8cFdTEPpUL9QTqMSk11nEXKqA2UwHn7exT8cSmmMuRJ7XS1HDtD5B6Nuwy9KcDIhpw8CFHxBExvkEqZaYn/1K6w8wrLPhwQcj+6qhC/BuQiHEDeK/Lb6/zBR4SjFtD0qRZjR5fS3N9dX04tfZ5evru9eXYDj0D5ZFyBKsZRnLT2mRzdOB5bumr71f/seoUSGFU92hOolMwK/s39XloL7oNStVQwQc5/Q98FuF3Ij3uhkv6fXEKJxqL1/aPKfnsDUnxBd9XD3OsGlN+5i7q/HMBoX7o7o+GZqP6h2TKNI5Pa9tA+tinbz+92csqX8joTOonir+Ya+P8HfSfAW//CgnMNdIrr3uwB1fFnwJdF7vvTzN/JLCPs=
 sidebar_class_name: "post api-method"
 info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
 custom_edit_url: null