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

chore(template) add inbound/outbound params to documentationRef where it possible #1733

Merged
merged 1 commit into from
Jan 17, 2024
Merged

chore(template) add inbound/outbound params to documentationRef where it possible #1733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion connectors/aws/aws-eventbridge/element-templates/aws-eventbridge-connector-boundary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSEventBridge.boundary.v1",
"version": 2,
"description": "Receive events from AWS EventBridge",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-eventbridge/element-templates/aws-eventbridge-connector-intermediate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSEventBridge.intermediate.v1",
"version": 3,
"description": "Receive events from AWS EventBridge",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
2 changes: 1 addition & 1 deletion ...ectors/aws/aws-eventbridge/element-templates/aws-eventbridge-connector-message-start.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSEventBridge.MessageStart.v1",
"version": 1,
"description": "Receive events from AWS EventBridge",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-eventbridge/element-templates/aws-eventbridge-connector-start-event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSEventBridge.startEvent.v1",
"version": 2,
"description": "Receive events from AWS EventBridge",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
8 changes: 4 additions & 4 deletions connectors/aws/aws-eventbridge/element-templates/aws-eventbridge-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSEventBridge.v1",
"version": 4,
"description": "Send events to AWS EventBridge",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=outbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down Expand Up @@ -52,7 +52,7 @@
{
"id": "authenticationType",
"label": "Authentication",
"description": "Specify AWS authentication strategy. Learn more at the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/\" target=\"_blank\">documentation page</a>",
"description": "Specify AWS authentication strategy. Learn more at the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=outbound\" target=\"_blank\">documentation page</a>",
"group": "authentication",
"type": "Dropdown",
"optional": false,
Expand All @@ -77,7 +77,7 @@
},
{
"label": "Access key",
"description": "Provide an access key of a user with permissions. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/\" target=\"_blank\">documentation</a>",
"description": "Provide an access key of a user with permissions. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=outbound\" target=\"_blank\">documentation</a>",
"group": "authentication",
"type": "String",
"binding": {
Expand All @@ -94,7 +94,7 @@
},
{
"label": "Secret key",
"description": "Provide a secret key of a user with permissions. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/\" target=\"_blank\">documentation</a>",
"description": "Provide a secret key of a user with permissions. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=outbound\" target=\"_blank\">documentation</a>",
"group": "authentication",
"type": "String",
"binding": {
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-sns/element-templates/aws-sns-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "Amazon SNS Outbound connector",
"id": "io.camunda.connectors.AWSSNS.v1",
"description": "Send message to topic",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=outbound",
"version": 6,
"appliesTo": [
"bpmn:Task"
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-sns/element-templates/aws-sns-inbound-boundary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.inbound.AWSSNS.Boundary.v1",
"description": "Receive events from AWS SNS",
"version": 2,
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-sns/element-templates/aws-sns-inbound-intermediate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.inbound.AWSSNS.IntermediateCatchEvent.v1",
"description": "Receive events from AWS SNS",
"version": 3,
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-sns/element-templates/aws-sns-inbound-message-start.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.inbound.AWSSNS.MessageStartEvent.v1",
"description": "Receive events from AWS SNS",
"version": 1,
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-sns/element-templates/aws-sns-inbound-start-event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.inbound.AWSSNS.StartEvent.v1",
"description": "Receive events from AWS SNS",
"version": 2,
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
8 changes: 4 additions & 4 deletions connectors/aws/aws-sqs/element-templates/aws-sqs-boundary-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSSQS.boundary.v1",
"version": 3,
"description": "Receive message from a queue",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound",
"appliesTo": [
"bpmn:BoundaryEvent"
],
Expand Down Expand Up @@ -153,7 +153,7 @@
},
{
"label": "Polling wait time",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "messagePollingProperties",
"type": "String",
"optional":false,
Expand All @@ -173,7 +173,7 @@
},
{
"label": "Attribute names",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand All @@ -185,7 +185,7 @@
},
{
"label": "Message attribute names",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand Down
2 changes: 1 addition & 1 deletion connectors/aws/aws-sqs/element-templates/aws-sqs-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSSQS.v1",
"version": 9,
"description": "Send message to queue",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=outbound",
"appliesTo": [
"bpmn:Task"
],
Expand Down
8 changes: 4 additions & 4 deletions connectors/aws/aws-sqs/element-templates/aws-sqs-inbound-intermediate-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSSQS.intermediate.v1",
"version": 8,
"description": "Receive message from a queue",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound",
"appliesTo": [
"bpmn:IntermediateCatchEvent",
"bpmn:IntermediateThrowEvent"
Expand Down Expand Up @@ -154,7 +154,7 @@
},
{
"label": "Polling wait time",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "messagePollingProperties",
"type": "String",
"optional":false,
Expand All @@ -174,7 +174,7 @@
},
{
"label": "Attribute names",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand All @@ -186,7 +186,7 @@
},
{
"label": "Message attribute names",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand Down
8 changes: 4 additions & 4 deletions connectors/aws/aws-sqs/element-templates/aws-sqs-start-event-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSSQS.StartEvent.v1",
"version": 7,
"description": "Receive message from a queue",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound",
"appliesTo": [
"bpmn:StartEvent"
],
Expand Down Expand Up @@ -142,7 +142,7 @@
},
{
"label": "Polling wait time",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "messagePollingProperties",
"type": "String",
"optional":false,
Expand All @@ -162,7 +162,7 @@
},
{
"label": "Attribute names",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand All @@ -174,7 +174,7 @@
},
{
"label": "Message attribute names",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand Down
8 changes: 4 additions & 4 deletions connectors/aws/aws-sqs/element-templates/aws-sqs-start-message.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.AWSSQS.startmessage.v1",
"version": 2,
"description": "Receive message from a queue",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound",
"appliesTo": [
"bpmn:StartEvent"
],
Expand Down Expand Up @@ -157,7 +157,7 @@
},
{
"label": "Polling wait time",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "messagePollingProperties",
"type": "String",
"optional":false,
Expand All @@ -177,7 +177,7 @@
},
{
"label": "Attribute names",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of queue attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand All @@ -189,7 +189,7 @@
},
{
"label": "Message attribute names",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/\" target=\"_blank\">documentation</a> for details",
"description": "Array of message attribute names. See <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound\" target=\"_blank\">documentation</a> for details",
"group": "input",
"type": "String",
"optional": true,
Expand Down
2 changes: 1 addition & 1 deletion connectors/github/element-templates/github-connector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"icon": {
"contents": "data:image/svg+xml;utf8,%3Csvg width='98' height='96' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z' fill='%2324292f'/%3E%3C/svg%3E"
},
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/?github=outbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down
6 changes: 3 additions & 3 deletions connectors/github/element-templates/github-webhook-connector-boundary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "io.camunda.connectors.webhook.GithubWebhookConnectorBoundary.v1",
"version": 2,
"description": "Receive events from GitHub",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github-webhook/",
"documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/?github=inbound",
"category": {
"id": "connectors",
"name": "Connectors"
Expand Down Expand Up @@ -80,7 +80,7 @@
},
{
"label": "GitHub secret",
"description": "Shared secret key. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github-webhook/' target='_blank'>See documentation</a> regarding GitHub secret",
"description": "Shared secret key. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/?github=inbound' target='_blank'>See documentation</a> regarding GitHub secret",
"type": "String",
"group": "endpoint",
"optional": true,
Expand Down Expand Up @@ -155,7 +155,7 @@
"type": "zeebe:property",
"name": "inbound.activationCondition"
},
"description": "Condition under which the connector triggers. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github-webhook/' target='_blank'>See documentation</a>"
"description": "Condition under which the connector triggers. <a href='https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/?github=inbound' target='_blank'>See documentation</a>"
},
{
"label": "Result variable",
Expand Down
Loading