Skip to content

Commit

Permalink
Merge pull request #352 from mittwald/chore/no-code-for-emphasis
Browse files Browse the repository at this point in the history
Do not use <code> for emphasis
  • Loading branch information
martin-helmich authored Dec 11, 2024
2 parents 4a6c5d9 + 29394bd commit 84ff599
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions docs/contribution/3-overview/3-concepts/2-lifecycle-webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For an overview of the possible placeholders available in lifecycle webhook URL

## Quality of Service (QoS) for the Delivery of Lifecycle Webhooks

The mStudio executes all webhook calls `at least once`.
The mStudio executes all webhook calls _at least once_.
Therefore, you must design the webhook endpoints so that multiple calls do not result in errors.
Every status code less than `200` or greater than or equal `300` is considered a failure.
The webhook calls are executed asynchronously to the action that triggered them.
Expand Down Expand Up @@ -80,10 +80,10 @@ The reason is described above in [secrets in webhooks](#secrets-in-webhooks).

### ExtensionInstanceUpdated

This webhook communicates a change in the state of the `extension instance`.
It always includes the whole new state of the `extension instance`.
This webhook communicates a change in the state of the extension instance.
It always includes the whole new state of the extension instance.

The activation and deactivation of the `extension instance` are an example of this.
The activation and deactivation of the extension instance are an example of this.

### ExtensionInstanceSecretRotated

Expand All @@ -95,13 +95,13 @@ For more information, see [secrets in webhooks](#secrets-in-webhooks).

### ExtensionInstanceRemovedFromContext

This webhook communicates the removal of an `extension instance` from a context.
This webhook communicates the removal of an extension instance from a context.
You should ensure compliance with data privacy laws at this point and delete personal data for example.

:::note
We treat the `ExtensionInstanceRemovedFromContext` webhook differently regarding the QoS.
It is possible to force remove the extension if the webhook handler is unreachable.
In this case, we revoke all permissions of the `extension instance` and invalidate existing access tokens.
In this case, we revoke all permissions of the extension instance and invalidate existing access tokens.

Nonetheless, the mStudio tries to execute the webhook to achieve a consistent state of the mStudio and extension data.
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Für eine Übersicht, welche Platzhalter für Lifecycle Webhooks verwendet werde

## Quality of Service (QoS) für die Zustellung von Lifecycle Webhooks

Alle Webhooks werden `at least once` aufgerufen und sind somit so zu entwerfen, dass mehrfache Aufrufe nicht zu Fehlern führen.
Alle Webhooks werden _at least once_ aufgerufen und sind somit so zu entwerfen, dass mehrfache Aufrufe nicht zu Fehlern führen.
Jeder Statuscode kleiner als `200` oder größer gleich `300` wird als fehlgeschlagen interpretiert.
Die Webhooks werden asynchron zu der Aktion, die diese ausgelöst hat, ausgeführt.
Bei Fehlschlägen wird der Webhook-Payload erneut gebaut, der Request neu signiert und versendet.
Expand Down Expand Up @@ -83,10 +83,10 @@ Siehe dazu auch [Secrets in Webhooks](#secrets-in-webhooks).

### ExtensionInstanceUpdated

In diesem Webhook wird der externen Anwendung eine Zustandsänderung der `Extension Instance` mitgeteilt.
In diesem Webhook wird der externen Anwendung eine Zustandsänderung der Extension Instance mitgeteilt.
Der externen Anwendung wird dabei immer der gesamte neue Zustand mitgeteilt.

Das kann beispielsweise die De-/Aktivierung der `Extension Instance` sein.
Das kann beispielsweise die De-/Aktivierung der Extension Instance sein.

### ExtensionInstanceSecretRotated

Expand All @@ -98,7 +98,7 @@ Siehe dazu auch [Secrets in Webhooks](#secrets-in-webhooks).

### ExtensionInstanceRemovedFromContext

Dieser Webhook drückt aus, dass eine `Extension Instance` aus einem Context entfernt wurde.
Dieser Webhook drückt aus, dass eine Extension Instance aus einem Context entfernt wurde.
Datenschutzrelevante Konsequenzen, wie die Löschung von personenbezogenen Daten, sollten an dieser Stelle berücksichtigt werden.

:::note
Expand Down

0 comments on commit 84ff599

Please sign in to comment.