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.

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

merged 6 commits into from
Dec 11, 2024

Conversation

jonathanlukas
Copy link
Contributor

@jonathanlukas jonathanlukas commented Dec 10, 2024

Description

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

prettier

[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- field: name
order: DESC


[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

- field: decisionId
order: ASC


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of variable
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶

'200':
description: Success. Returns statistics for the given process instance,


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process definition
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process definition
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of incident
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of flownode instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of decision requirements
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of decision requirements
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: id
in: path
description: Id of decision instance
required: true
schema:
type: string


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of decision definition
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- ACTIVE
- MIGRATED
- RESOLVED
- PENDING


[prettier] reported by reviewdog 🐶

- ACTIVE
- COMPLETED
- TERMINATED

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

prettier

[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

description: Search process instances, sort descending by name list


[prettier] reported by reviewdog 🐶

- field: name
order: DESC


[prettier] reported by reviewdog 🐶

description: "Search process instances,sort by name and page results


[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

- Called Process
- '2251799813687281'
'Filter and sort ':


[prettier] reported by reviewdog 🐶

- field: bpmnProcessId
order: ASC


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- field: creationTime
order: DESC


[prettier] reported by reviewdog 🐶

description: Returns incidents filtered by 'type'. Field 'message'


[prettier] reported by reviewdog 🐶

description: Filter by 'type' and 'processDefinitionKey', sorted descending


[prettier] reported by reviewdog 🐶

processDefinitionKey: '2251799813686167'


[prettier] reported by reviewdog 🐶

- field: creationTime
order: DESC


[prettier] reported by reviewdog 🐶

description: Returns paged by using previous returned 'sortValues'


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

description: Returns incidents filtered by 'type' and 'processDefinitionKey',


[prettier] reported by reviewdog 🐶

processDefinitionKey: '2251799813686167'


[prettier] reported by reviewdog 🐶

- field: creationTime
order: DESC


[prettier] reported by reviewdog 🐶

- 1646904085499
- 9007199254743288


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

description: Returns all flownode instances (default return list size


[prettier] reported by reviewdog 🐶

- field: endDate
order: DESC


[prettier] reported by reviewdog 🐶

- field: startDate
order: DESC


[prettier] reported by reviewdog 🐶

description: Returns paged by using previous returned 'sortValues'


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

description: Returns flownode instances filtered by 'incident' , sorted


[prettier] reported by reviewdog 🐶

- field: startDate
order: ASC


[prettier] reported by reviewdog 🐶

- 1646904085499
- 9007199254743288


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- DecisionRequirements


[prettier] reported by reviewdog 🐶

description: Search decision requirements and return list of size


[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

description: Search decision requirements, sort descending by name,


[prettier] reported by reviewdog 🐶

- field: name
order: DESC


[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

- Invoice Business Decisions
- '2251799813686550'
'Filter and sort ':


[prettier] reported by reviewdog 🐶

- field: decisionRequirementsId
order: ASC


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- field: decisionName
order: ASC


[prettier] reported by reviewdog 🐶

description: Search decision instances, sort descending by decisionName,


[prettier] reported by reviewdog 🐶

- field: decisionName
order: DESC


[prettier] reported by reviewdog 🐶

- field: decisionName
order: ASC


[prettier] reported by reviewdog 🐶

- Invoice Classification
- '2251799813686550'
'Filter and sort ':


[prettier] reported by reviewdog 🐶

- field: decisionId
order: ASC


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- DecisionDefinition


[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

description: Search decision definitions, sort descending by name,


[prettier] reported by reviewdog 🐶

- field: name
order: DESC


[prettier] reported by reviewdog 🐶

- field: name
order: ASC


[prettier] reported by reviewdog 🐶

- Decide the Dish
- '2251799813686550'
'Filter and sort ':


[prettier] reported by reviewdog 🐶

- field: decisionId
order: ASC


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of variable
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶

'200':
description: Success. Returns statistics for the given process instance,


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- ProcessDefinition


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process definition
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- ProcessDefinition


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of process definition
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of incident
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- FlownodeInstance


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of flownode instance
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- DecisionRequirements


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of decision requirements
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- DecisionRequirements


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of decision requirements
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- DecisionInstance


[prettier] reported by reviewdog 🐶

- name: id
in: path
description: Id of decision instance
required: true
schema:
type: string


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- DecisionDefinition


[prettier] reported by reviewdog 🐶

- name: key
in: path
description: Key of decision definition
required: true
schema:
type: integer
format: int64


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶


[prettier] reported by reviewdog 🐶

- bearer-key: []
- cookie: []


[prettier] reported by reviewdog 🐶

- ASC
- DESC


[prettier] reported by reviewdog 🐶

- ACTIVE
- COMPLETED
- CANCELED


[prettier] reported by reviewdog 🐶

- UNSPECIFIED
- UNKNOWN
- IO_MAPPING_ERROR
- JOB_NO_RETRIES
- EXECUTION_LISTENER_NO_RETRIES
- CONDITION_ERROR
- EXTRACT_VALUE_ERROR
- CALLED_ELEMENT_ERROR
- UNHANDLED_ERROR_EVENT
- MESSAGE_SIZE_EXCEEDED
- CALLED_DECISION_ERROR
- DECISION_EVALUATION_ERROR
- FORM_NOT_FOUND


[prettier] reported by reviewdog 🐶

- ACTIVE
- MIGRATED
- RESOLVED
- PENDING


[prettier] reported by reviewdog 🐶

- UNSPECIFIED
- PROCESS
- SUB_PROCESS
- EVENT_SUB_PROCESS
- START_EVENT
- INTERMEDIATE_CATCH_EVENT
- INTERMEDIATE_THROW_EVENT
- BOUNDARY_EVENT
- END_EVENT
- SERVICE_TASK
- RECEIVE_TASK
- USER_TASK
- MANUAL_TASK
- TASK
- EXCLUSIVE_GATEWAY
- INCLUSIVE_GATEWAY
- PARALLEL_GATEWAY
- EVENT_BASED_GATEWAY
- SEQUENCE_FLOW
- MULTI_INSTANCE_BODY
- CALL_ACTIVITY
- BUSINESS_RULE_TASK
- SCRIPT_TASK
- SEND_TASK
- UNKNOWN


[prettier] reported by reviewdog 🐶

- ACTIVE
- COMPLETED
- TERMINATED


[prettier] reported by reviewdog 🐶

- FAILED
- EVALUATED
- UNKNOWN
- UNSPECIFIED


[prettier] reported by reviewdog 🐶

- DECISION_TABLE
- LITERAL_EXPRESSION
- UNSPECIFIED
- UNKNOWN

@jonathanlukas
Copy link
Contributor Author

When trying to generate the api docs using npm run api:generate:operate, this error occurs:

> [email protected] api:generate:operate
> npm run api:generate operate


> [email protected] api:generate
> node ./api/generate-api-docs.js operate

/Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js:315
undefined
             ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/jonathanlukas/git/camunda/camunda-docs/node_modules/replace-in-file/index.js from /Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js not supported.
Instead change the require of index.js in /Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js to a dynamic import() which is available in all CommonJS modules.
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at Object.<anonymous> (/Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js:1:17) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v22.11.0

@pepopowitz
Copy link
Collaborator

When trying to generate the api docs using npm run api:generate:operate, this error occurs:

> [email protected] api:generate:operate
> npm run api:generate operate


> [email protected] api:generate
> node ./api/generate-api-docs.js operate

/Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js:315
undefined
             ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/jonathanlukas/git/camunda/camunda-docs/node_modules/replace-in-file/index.js from /Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js not supported.
Instead change the require of index.js in /Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js to a dynamic import() which is available in all CommonJS modules.
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at Object.<anonymous> (/Users/jonathanlukas/git/camunda/camunda-docs/api/make-server-dynamic.js:1:17) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v22.11.0

This specific issue should be resolved by #4745. As discussed in Slack, that will allow you to run the generator to update the vNext docs. Updating the vCurrent docs is currently a manual thing, because we don't retain the spec associated with that specific version.

@jonathanlukas jonathanlukas marked this pull request as ready for review December 10, 2024 18:31
@jonathanlukas jonathanlukas enabled auto-merge (squash) December 10, 2024 18:31
@jonathanlukas jonathanlukas requested a review from a team December 10, 2024 18:31
Copy link
Contributor

github-actions bot commented Dec 10, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@pepopowitz pepopowitz added the deploy Stand up a temporary docs site with this PR label Dec 11, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs December 11, 2024 16:05 Destroyed
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me!

Thank you tremendously for backporting this manually to the current version, and for taking obvious great care with that backporting. I will keep you in mind when I introduce the ability to do this using the API doc generator.

@jonathanlukas jonathanlukas merged commit cdac604 into main Dec 11, 2024
10 checks passed
@jonathanlukas jonathanlukas deleted the jonathanlukas-patch-1 branch December 11, 2024 16:58
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants