Skip to content

Commit 054ba5b

Browse files
authored
Merge branch 'main' into PORTN-3679-add-support-user-documentation
2 parents 5b8685b + 3dcb171 commit 054ba5b

34 files changed

+3657
-747
lines changed

docs/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/object.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ resource "port_action" "myAction" {
153153

154154
Object validations support the following operators:
155155

156-
- `properties` - which keys must appear and what their type should be;
157-
- `additionalProperties` - are keys not defined in `properties` allowed and what their type should be;
156+
- `properties` - defines the type for keys if they appear (use `required` array to make keys mandatory).
157+
- `additionalProperties` - whether keys not defined in `properties` are allowed (boolean) or what type they should be (type definition).
158158
- `patternProperties` - which regex pattern should properties follow
159159

160160
:::tip

docs/actions-and-automations/setup-backend/create-update-entity/create-update-entity.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,55 @@ Here are some typical scenarios for mapping array relations:
161161
:::info Entity titles in relations
162162
Relations can only reference entity **identifiers**, not titles. Even though entity objects contain both `identifier` and `title` properties, you must always use `.identifier` when mapping to relations.
163163
:::
164+
165+
## Limitations
166+
167+
### Create missing related entities
168+
The `createMissingRelatedEntities` flag is not supported when using this backend type.
169+
170+
If you want to automatically create missing related entities, you can use the [webhook backend](/actions-and-automations/setup-backend/webhook/) instead, with an API call to the [create an entity](/api-reference/create-an-entity) endpoint. This way you can set the `createMissingRelatedEntities` flag to `true` in the API call.
171+
172+
Here is an example JSON definition of a self-service action that creates a new entity and its related entities:
173+
174+
<details>
175+
<summary>**Example action JSON definition (click to expand)**</summary>
176+
```json showLineNumbers
177+
{
178+
"identifier": "create_entity_a",
179+
"title": "Create Entity A",
180+
"trigger": {
181+
"type": "self-service",
182+
"operation": "CREATE",
183+
"userInputs": {
184+
"properties": {},
185+
"required": [],
186+
"order": []
187+
}
188+
},
189+
"invocationMethod": {
190+
"type": "WEBHOOK",
191+
"url": "https://api.port.io/v1/blueprints/<entity_a_identifier>/entities?create_missing_related_entities=true",
192+
"agent": false,
193+
"synchronized": true,
194+
"method": "POST",
195+
"headers": {
196+
"RUN_ID": "{{ .run.id }}",
197+
"Content-Type": "application/json"
198+
},
199+
"body": {
200+
"identifier": "my_new_entity",
201+
"title": "MyNewEntity",
202+
"icon": "Microservice",
203+
"team": [],
204+
"properties": {},
205+
"relations": {
206+
"<relation_identifier>": "<entity_b_identifier>"
207+
}
208+
}
209+
},
210+
"requiredApproval": false
211+
}
212+
```
213+
</details>
214+
215+
**Note** that `synchronized` should be set to `true`.

docs/api-reference/change-a-specific-provider-configuration.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "This route allows you to change the configuration of a specific LL
55
sidebar_label: "Change a specific provider configuration"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJztWc1y2zYQfhUOpod2KlqSx77oJqc9eOo0HsfpxVE7ELkSEYMEC4BKZA7fvbsgKUESZdmNJ3Uzutg0gN39drF/WJcsBhNpkVuhMjZit4kwgVaFhYBLqT6bYKmKwKogSng2h8AmEEQqm4l5oTnRBGoW8MDkEImZiIKrq7dBrtVCxKBPWI9ZPjdsdMdoPeUZn0MKmWWTHjMQFVrYJe6WbApcg8bPSYVbGv4uwNgLFeNuyVCeJSL85HkuReQE9z8ZQlwyEyWQcvqyyxxQBzX9BJFF4QgkB20FmIYNwnZcsuW7mZO7TWGFlbQwzmyCxCLa4cJz8Rss30Okwf7OU/DkGqtFNkeKVGRXkM1twkbDqqr1ERpiMsQOPerL41iQSlxee7JmXBqoevtBvsshG1++ZoTjh0JD8FI4CaZRhY7gicdjyKVaksNdxl9thS3pW9z/vY0uINYqut81TxSBMYjhMn6WjYw7PG6pn2nfuaiD6rGDiJRbC5ryxZ93PHyYlKdV6D5+Dj9+jMth9QNDbvOC61hzIS9jNBKmB4rwbdb+uT9Am075O5fTaZvHdF/pduCiJihJLUBrTGDmcE5JVQyy85wPd57b8BzXIsmLGELMWxnY8Cw8HZyeD86HZwRqk29NcVA8ZHwqwfftqVISeObcc8YLiVnT6gLIgI/6535s3w7E1233XhAIHci5RsdBNzeuUuxUmZY3HhUUCViy9BIlZS7U2IJLEXMLf0Vk0ciVV98rVnlhh/Eq5iArUnIfhJdxgQuc0mm4/tMrUtN1FlEa62uLCiM1WYNqK/MGEmcRV3VNrjJTX+rpYEC/NpuDX2ojBjfNSXLpl6nN6r7bsojJ3doh+pViL2/G/V5V9Z7UU7y66vy9Afq++oJjF/DfdwE9P54zRQmoOnhXB4rK5Nhb/J97i9mMivgC3h5v5ZvdCmLUgD1UPLZd2WimdMpxh1GfFVqBAb4muVh2Zpkij5/LsCHpZLiVkbz+qrXRruscyD1bLNU9W7VBhyiJ9ux1NG6Y5VR3nk8xK/N5Rx1yhdliAeiMrm7Fy6rTXrX0p5nr7Giup5vr/OhdTzeXg2MTFdPLq3Da0WtsxPqLYV/KNGzThemX7Wfl+he9aJ+dhZZIkFibm1G/j83nCT1MToRi1I/s7hZmfcAbsr4ng9c2bUetKyPUHe36kTguELMWD7x5s7p3ZAKc8hrpRJd4s57Q/vqFp7mErQnrTg/v3cNGD7TuclYVcFVeXAl5vFBtnq3891pDLbKZcto287ZrNE8wvqZ55KLtNNnwZEDIcmVsyp2LNsZ4U4+9vQl3e1ObY3BX+byg8KbWLz9Tr+/NwhfbzyUXLiScK5SNh92xxRAPbvgY/j1a1Sd0jQR1pZNlOeUGPmhZVbRcjzHI9WJhGks6j+6xe/SSfYMNXC0IlPO6BdeCSLvZ7LXTjzdNpP0U7NOyddls6ctsoa3Uc61247KEod5+U0sKb4nJmnwnQVFk1RT0hsjto2cnXpBff7ilGULzbwvybFzU/DNVcPzpkCqnuHN4t1YyiU5QuJzFapauLSroHv0YvXcx2nx4c4ZNW2wHb60H/fTeL5skZVlHa1Ux744L2E/RWLY9TVczQdT/AFapK4k=
8+
api: eJztWUtz2zYQ/iscTA/pVLQkj33RTU568NRpPI7Ti6N2IHIlIiIJFg8lMof/vbsgKVISJdmNp/VkdLEpYHex+2FfAHIWgg6UyIyQKRux+0hoT0lrwONxLL9qbyWtZ6QXRDydg2ci8AKZzsTcKk48npx53NMZBGImAu/m5r2XKbkUIagz1mOGzzUbPTAaT3jK55BAatikxzQEVgmzwtmcTYErUPg5KXBKwd8WtLmSIc7mDNczxISfPMtiEbiF+180aZwzHUSQcPoyqwzQBjn9AoHBxVGRDJQRoCsxqLaTkq4+zNy62xxGmJgGxqmJkFkEO1J4Jn6D1UcIFJjfeQKtdbVRIp0jRyLSG0jnJmKjYVGU9ggFIQGxw4/28jAUZBKPb1trzXisoejtV/JDBun4+jVrOH60CryX0pPU1NKqAJ5IHkIWyxU53HX43Shsrb4l/d9jdAWhksFiF54gAK1Rh+vwWRhpRzyuuZ+J71yUQXWIEDXlxoCifPHnA/cfJ/l54buPX/zPn8N8WPzEUNrcchUqLuLrEEHC9EARvi26TfcHKN25/s7mdGJzyPa1bcc3qskOqaSkU3Tt3sZeFYdlYk5DCrkEpTAt6uOZKpEhxJ10bRDmmfEvcSyIuQ3Bx2yYgvEv/PPB+eXgcnjRTEVcLCzOXLq54WAwJBg21yylHVUNUj6NoR1NUylj4KkLiBm3MUJmlIXiCCgH9P4flOhA6L/T4vumey+oCBFkXGHAYHhrFwM71bWWjaSCMgCWarXClVKXYtiSxyLkBv4KaF8D11a0/XYdZjuC17kGUpuQg6N6KRc4wKmM+M3PVnGeNtlTKuwraq0wQ0WNUnVHsqGJQ8R1GzqTqS439XwwoH+bTdG7EkTvrqKkyHqZnkQuupFFndyuHeNfG/byMO73qqL3pF7q1XUlP5pCP1Y/dOp+Tt3Pqfs5dT/P7n5mM2ozlvD+5Dcnv2krqQD70HBsujL6TKqE4wyjXtU3ApNkw3K16szUNgufK7Bi6RS4ldVbPWqN0a5zH8nfWyLlgq1byWOcxHvxOppfrBSyu1YmWNn4vKOWu+bGYBHtjP9uw/OiE69y9afBdXGC6+lwXZ686+lwOXVMJEM6vVpnHZ1oR6y/HPbjOPHrdKH7ef1ZuB5QLeuju1UxMkTGZHrU72MDf0aHuzMhGfV0u7NWNwStC/qPBHiJaX1NvwahPBU0B+2xRZ2VeOTVud+dxSPglNfIJtrEu+Z2/9dvPMli2Lqd3zkHtfZho49sOsV1HV6XF1dCDpfLPbTdVW2TuGgfkCt2kc6kg6a62L1FLL3xLV18L+vWng3PBmRGJrVJuPPnCrm35ftK6yml3tbN9xZXJlsR1HoeefnHm3KTDXwz/SzmwsWP85u8cscHthwi4YZD4u/RupihH0VoK1Hm+ZRr+KTioqDh8t6I/DQUukLSuX+PLdCl9t0k4aglpZyLLrkSxNotZi9Ob+6qsPzZ22dl7d/pqr1mrdraPHe2qfybdCin35Yr+fckpGHfyWYUhiUHHdoyc5B20soIt5/u6dKmeh+jMMBBxb9Suce/TlPpDHfR4cZyFqMTWJfgWCnS9VCW9rEd0AsX0NVH62JnE4vtSC/toL+tA+MmS56XoV0UrLXHFvZzVMjW1LQ1E9T6H7Sd+Cw=
99
sidebar_class_name: "put api-method"
1010
info_path: api-reference/port-api
1111
custom_edit_url: null
@@ -54,15 +54,15 @@ This route allows you to change the configuration of a specific LLM provider.
5454

5555
<RequestSchema
5656
title={"Body"}
57-
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"config":{"anyOf":[{"type":"object","title":"Anthropic","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","title":"OpenAI","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","title":"Azure OpenAI","properties":{"apiKeySecretName":{"type":"string","minLength":1},"resourceName":{"type":"string","minLength":1},"deploymentId":{"type":"string","minLength":1}},"required":["apiKeySecretName","resourceName","deploymentId"],"additionalProperties":false},{"type":"object","title":"Bedrock","properties":{"accessKeyIdSecretName":{"type":"string","minLength":1},"secretAccessKeySecretName":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"pattern":"^[a-z]{2}-[a-z]+-\\d{1}$"},"guardrailIdentifier":{"type":"string"},"guardrailVersion":{"type":"string"}},"required":["accessKeyIdSecretName","secretAccessKeySecretName","region"],"additionalProperties":false}]},"overrides":{"type":"object","properties":{"models":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"enabled":{"type":"boolean","default":true}},"additionalProperties":false}}}}}
57+
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"config":{"anyOf":[{"type":"object","title":"Anthropic","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","title":"OpenAI","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","title":"Azure OpenAI","properties":{"apiKeySecretName":{"type":"string","minLength":1},"resourceName":{"type":"string","minLength":1},"deploymentId":{"type":"string","minLength":1}},"required":["apiKeySecretName","resourceName","deploymentId"],"additionalProperties":false},{"type":"object","title":"Bedrock","properties":{"accessKeyIdSecretName":{"type":"string","minLength":1},"secretAccessKeySecretName":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"pattern":"^[a-z]{2}-[a-z]+-\\d{1}$"},"guardrailIdentifier":{"type":"string"},"guardrailVersion":{"type":"string"}},"required":["accessKeyIdSecretName","secretAccessKeySecretName","region"],"additionalProperties":false},{"anyOf":[{"not":{}},{"type":"object","properties":{},"additionalProperties":false}]}]},"overrides":{"type":"object","properties":{"models":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514","claude-haiku-4-5-20251001"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-haiku-4-5-20251001":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"enabled":{"type":"boolean","default":true}},"additionalProperties":false}}}}}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
responses={{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"result":{"type":"object","properties":{"provider":{"type":"string","enum":["openai","azure-openai","anthropic","bedrock","port"]},"enabled":{"type":"boolean"},"config":{"anyOf":[{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1},"resourceName":{"type":"string","minLength":1},"deploymentId":{"type":"string","minLength":1}},"required":["apiKeySecretName","resourceName","deploymentId"],"additionalProperties":false},{"type":"object","properties":{"accessKeyIdSecretName":{"type":"string","minLength":1},"secretAccessKeySecretName":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"pattern":"^[a-z]{2}-[a-z]+-\\d{1}$"},"guardrailIdentifier":{"type":"string"},"guardrailVersion":{"type":"string"}},"required":["accessKeyIdSecretName","secretAccessKeySecretName","region"],"additionalProperties":false},{"anyOf":[{"not":{}},{"type":"object","properties":{},"additionalProperties":false}]}]},"overrides":{"type":"object","properties":{"models":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"effectiveModels":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}},"required":["provider","enabled","effectiveModels"],"additionalProperties":false}},"required":["ok","result"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}}}}
65+
responses={{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"result":{"type":"object","properties":{"provider":{"type":"string","enum":["openai","azure-openai","anthropic","bedrock","port"]},"enabled":{"type":"boolean"},"config":{"anyOf":[{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1},"resourceName":{"type":"string","minLength":1},"deploymentId":{"type":"string","minLength":1}},"required":["apiKeySecretName","resourceName","deploymentId"],"additionalProperties":false},{"type":"object","properties":{"accessKeyIdSecretName":{"type":"string","minLength":1},"secretAccessKeySecretName":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"pattern":"^[a-z]{2}-[a-z]+-\\d{1}$"},"guardrailIdentifier":{"type":"string"},"guardrailVersion":{"type":"string"}},"required":["accessKeyIdSecretName","secretAccessKeySecretName","region"],"additionalProperties":false},{"anyOf":[{"not":{}},{"type":"object","properties":{},"additionalProperties":false}]}]},"overrides":{"type":"object","properties":{"models":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514","claude-haiku-4-5-20251001"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-haiku-4-5-20251001":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"effectiveModels":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514","claude-haiku-4-5-20251001"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-haiku-4-5-20251001":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}},"required":["provider","enabled","effectiveModels"],"additionalProperties":false}},"required":["ok","result"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}}}}
6666
>
6767

6868
</StatusCodes>

0 commit comments

Comments
 (0)