Skip to content

Commit 85c703b

Browse files
author
Jens Kürten
committed
fix broken references in docs
1 parent e224bd2 commit 85c703b

File tree

3 files changed

+133
-134
lines changed

3 files changed

+133
-134
lines changed

‎docs/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,16 @@ def send_doc_to_erp(metadata: MetaData, event: DocumentReleaseEvent, service: Se
3737
```
3838

3939
While you don't have to use type annotations, it is highly recommended because it enables autocomplete in your IDE and helps you spot mistakes faster.
40-
For our example we only need the [DocumentReleaseEvent](reference/events.md/#documentreleaseevent). It contains a list of documents that were released. Typically this will only be a single document, however it is best practices to iterate over all of the documents.
40+
For our example we only need the [DocumentReleasedEvent](reference/events.md/#documentreleasedevent). It contains a list of documents that were released. Typically this will only be a single document, however it is best practices to iterate over all of the documents.
4141

4242
``` python title="mymodule.py"
4343
import requests
4444
import json
4545

4646
from csfunctions import MetaData, Service
47-
from csfunctions.events import DocumentReleaseEvent
47+
from csfunctions.events import DocumentReleasedEvent
4848

49-
def send_doc_to_erp(metadata: MetaData, event: DocumentReleaseEvent, service: Service):
49+
def send_doc_to_erp(metadata: MetaData, event: DocumentReleasedEvent, service: Service):
5050
# iterate over the documents contained in the event
5151
for document in event.data.documents:
5252
# create the payload for our (fictional ERP system)

‎docs/reference/actions.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
Functions can return a list of "Actions" that should be performed in CIM Database Cloud. Not all Events support the same actions, so check the supported actions in the [Events documentation](events.md). For example Events that are triggered **after** the release of an object don't support AbortAndShowError, because the release can't be aborted anymore, however the "release check" events do support it.
2-
3-
### Return an Action:
4-
5-
Example:
1+
Functions can return a list of "Actions" that should be performed in CIM Database Cloud.
62

73
```python
84
from csfunctions.actions import AbortAndShowErrorAction
@@ -12,19 +8,22 @@ def my_function(metadata, event, service):
128
return AbortAndShowErrorAction(message="Custom error message.")
139
```
1410

15-
## AbortAndShowErrorAction (abort_and_show_error)
11+
Not all Events support the same actions, so check the supported actions in the [Events documentation](events.md). For example Events that are triggered **after** the release of an object don't support AbortAndShowError, because the release can't be aborted anymore, however the "release check" events do support it.
12+
13+
14+
## AbortAndShowErrorAction
1615

1716
`csfunctions.actions.AbortAndShowErrorAction`
1817

1918
Aborts the current operation and shows an error message to the user.
2019

2120
**Attributes:**
2221

23-
|Attribute|Type|Description|
24-
|-|-|-|
25-
|message|str|Error message that will be shown to the user|
22+
| Attribute | Type | Description |
23+
| --------- | ---- | -------------------------------------------- |
24+
| message | str | Error message that will be shown to the user |
2625

27-
## StartWorkflowAction (start_workflow)
26+
## StartWorkflowAction
2827

2928
`csfunctions.actions.StartWorkflowAction`
3029

@@ -34,28 +33,28 @@ Creates a new workflow from a template and starts it.
3433

3534
**Attributes:**
3635

37-
|Attribute|Type|Description|
38-
|-|-|-|
39-
|template_id|str|ID of the workflow template|
40-
|cdb_project_id|str \| None|ID of the project in which the workflow should be started|
41-
|title|str|Title that the new workflow should have (max. 255 characters)|
42-
|attachment_ids|list[str]|List of cdb_object_ids to attach to the workflow|
43-
|global_briefcase_object_ids|list[str]|List of cdb_object_ids to attach to the global briefcase|
44-
|task_configurations|list[[TaskConfiguration](actions.md#TaskConfiguration)]|List of task configurations|
36+
| Attribute | Type | Description |
37+
| --------------------------- | ----------------------- | ------------------------------------------------------------- |
38+
| template_id | str | ID of the workflow template |
39+
| cdb_project_id | str \| None | ID of the project in which the workflow should be started |
40+
| title | str | Title that the new workflow should have (max. 255 characters) |
41+
| attachment_ids | list[str] | List of cdb_object_ids to attach to the workflow |
42+
| global_briefcase_object_ids | list[str] | List of cdb_object_ids to attach to the global briefcase |
43+
| task_configurations | list[TaskConfiguration] | List of task configurations |
4544

4645
**TaskConfiguration:**
4746

48-
|Attribute|Type|Description|
49-
|-|-|-|
50-
|task_id|str|Identifier for the task|
51-
|responsible|[Subject](actions.md#Subject) \| None|Responsible Subject for the task|
52-
|recipients|list[[Subject](actions.md#Subject)]|List of recipients (only used by information tasks)|
53-
|description|str \| None|Description of the task. If not set, the existing description will be kept. (max. 1024 characters)|
54-
|title|str \| None|Title of the task. If not set, the existing title will be kept. (max. 60 characters)|
47+
| Attribute | Type | Description |
48+
| ----------- | ----------------- | -------------------------------------------------------------------------------------------------- |
49+
| task_id | str | Identifier for the task |
50+
| responsible | [Subject] \| None | Responsible Subject for the task |
51+
| recipients | list[[Subject]] | List of recipients (only used by information tasks) |
52+
| description | str \| None | Description of the task. If not set, the existing description will be kept. (max. 1024 characters) |
53+
| title | str \| None | Title of the task. If not set, the existing title will be kept. (max. 60 characters) |
5554

5655
**Subject:**
5756

58-
|Attribute|Type|Description|
59-
|-|-|-|
60-
|subject_id|str|ID of the subject, e.g. a role name or "personalnummer"|
61-
|subject_type|str|Type of the subject. Can be "Person", "PCS Role" or "Common Role"|
57+
| Attribute | Type | Description |
58+
| ------------ | ---- | ----------------------------------------------------------------- |
59+
| subject_id | str | ID of the subject, e.g. a role name or "personalnummer" |
60+
| subject_type | str | Type of the subject. Can be "Person", "PCS Role" or "Common Role" |

0 commit comments

Comments
 (0)