Skip to content
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.

Sign up for GitHub

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

Update operate-openapi.yaml #4736

Merged
merged 6 commits into from
Dec 11, 2024
Merged

Update operate-openapi.yaml #4736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e0a682a
Update operate-openapi.yaml
jonathanlukas Dec 10, 2024
283936d
formatting
jonathanlukas Dec 10, 2024
8a4845b
format
jonathanlukas Dec 10, 2024
3bc0c17
fix: applied to next
jonathanlukas Dec 10, 2024
019fa8c
fix: applied to 8.6
jonathanlukas Dec 10, 2024
134a625
removed randomly added span
jonathanlukas Dec 11, 2024
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
15 changes: 7 additions & 8 deletions api/operate/operate-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ paths:
searchAfter:
- small
- 9007199254741200
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -168,7 +167,6 @@ paths:
sort:
- field: bpmnProcessId
order: ASC
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -261,7 +259,6 @@ paths:
sort:
- field: bpmnProcessId
order: ASC
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -362,7 +359,6 @@ paths:
searchAfter:
- 1646904085499
- 9007199254743288
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -459,7 +455,6 @@ paths:
searchAfter:
- 1646904085499
- 9007199254743288
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -553,7 +548,6 @@ paths:
sort:
- field: decisionRequirementsId
order: ASC
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -645,7 +639,6 @@ paths:
sort:
- field: decisionId
order: ASC
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -737,7 +730,6 @@ paths:
sort:
- field: decisionId
order: ASC
required: true
responses:
"200":
description: Success
Expand Down Expand Up @@ -1483,6 +1475,8 @@ components:
processVersion:
type: integer
format: int32
processVersionTag:
type: string
bpmnProcessId:
type: string
parentKey:
Expand All @@ -1501,6 +1495,8 @@ components:
- ACTIVE
- COMPLETED
- CANCELED
incident:
type: boolean
processDefinitionKey:
type: integer
format: int64
Expand Down Expand Up @@ -1549,6 +1545,8 @@ components:
version:
type: integer
format: int32
versionTag:
type: string
bpmnProcessId:
type: string
tenantId:
Expand Down Expand Up @@ -1602,6 +1600,7 @@ components:
- UNKNOWN
- IO_MAPPING_ERROR
- JOB_NO_RETRIES
- EXECUTION_LISTENER_NO_RETRIES
- CONDITION_ERROR
- EXTRACT_VALUE_ERROR
- CALLED_ELEMENT_ERROR
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/operate-api/specifications/by-id.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Get decision instance by id"
sidebar_label: "Get decision instance by id"
hide_title: true
hide_table_of_contents: true
api: eJzlV1tv2zYU/isCn7bOiZw2HQpjGOAuSqHVsI3YaQcEQUFLxzEbidRIyqkh6L/vHOpix5a9bE8b+iSK537Vp4JZ/mDY4I5dQSSMUDKUxnIZAbvvMZWB5pYuYzZgiw0+eizjmqdgQZNYwSS+IFEQSUg8Zdyu8ByDibTISBovw9hTSy+ubXiiMdJjGv7MhQY0YHUOPWaiFaScDQpmNxlpNlYL+cDK8p6YTaakAUP01/0+PZ4bmuVRBMag4khJC9ISC8+yREQuEv+rIb7i0I5afIXIUoCa4raisoKBHfrSY4+w2bkXaOoBNAovlU65ra5+viROjNTCoY4eA5mnlPnrYTgKrvAi+DQc3Q7n7nw7/jiefB6702wa/BZeh3h/j/pgzZPcxXLVqfgZyzUXSa67uTBOStUVLIUUxPzxxTHVok2vvFyw6YCwO6sNeevT3zCOXfedYPiEfSqqip90783rXam5Yz1esissyCycjL/Mh+9HARJG4Ty4GY6+BH9Mb4IZkfYqt60o1RD7OE/sqdpBHMost2aHh2vNNzRlFlLzrxtXHssY2e2iIMkKm9DV/o5wLjqO1utJbv8bbmOS8wSOtI8jyRi+vagvTmSgCrdiAcml7TR4QgESiXzZtctCicGJ2KMVCcYe32mYwUUC6U//dLfRasrNC2cjxYHnD92pbvd5F9F2DtNuUgKtlW4z8eYwE9dKL0Qcg3yeg1f+q/9/uJeH4d5UBQcqvVG5jsCTynpLlcv4++iCt13zMJyG3k7AHjiB7yAfhCIgyrWwG4e5FsA16DOHQe7we1JgCtSjAPd2v4+9PoA9RF7eYuM5zIZQbqUI3j2ASwWhtwHz1xd+I3PWyBi/EHHJyBm9bvBfrhPkL6rklgPfL1bK2HJQZEpbYl5zLTgWwmWUaFVhl9x9AVmiIp64632/5yvwiECrn9CjxXdqgcr6ucMhaOO5unf9d/1OTcR6RMu2MbZ6VtZmnXoq5k5NDqI2hZoRXxV0U5ztJzETBJmarxqbTBE8zIOzWQsdHJKu5dDD3YK3WmoXnUP0XjGxhvu66dXfP89dXwm5VE687q+JQ/fgTfMFzgyFchiw8rjD0/iwYg0el7EXqTRLgLZTDQPbpqKT16jFWfFShShOUWc7SatVTp2wUspWgIpGF1WTW1UjUVAGu+jp6ek84ikuPH6OBikJ6CQg9ifeOm+j+qa3JxyryLTSQrl3X8MSNKCXfq3I+A4/NACRXZz3z/tVVxmbcrlj6PQIPctZWx4L36yfJRxLWdYOFvV43bH1Bduize2A4eUAVWIbVYNyx4piwQ3c6qQs6Rq/C9oN/Xau3BTGwtAZ53jJEwMHPrUrkv1wU/9w/egd/ynrDKFpXrlhLexirP4VItxWErRdAY+xC8mpijDEBsrsjsjB3xiNTbuGPgRz5OU55anN5V5rO+2d7vzy3jF4c/UI8tfWOUuv5F9Z/gXHqxkU
api: eJzlV21v2zYQ/ivCfVo7JXLadCiEYoBbK4VWwwlipx0QBAVNnWM2EqmSlFND0H8fjnqxY8tetk8b+skS74V3z734UQmW3RsIb2GEXBihZCyNZZIj3PmgctTM0mECIczXcQI+5EyzDC1qMitBsgwhBEEiISGEnNkl+JCg4VrkZA0hxImnFl7S3OGJ9hIfNH4vhMYEQqsL9MHwJWYMwhLsOifPxmoh76Gq7kjZ5EoaNCR/NRjQz9OLpgXnaAz4wJW0KC2psDxPBXeZBN8M6ZX796j5N+SWEtSUtxX1LSLpicWHB1xvnQtp8R41+LBQOmO2PvrtnDSNZRb3ffiAssgI+YthPI5G4EP0eTi+Gc7c883k0+Tyy8Q9Ta+iD/FFHI3grvIBVywtXC6jXsdPVC6YSAvdr5VrRVCNcCGkIOVPz86pMW175fmGbQfE/ai24k1Mf6M4cd13ROEzaiPqih8N7/WrbauZUz1cslH0IZ7Gl5Ovs+H7cQQ+jONZdD0cf43+vLqOpiTaqdymolRDjaZI7bHaYRLLvLBmS4dpzdY0ZRYz868bVx5CjO7tk1Q+WGFTOtrdES5Ep9FFfVnY/0bYPugixQPt40QywR/P6osjCNTp1ioombS9Fx5xAFVF4vO+XRbLFUtF4tGKRGMP77Rcq3mK2a//dLfRairMM2cjQ2PYfT/U3T7vE9reYdoGJdJa6Q6J1/tIXCg9F0mC8ikGL4OX//90z/fTva4LjlR6owrN0ZPKegtVyOTn6II3ffMwvIq9rYQ9dAY/AR7EIpAXWti141xzZBr1ieMgt3eVXwJX6kGge7vb5V4f0e4zL2++9hxny9AuFdG7e3RQEHsLIVidBa3NSWtjglIkFVAwetXyv0KnEEJZg1uFQVAulbFVWOZKW1JeMS3YPK2xJVld2AVz/4CQKs5Sd7wb92yJHglo9RN7tEv0qAXq208dD1F6x93bwdtBrydSPeBl0xgbP0tr814/tXKvJ0dR20JNSa9Oui3O5i8xF0SZ2n81uLyKroez6GTaUQfHpBu7yn9S8M5LE6ILiN5rJWi1L9pe/ePLzPWVkAvlzJv+unTsHr2rYp4KTqnsJ6w85vi0x7gVK/SYTDyusjxF2k4NDeyaip681u1CaS9TUlhFne0srVYFdcJSKVsTKhpdxl0N60aipEwYBI+Pj6ecZYVM2ClXGYGQCo7SOBwb3MbNib9jnChuOmuh3HugcYEaJcegcWQCxx9agghnp4PTQd1VxmZMbl10fISeYNaVx+IPG+QpE5J8ugDLZrxuYXUGG7a5GTDwIRQJfXrVg3ILZTlnBm90WlV0/L1A7YZ+M1duChNh6DmBcMFSg3sxdSsSfrluPrheeIc/ynpTaJtXrqGjXQDNpxDxtoqo7RJZgtoFVQuGnGNut0z2vsZobLo19DGagQ+sIJw6LHda23nvDefde6fgzdQDyt+74Cy9UnxV9RfHqxkU
sidebar_class_name: "get api-method"
info_path: docs/apis-tools/operate-api/specifications/operate-public-api
custom_edit_url: null
Expand Down
4 changes: 2 additions & 2 deletions docs/apis-tools/operate-api/specifications/by-key-1.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Get process instance by key"
sidebar_label: "Get process instance by key"
hide_title: true
hide_table_of_contents: true
api: eJzlVllv4zYQ/isEn/ZwLGc3LRZGsYA3cRZu0sSI3e1DEBSUNLa5kUiVpJwagv57Z6jDjq0E3sdi/WDxmHu+4UzBnVhaPrznU6MjsHairBMqAv7Q4zoDI5zUahLzIQ83V7D5+5T3eCaMSMGBIcaCK9zg/SNs8E4qXGbCrXAdg42MzEgCHiI30wuWVXqYbBT1uIF/cmkAlTiTQ4/baAWp4MOCu01GoqVysASDpAttUuGqo1/PeFk+ELvNtLJgiePDYECf56pneUQ6kT/SKEo5IhFZlsjI+xd8t0RXHGrW4XeIHPlsKBpOVlrI12PM83yk+hsGS1Y6XmX6+IGYwixVTT7iHR7rjFRLL1YYdOPqeDM8/WWin250DE2Sj+dHeuMuhINOa0DFL94hZ9cNMeUpAW90Pp98G+PB+e0f0+vxfHxB69HN+fgalw/bGF7AQipJ+Trebky2UO7VIO4B38vmkTRRngjzZu/2rRcqXUKS9kumxF+Pn3UhcKLWIpExI6iDdS8jEX0NE0jf/ygiKcy5PRJfKVotlt35auuy67I6OLjYicnYGG3aSHw8jMSlNqGMY1DPY/AuePf/d/fs0N27KuFAqbc6NxEwpR1b6FzFPwcKfumqh9F0wnYcZuAZfoJ40IsIUW6k2/jmGQI+QubEN5R7fOwKDIF+lOB3D/s99Cu4gwbKwg2rei/25JWmVr0EHwrqwkMerE+Dmuek4bFBgSwlJ2PMumnkuUmQvqiCWw6DoFhp68phkWnjiHgtjBSYCB9RuqsSuxB5QpFMdCQSf7xv93wFjC5oVKAhwOGeIFBp7/vHGHU8F/dp8GnQKYlIX5CyBcZWzsq5rFNORdwpyQ8WTaJmRFc53SSnTbbI5JUPfj0F3U7Hd6P5+GQ2ns0mtzfNRFTzUW/fSXgrpTbRG0T7iog31JcNVn//a+5xJdVCe/YaX7d+UgM2zUOsGXLl0GHNhJ+C8OPkGphQMYt0miVAr9M+qmjFGrFYKyzV2Hs1IdtzOqNzQsJKa1f1cypdFE1mVUAipyyi6OnpqR+JFB880UeFFAQ0EnBiI9o6btf1SW+POdaRbbml9vvAwAKwdUcQ1IJsQFLXzZDFT/uD/qBClXWpUDuKXi+hZzFr0+PgXxdkicBUlrWBRV1e93x9ytsRZVtgeDYkkQijqlDueVGEwsKfJilLOsa+YHzRb+vKV2EsLa2xjhcisXBgU/tE8jd39eD8lr08XHe60IBXbXxVJzntcOlR6f9LGrxWIGKEIVlV3YwQQZnb4TkYoqlu2nfo63iOtCKnQLXB3MO2l95pz29fPAGb60dQn1vrHG3JvrL8DzUuW/w=
api: eJzlVt9v2zYQ/leIe2o7JXLabiiEYUCWOIWXNAkSr3sIjIGizjYbiVTJkzND0P8+HCU5jq0E2ePQF1sS77uf3/GuBpILD8kdXDur0PuJ8SSNQphFYEt0krQ1kwwSSNfnuP77CCIopZMFEjoG1mBkgZDAPa4hAm0ggVLSEiLI0CunS9YACZzjWti5KFs7QveGInD4vdIOM0jIVRiBV0ssJCQ10Lpk1doQLtBBBHPrCkntp18+QtPMGO5Lazx6RrwfjfjvqenbSrFNiEBZQ2iIRWRZ5lqF+OJvnuXqfcs2/YaKOGbH2SDdWuFYX+NewLHpr+i8bm28CPrwfh80lYstnCenzYKl0rIwfdWyQYlSOjR0/npng/xZbh8ubYY9FV6P9yQdnUrCQW/QZM+eeRo8YVBVMD2PT6aTr2OI4OTqy/XFeDo+5efjy5PxxfgUZg0zT+msq22nJbU2R2m2UnqKc2001/z1UREaaejFFO80T9ANSjtV5dK92Tl9G5RqylnTbts1TdNE8HGIxROzkrnOBLcLenqezaWzaY7FT/+V1VyEyr+SowV6LxfD1dz09tBh+2HvYCsnY+es22Tiw34mzqxLdZaheZqDd/G7/3+4H/fDvWkLjlx6byunUBhLYm4rk/0YLPh5qB+OrydiK2CBAfAD5IPvS1SV07QOAzhF6dAdhKF0N2uiGpS19xrD22x3Dn9G2hvCIl2Ldn4XSEvL436BIRU8yROIV0dxhznoMT6u73HdADvjVv0yULkcEqjb5DZJHNdL66lJ6tI6YuGVdFqmeZtbPmsLO5dVzpnMrZJ5+Lzr93SJgg943eBFgpYomAKt9cNwGVu3o+7T6NNoUBOLPqPlkRiPepZE5aCeVnhQU1hO+kLdslwbdF+cTbFlqc9D8rtN6up6fHM8HR/cjm9vJ1eX/VbV4XjybxV8o6VzMTgUhl8Qgl76rOfqH39NA6+0mdsA7/h1FbY9FNdVmmvFoewHbIUMm5SQivQKhTSZULYoc+TbaZdV/CR6tXPrRGGNJsvMDkhytmImLK2ldtpz60oVatgSiYPySRw/PDwcKllUJpOHyhachFwrND7kscvbRfcl2gFnVvkNWtvwHjuco0OjMO4U+Zi1rvpFDY4OR4ejllWeCmm2DL3cQk9ytikP4T8Ul7nUYR0JDtZde93B6gg2K8pjg0EECaucRV2j3EFdp9Ljny5vGv78vUIXmv6xr0IXZtrzcwbJXOYe93zaXJHw5qZbvt+K5xf0wRB68pp16Oq84jeI2t04/Da8li1RZuiCV+3JsVJY0hZmbxHnvtncQ5/HU4hAVpyox8XuKbeD9kF/fv09CIipvUfz28Y74lf2r2n+BXkpdA4=
sidebar_class_name: "get api-method"
info_path: docs/apis-tools/operate-api/specifications/operate-public-api
custom_edit_url: null
Expand Down Expand Up @@ -40,7 +40,7 @@ Get process instance by key

Success

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processVersion"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"bpmnProcessId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"parentKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"parentFlowNodeInstanceKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACTIVE`, `COMPLETED`, `CANCELED`]"} schema={{"type":"string","enum":["ACTIVE","COMPLETED","CANCELED"]}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"parentProcessInstanceKey"} required={false} schemaName={""} qualifierMessage={undefined} schema={"circular(ProcessInstance)"}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"key\": 0,\n \"processVersion\": 0,\n \"bpmnProcessId\": \"string\",\n \"parentKey\": 0,\n \"parentFlowNodeInstanceKey\": 0,\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"state\": \"ACTIVE\",\n \"processDefinitionKey\": 0,\n \"tenantId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processVersion"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"processVersionTag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"bpmnProcessId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"parentKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"parentFlowNodeInstanceKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACTIVE`, `COMPLETED`, `CANCELED`]"} schema={{"type":"string","enum":["ACTIVE","COMPLETED","CANCELED"]}}></SchemaItem><SchemaItem collapsible={false} name={"incident"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"parentProcessInstanceKey"} required={false} schemaName={""} qualifierMessage={undefined} schema={"circular(ProcessInstance)"}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"key\": 0,\n \"processVersion\": 0,\n \"processVersionTag\": \"string\",\n \"bpmnProcessId\": \"string\",\n \"parentKey\": 0,\n \"parentFlowNodeInstanceKey\": 0,\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"state\": \"ACTIVE\",\n \"incident\": true,\n \"processDefinitionKey\": 0,\n \"tenantId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Invalid request

Expand Down
Loading
Loading