Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/port-labs/port-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hadar-co
hadar-co committed Dec 12, 2024
2 parents 8255a6a + 6b0a841 commit 05011be
Show file tree
Hide file tree
Showing 56 changed files with 2,563 additions and 730 deletions.
8 changes: 4 additions & 4 deletions docs/api-reference/add-a-log-to-an-action-run.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ This route allows you to send a log message back to Port, which will be displaye
<th>Description</th>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>The action run with the provided identifier was not found</td>
</tr>
</table>
Expand All @@ -332,11 +332,11 @@ This route allows you to send a log message back to Port, which will be displaye
<th>Description</th>
</tr>
<tr>
<td>`invalid_request`</td>
<td><b>invalid_request</b></td>
<td>The data provided does not match the route schema</td>
</tr>
<tr>
<td>`run_exhausted`</td>
<td><b>run_exhausted</b></td>
<td>Action run already finished execution</td>
</tr>
</table>
Expand All @@ -361,7 +361,7 @@ This route allows you to send a log message back to Port, which will be displaye
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>
Expand Down
10 changes: 5 additions & 5 deletions docs/api-reference/approve-an-action-run.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ This route allows you to approve or decline a request to execute an action that
<th>Description</th>
</tr>
<tr>
<td>`missing_permissions`</td>
<td><b>missing_permissions</b></td>
<td>You are not permitted to approve this action. For further details, please contact your admin</td>
</tr>
</table>
Expand All @@ -888,7 +888,7 @@ This route allows you to approve or decline a request to execute an action that
<th>Description</th>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>The action run with the provided identifier was not found</td>
</tr>
</table>
Expand All @@ -913,11 +913,11 @@ This route allows you to approve or decline a request to execute an action that
<th>Description</th>
</tr>
<tr>
<td>`invalid_request`</td>
<td><b>invalid_request</b></td>
<td>The data provided does not match the route schema</td>
</tr>
<tr>
<td>`run_not_waiting_for_approval`</td>
<td><b>run_not_waiting_for_approval</b></td>
<td>Action run is not waiting for approval</td>
</tr>
</table>
Expand All @@ -942,7 +942,7 @@ This route allows you to approve or decline a request to execute an action that
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>
Expand Down
28 changes: 14 additions & 14 deletions docs/api-reference/change-an-entity.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -717,7 +717,7 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`run_exhausted`</td>
<td><b>run_exhausted</b></td>
<td>Action run has already finished execution</td>
</tr>

Expand All @@ -743,11 +743,11 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`required_relation`</td>
<td>Relation cannot be deleted because it is a `required relation`</td>
<td><b>required_relation</b></td>
<td>Relation cannot be deleted because it is a <b>required relation</b></td>
</tr>
<tr>
<td>`missing_permissions`</td>
<td><b>missing_permissions</b></td>
<td>You do not have permissions to perform the requested operation. For further details, please contact your admin</td>
</tr>
</table>
Expand All @@ -772,11 +772,11 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>A blueprint with the provided `identifier` was not found</td>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>An entity with the provided `identifier` was not found</td>
</tr>
</table>
Expand All @@ -801,7 +801,7 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`identifier_taken`</td>
<td><b>identifier_taken</b></td>
<td>The provided `identifier` already exists, identifiers must be unique</td>
</tr>
</table>
Expand All @@ -826,7 +826,7 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`bad_request`</td>
<td><b>bad_request</b></td>
<td>Request body is too large (limit is 1MiB)</td>
</tr>
</table>
Expand All @@ -851,23 +851,23 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`invalid_request`</td>
<td><b>invalid_request</b></td>
<td>The provided data does not match the route schema</td>
</tr>
<tr>
<td>`team_inheritance_enabled`</td>
<td><b>team_inheritance_enabled</b></td>
<td>The blueprint's entities inherite their team from other entities through an existing relation</td>
</tr>
<tr>
<td>`blueprint_schema_mismatch`</td>
<td><b>blueprint_schema_mismatch</b></td>
<td>The provided entity does not match the blueprint's schema</td>
</tr>
<tr>
<td>`required_relation`</td>
<td><b>required_relation</b></td>
<td>A relation is required</td>
</tr>
<tr>
<td>`relation_many_violation`</td>
<td><b>relation_many_violation</b></td>
<td>A provided relation cannot contain more than one entity</td>
</tr>
</table>
Expand All @@ -892,7 +892,7 @@ This route allows you to edit a specific entity in your software catalog and upd
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>
Expand Down
8 changes: 4 additions & 4 deletions docs/api-reference/create-an-action-automation.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9225,7 +9225,7 @@ This route allows you to create a new self-service action or automation in your
<th>Description</th>
</tr>
<tr>
<td>`identifier_taken`</td>
<td><b>identifier_taken</b></td>
<td>An action/automation with the same identifier already exists</td>
</tr>
</table>
Expand All @@ -9250,11 +9250,11 @@ This route allows you to create a new self-service action or automation in your
<th>Description</th>
</tr>
<tr>
<td>`invalid_request`</td>
<td><b>invalid_request</b></td>
<td>The data provided does not match the route schema</td>
</tr>
<tr>
<td>`user_inputs_schema_invalid`</td>
<td><b>user_inputs_schema_invalid</b></td>
<td>The provided user inputs are invalid</td>
</tr>
</table>
Expand All @@ -9279,7 +9279,7 @@ This route allows you to create a new self-service action or automation in your
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>
Expand Down
26 changes: 13 additions & 13 deletions docs/api-reference/create-an-entity.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -731,11 +731,11 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`bad_request`</td>
<td><b>bad_request</b></td>
<td>The json provided does not match the route's schema</td>
</tr>
<tr>
<td>`run_exhausted`</td>
<td><b>run_exhausted</b></td>
<td>The action run with the provided `runId` has already finished execution</td>
</tr>
</table>
Expand All @@ -760,11 +760,11 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`required_relation`</td>
<td>Relation cannot be deleted because it is a `required relation`</td>
<td><b>required_relation</b></td>
<td>Relation cannot be deleted because it is a <b>required relation</b></td>
</tr>
<tr>
<td>`missing_permissions`</td>
<td><b>missing_permissions</b></td>
<td>You do not have permissions to perform the requested operation. For further details, please contact your admin</td>
</tr>
</table>
Expand All @@ -789,7 +789,7 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>A resource with the provided `identifier` was not found</td>
</tr>
</table>
Expand All @@ -814,7 +814,7 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`identifier_taken`</td>
<td><b>identifier_taken</b></td>
<td>The provided `identifier` already exists, identifiers must be unique</td>
</tr>
</table>
Expand All @@ -839,7 +839,7 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`bad_request`</td>
<td><b>bad_request</b></td>
<td>Request body is too large (limit is 1MiB)</td>
</tr>
</table>
Expand All @@ -864,19 +864,19 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`team_inheritance_enabled`</td>
<td><b>team_inheritance_enabled</b></td>
<td>The blueprint's entities inherite their team from other entities through an existing relation</td>
</tr>
<tr>
<td>`blueprint_schema_mismatch`</td>
<td><b>blueprint_schema_mismatch</b></td>
<td>The provided entity does not match the blueprint's schema</td>
</tr>
<tr>
<td>`required_relation`</td>
<td><b>required_relation</b></td>
<td>A relation is required</td>
</tr>
<tr>
<td>`relation_many_violation`</td>
<td><b>relation_many_violation</b></td>
<td>A provided relation cannot contain more than one entity</td>
</tr>
</table>
Expand All @@ -901,7 +901,7 @@ This route allows you to create an entity in your software catalog based on an e
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred </td>
</tr>
</table>
Expand Down
10 changes: 5 additions & 5 deletions docs/api-reference/delete-all-entities-of-a-blueprint.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,11 @@ This route allows you to delete all entities of a specific blueprint in your sof
<th>Description</th>
</tr>
<tr>
<td>`missing_permissions`</td>
<td><b>missing_permissions</b></td>
<td>You do not have permissions to perform the requested operation. For further details, please contact your admin</td>
</tr>
<tr>
<td>`has_dependents`</td>
<td><b>has_dependents</b></td>
<td>The entity has dependent entities that must be deleted along with it. To do that, use "delete_dependents=true"</td>
</tr>
</table>
Expand All @@ -167,7 +167,7 @@ This route allows you to delete all entities of a specific blueprint in your sof
<th>Description</th>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>A blueprint with the provided `identifier` was not found</td>
</tr>
</table>
Expand All @@ -192,7 +192,7 @@ This route allows you to delete all entities of a specific blueprint in your sof
<th>Description</th>
</tr>
<tr>
<td>`invalid_request`</td>
<td><b>invalid_request</b></td>
<td>The provided data does not match the route schema</td>
</tr>
</table>
Expand All @@ -217,7 +217,7 @@ This route allows you to delete all entities of a specific blueprint in your sof
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/delete-an-action-automation.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ This route allows you to delete a self-service action or automation.<br/><br/>To
<th>Description</th>
</tr>
<tr>
<td>`not_found`</td>
<td><b>not_found</b></td>
<td>The action/automation with the provided identifier was not found</td>
</tr>
</table>
Expand All @@ -134,7 +134,7 @@ This route allows you to delete a self-service action or automation.<br/><br/>To
<th>Description</th>
</tr>
<tr>
<td>`invalid_request`</td>
<td><b>invalid_request</b></td>
<td>The data provided does not match the route schema</td>
</tr>
</table>
Expand All @@ -159,7 +159,7 @@ This route allows you to delete a self-service action or automation.<br/><br/>To
<th>Description</th>
</tr>
<tr>
<td>`internal_error`</td>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>
Expand Down
Loading

0 comments on commit 05011be

Please sign in to comment.