Skip to content

Commit

Permalink
docs: bring up downstream changes found in C8 REST API's generated do…
Browse files Browse the repository at this point in the history
…cs (#22101)

(Note that this is different from #22037, another recent PR which
brought up different downstream changes.)

## Description

This PR addresses a few small C8 REST API spec issues, which were
identified in camunda/camunda-docs#4256.

See that PR for original conversation on these changes.
  • Loading branch information
pepopowitz authored Sep 9, 2024
2 parents a5f191a + f7391ee commit 55512df
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions zeebe/gateway-protocol/src/main/proto/rest-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -618,18 +618,18 @@ paths:
post:
tags:
- Clock
summary: Reset the Zeebe engine’s internal clock to the system time (experimental)
summary: Reset internal clock (experimental)
description: |
Resets the Zeebe engine’s internal clock to the current system time,
enabling it to tick in real-time. This operation is useful for returning the clock to
Resets the Zeebe engine’s internal clock to the current system time, enabling it to tick in real-time.
This operation is useful for returning the clock to
normal behavior after it has been pinned to a specific time.
:::note
This endpoint is experimental and may undergo changes or improvements in future releases.
:::
responses:
"204":
description: The clock was successfully reset to the system time
description: The clock was successfully reset to the system time.
"500":
description: An internal error occurred while processing the request.
content:
Expand Down Expand Up @@ -842,8 +842,8 @@ paths:
patch:
tags:
- Authorization
summary: Patch an authorization
description: Manage the permissions assigned to the authorization
summary: Patch authorization
description: Manage the permissions assigned to the authorization.
operationId: patchAuthorization
parameters:
- name: ownerKey
Expand Down Expand Up @@ -1285,7 +1285,8 @@ paths:
- Resources
summary: Deploy resources
description: |
Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are.
Deploys one or more resources (e.g. processes, decision models, or forms).
This is an atomic call, i.e. either all resources are deployed or none of them are.
requestBody:
required: true
content:
Expand Down

0 comments on commit 55512df

Please sign in to comment.