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 15, 2024
2 parents 05011be + ca7296b commit 1e6fd5a
Show file tree
Hide file tree
Showing 20 changed files with 1,197 additions and 821 deletions.
295 changes: 25 additions & 270 deletions docs/api-reference/execute-a-self-service-action.api.mdx
View file

Large diffs are not rendered by default.

183 changes: 27 additions & 156 deletions docs/api-reference/get-an-action-runs-details.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,19 @@ description: "This route allows you to fetch the details of an action run.<br/><
sidebar_label: "Get an action run's details"
hide_title: true
hide_table_of_contents: true
api: eJzdVU1v1DAQ/SuWL4C03bQVXKLVSpVACHEAQTnBqvUmk8Zq1g7jccqyyn9nJh/bbLvlwgHEJR/2zHjmzbznnc4hZGhrst7pVF+WNij0kUCZqvJ3QW19VORVAZSVikpQOZCxVVC+UMYpk4mnwujmizUmy+5x6VUFBp3aeORAa443MQwzlZWQ3SpZlohfc5/FDTgyYrJ6XhLVIU0SXg7zG6DaI82tTzIEQ3ASoCr4gY3N4AR+1IAWXAYhQSgqyOikP+qkRn+DEELyYq5nmsxN0OlXfdHn8Ynz0KuZrg2aDRCgbO504Mw2Rqc7TdsaGJBAaN0N+4OLG/FvzvinOderdqatQPY9Am55zXEc/m04lGA50wjfo0XIdVqYKkA7ezr8GKs2VN6HYqyubM7/D3sEyuYMly0soPRBQLzHt2vZnXG071vfmoOUCCO0XH+ALKKlbVf9mpsGKFUy0nmKHUZixTDW3gUIkvr56am8DpP6HDNuQZBKXp6+fLz/wcGYaeFlsrhsBYgeeZIyzoGzSr+5b25BZl3BUj6Qn0otqFy+EcNFwl/jyuv76MM6v/DALV9eO09XhY8uv+bdfL9+eYjXnaV+tHliGkY2n8J7Z4LiMKoLM0QZj0rGXLuyz8//lbKta0xl8ytpNwR6XHxuyNxXm3voa9yYkeS9BPTj+ruiXx2bhb9VNLPYmeqqO+mw5gunxu0+kX0eTxfH1bEwlJ7JolmE9KxnZ6qT5izpp4clhymS7HqitlrohM2oJRErth7FzNR2omVa1OCxQQwHNhN+fpZW9PwbWboXEfZ8DxMJuoicNtqfnZzqQVpKZjR7tZ3UFL5zt1SJ/Uc+T118fCfCNqhXqs/mp9Lg2gfaGCfmQ/S3QIfC/yyMd8JDqdrpzDPsjv7vm6XvAsEPSurK2I4YXW93w8gMt8YwNKLDsXulg8Jzn0vGWQx3u7UJ8AWrtpXl/nKRacptkNEcb5OZvuWWT68bpnyUPLqxaQxaMT/u+mSTnn8aLogX6g9umaOAjLPqttNcxzIGINrVlHVv31wKalEgnA77bTfsw4cUeDT2Qxb0B8lTuHfUZcEkUEyl5d6833nSYSDVaC2Vrtq2/QWbzznF
api: eJzdV99v2zgM/lcMvdwGuHVX7F6CIEAOG4Ziwzb0uodDGxSKxcRaZcmjqHRZ4P/9QMt2nNTtNtzD3a4PSWqR9MePP0TuhAKfo65IOysm4qrQPkEXCBJpjLv3ydaFhFyyAsqLhApIFJDUxidulUibyJw1Ewz2dLrEbNZ8XLnEgESblA4hkUsXaCDo0yQvIL9L+DFbvFYuDyVYkiyyeFYQVX6SZcrl/nQNVDmkU+2yHEESnHgwqxMPuNE5nMDXClCDzcFnCCsDOZ3EV51U6NYI3mfPT0UqSK69mFyLecRxGawXi1RUEmUJBMiHO+HzAkopJjtB2wrERHhCbdciFWBDyfqbFyIVm3OxqFOhmbIvAXArUmFlyQobQM9cpgLhS9AISkxW0nio08fNd7YqScXeFAZ7q5VIH8QIEq3Akl5pQI4Dk7jntwnZvbTUxy2G5gASYYB6kQoPeUBN28b7JUgEZC8RpJpgwxFLIfjKWQ+eoZ+fnfHXIahLINSwAZX4kOfg/SoYs2Xic2cJLLGKrCqj8ybK2WfPekNKKnQVIOn4Fnc3oEna7T4EDJ3Zx2AHIm75GXIS6ZEZrUbZXpoAFeoI63sWOqpHLZEmA/uT633G2GBMTJPc2aclFBggGEJdOmdAWlHXw6hdD9GwIv/DwfulnYip+4s7cQj10JEmUArUnMY6y8phKUlMhOLuRroEVvAuYD7uTmt1MQA0ryp0G2mG8h3wvcI4ysd73fzdO5GK+fu/xOLY+0aFEXiSFPxoQOLRO7kE8zTpRtu7oYRElFzwreQiFZqgHHsJvyWUpcTtKAI5QkufXPH1x5wctLURk8EDXqin/WHHR4itGW4lt8ZJ9ROIxqPEUNA8mU8BdUPCGg76XJ/QqfBbmxforP42nvKpKIEKN95DC5CquTe/V7eXn97fXrx6hI+lUz/Qv3gEuG1ukq8/0LIx2IsxzPFvf52NRrFLvn3RdMnHqnEGUX+M51uo1BOnre7PdIHW4I+rPGhSou+vByyNtI6+5/RF/aDq3R3zIZXSbFGajwPamyHneFb58FZEyl+evXw4NHyw0I0vK8fjprbrBBAd+sTleUAENbmxN3ZKcmlgxj9wdmOTZErF7DULTjMq+iev9tbb59OsUdirqdl0ObOOblcuWDXNlrNpRqo/vDqcpO41xaGXKdIK1HDwupc+sY6S1lJjpXtf1gHmIL48P//v+K7tRhqtbjms4GmUASVJ7l1WDqKjpex2gLghxNHtKc9/HxsV/z3PCdBKcwvRxJHjc5t0EhFND+ZxDwcNUqyhaUQ8wU9EtnmRxTzyGY/R2S4O8zUXF+Cm2zeaFi66hUdWerDvCN4YHgoEfyAzmOH/5HjEDthN8vsJutJvYbCmzAMVDvU32baGZv2IHb1xS9uVa9TjUCU+OqRk/vGCl592w5mIF6dnHOXKeSplc1221t8AHS6Hv/lubzxeZ3b7BeH/vH3GKPD1lVVGaju4v2PKtJtlmzSiWW/4a9JugYtUFM4TC+52S+nhE5q65sdxAeVsUtpzaqq+Gd/B9mAl3UgTGEeTNhuJmsXHVR8N0rPL9kJ4nvyDTXSUkINtr8faudESUS/62aNBHg/neQ4VDdQe7Jrscl+sb15fMdmBmR/WyF1TI+0Ptj4K6bh4IgT+5JIdVdntYgXWdS8fjx7VaF3spJmhRV3XfwOJuRt5
sidebar_class_name: "get api-method"
info_path: api-reference/port-api
info_path: api-reference-temp/port-api
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
Expand All @@ -35,6 +29,7 @@ import TabItem from "@theme/TabItem";
<MethodEndpoint
method={"get"}
path={"/v1/actions/runs/{run_id}"}
context={"endpoint"}
>

</MethodEndpoint>
Expand All @@ -51,150 +46,26 @@ This route allows you to fetch the details of an action run.<br/><br/>To learn m
>
</Heading>

<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
<ParamsDetails
parameters={[{"schema":{"type":"string","enum":["v1","v2"]},"in":"query","name":"version","required":false},{"schema":{"type":"string"},"in":"path","name":"run_id","description":"The identifier of the action run you want to fetch.<br/>","required":true}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"schema":{"type":"string"},"in":"path","name":"run_id","description":"The identifier of the action run you want to fetch.<br/>","required":true}}
>

</ParamsItem>
</ul>
</div>
</details><details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Retrieved successfully.","content":{"application/json":{"schema":{"properties":{"ok":{"type":"any","enum":[true]},"run":{"type":"object","properties":{"id":{"type":"string"},"blueprint":{"type":"object","properties":{"identifier":{"type":"string"},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"deleted":{"type":"boolean"}},"required":["identifier"]},"entity":{"type":"object","properties":{"identifier":{"type":"string"},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"deleted":{"type":"boolean"}},"required":["identifier"]},"action":{"type":"object","properties":{"identifier":{"type":"string"},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"deleted":{"type":"boolean"}},"required":["identifier"]},"properties":{"type":"object"},"endedAt":{"type":"string","format":"date-time"},"source":{"type":["string","object"]},"requiredApproval":{"type":["boolean","object"],"properties":{"type":{"type":"string","enum":["ALL","ANY"]}},"required":["type"]},"status":{"type":"string"},"statusLabel":{"type":["string","null"]},"link":{"type":["array","string"],"items":{"type":"string"}},"summary":{"type":"string"},"approval":{"type":["object","null"],"properties":{"description":{"type":"string"},"userId":{"type":["string","null"]},"state":{"type":"string"}}},"payload":{"type":["object","null"],"properties":{"type":{"type":"string"},"url":{"type":"string","format":"uri"},"agent":{"type":"boolean"},"synchronized":{"type":"boolean"},"method":{"type":"string"},"headers":{"type":"object","properties":{"RUN_ID":{"type":"string"}}},"body":{"type":"object","properties":{"port_context":{"type":"object","properties":{"runId":{"type":"string"}}}}}}},"response":{"type":["string","array","object"],"items":{}},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","action","properties","requiredApproval","source","status"]}},"required":["ok"],"additionalProperties":false,"description":"OK"}}}},"404":{"description":"One of the following errors occurred:\n\n<table>\n<tr>\n <th>Error</th>\n <th>Description</th>\n</tr>\n<tr>\n <td><b>not_found</b></td>\n <td>The action run with the provided identifier was not found</td>\n</tr>\n</table>\n"},"422":{"description":"One of the following errors occurred:\n\n<table>\n<tr>\n <th>Error</th>\n <th>Description</th>\n</tr>\n<tr>\n <td><b>invalid_request</b></td>\n <td>The data provided does not match the route schema</td>\n</tr>\n</table>\n"},"500":{"description":"One of the following errors occurred:\n\n<table>\n<tr>\n <th>Error</th>\n <th>Description</th>\n</tr>\n<tr>\n <td><b>internal_error</b></td>\n <td>An internal error occurred</td>\n</tr>\n</table>\n"}}}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"schema":{"type":"string","enum":["v1","v2"]},"in":"query","name":"version","required":false}}
>

</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>


Success


</div><div>

</div>
</TabItem><TabItem
label={"404"}
value={"404"}
>
<div>


One of the following errors occurred:

<table>
<tr>
<th>Error</th>
<th>Description</th>
</tr>
<tr>
<td><b>not_found</b></td>
<td>The action run with the provided identifier was not found</td>
</tr>
</table>



</div><div>

</div>
</TabItem><TabItem
label={"422"}
value={"422"}
>
<div>


One of the following errors occurred:

<table>
<tr>
<th>Error</th>
<th>Description</th>
</tr>
<tr>
<td><b>invalid_request</b></td>
<td>The data provided does not match the route schema</td>
</tr>
</table>



</div><div>

</div>
</TabItem><TabItem
label={"500"}
value={"500"}
>
<div>


One of the following errors occurred:

<table>
<tr>
<th>Error</th>
<th>Description</th>
</tr>
<tr>
<td><b>internal_error</b></td>
<td>An internal error occurred</td>
</tr>
</table>



</div><div>

</div>
</TabItem>
</ApiTabs>
</div>
</div>

</StatusCodes>



Loading

0 comments on commit 1e6fd5a

Please sign in to comment.