add api docs (#977)

* add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * add api docs * create api docs * create api docs * create api docs * create api docs * create api docs * create api docs * create api docs * improve visualizations * api docs * pkg lock * pkg lock * entities * entities * actions * actions * more routes * more routes * migrations and structure * exit codes * update package.json * update package-lock.json * update package-lock.json * fix errors * fix errors * clean up routes and config * add package-lock --------- Co-authored-by: Hadar <[email protected]>
port-labs · Jun 9, 2024 · 26755a7 · 26755a7
1 parent 856ee85
commit 26755a7
Show file tree

Hide file tree

Showing 86 changed files with 63,927 additions and 6,713 deletions.
diff --git a/docs/__quickstart.md b/docs/__quickstart.md
@@ -1281,4 +1281,4 @@ If you want to learn more about Port's capabilities in a specific area, you can
 If you want to continue utilizing Port's REST API, take a look at these resources:
 
 - [API guide](./build-your-software-catalog/custom-integration/api/api.md)
-- [API Reference](./api-reference/api-reference.mdx)
+- [API Reference](./api-reference/port-api)
diff --git a/...-automations/create-self-service-experiences/create-self-service-experiences.md b/...-automations/create-self-service-experiences/create-self-service-experiences.md
@@ -56,7 +56,7 @@ Self-service actions are created and managed in the [Self-service](https://app.g
 To begin, click on the `+ New Action` button in the top right corner, then follow the steps below.
 
 :::tip Other supported methods
-Besides Port's UI, you can also create and manage self-service actions using [Port's API](https://api.getport.io/static/index.html#/Actions), or [Terraform](https://registry.terraform.io/providers/port-labs/port-labs/latest/docs/resources/port_action).
+Besides Port's UI, you can also create and manage self-service actions using [Port's API](/api-reference/port-api), or [Terraform](https://registry.terraform.io/providers/port-labs/port-labs/latest/docs/resources/port_action).
 :::
 
 ### Step 1 - setup the action's frontend

diff --git a/docs/api-reference/_category_.json b/docs/api-reference/_category_.json
@@ -1,4 +1,7 @@
 {
-  "label": "🧪 API reference",
-  "position": 12
+  "label": "Port API",
+  "position": 0,
+  "className": "hidden",
+  "collapsible": false,
+  "collapsed": false
 }
diff --git a/docs/api-reference/_learn_more_reference.mdx b/docs/api-reference/_learn_more_reference.mdx
@@ -1 +1 @@
-Check out Port's [API reference](./api-reference.mdx) to learn more.
+Check out Port's [API reference](/api-reference/port-api) to learn more.
diff --git a/docs/api-reference/add-a-log-to-an-action-run.api.mdx b/docs/api-reference/add-a-log-to-an-action-run.api.mdx
@@ -0,0 +1,165 @@
+---
+id: add-a-log-to-an-action-run
+title: "Add a log to an action run"
+description: "This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.<br/><br/>To learn more about action runs, check out the [documentation](https://docs.getport.io/create-self-service-experiences/reflect-action-progress/)."
+sidebar_label: "Add a log to an action run"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVcFu4zYQ/RWClyaAYyU9GosF3GwKLLpAAzs5FKlRUNLY4oYWVZKy4xr+974hJVvJxtheil4KAzJFcYaPb94b7mVJvnC6CdrWciIfKu2Fs20goYyxWy92thXBCk91KZQwdiXW5L1akchV8cyf7q0LI7GtdFGJrTZG5CRK7RujdlQKXYtQIVvBOwjX1j940SB8LH5D5kLV2Mhb0XrCuuPmSNs2peIRglNUILfWtYp5fFCh9eJi/nh7ezefZz9PP395nN1dCgWYRuVkRDpYrutVzJEixh9yl32MjwcrDClXi7V1wJdj3wFKPxJFRTggT3P8U2mLdk11iAAWF1UIjZ9kGab9eEWhAQtjbbPCEWBfeTJLPNxGF3RFLw05TXVBPnO0NFSEq7TVVePsyoHQ7HIsRzKolZeTJzlNOGbAIRcj6ejPlnz4yZY7OdnLwtYBQHiomsboIkLKvnou4V56AF8rHoVdQyiqzb9iR6THZgASNPn49cTnPJIzCPHBgTiEvJUHvVcGu3xT47G4RWGhA0PLIHKj6mehl1FLtjY7sVV1eF9VqUDYmOp2zVR0FcZMV2O5OIxk2vgLF/r7qKedIrBhJwoaSOJfQA+A3cQ/o3Toqj7v0F19WuRVZak5Upn7QTGX8BAlnWhHJfPWA1gcOOz0JbiWMNEop9aEWrLe3tFMhxYrNaNsVKgAvUYM3sDRH7qU36SFVD0VrdNhF7Pm8Bc5DBeHqGLf2Non8f14fc1/r7n4REvVmiBm3cp4YqCsbMkYrI8iZigTmW1uslQyeAo+yfYJ1SEDm14yErfpj9c6yET2llWNHjhWDmHPmYeEsAd/pARhv9DuxMK0BTCn/4pWkB1RFakSUQyc/Tg7OffuRa0bQ2ecN9D5K22fZHNU1KvaLG1MqANnliwWMb3/jOV89sTqzfia1zJ9axU7RH+AspcvdMaN+OiAtyod9Jz/r4j/+IpIYgz0EjLwB9GhtlHf+84aT3Jzg4WdOdilbfybHG0bHQLVV+worN/vc+Xp0ZnDgachWccGxnCjnFY5awsuQsV4XB77zVmNXMy6xnApzkHuTVWzozbKtPyG4TMsduwwB+71naUYQfp4m/a5euAUp+Bv7kI29rF73P86f8DivLtD17aMnUxtmSA8J/J3/PBim8QbFsX5vcQFsGqT9VLe2Ihb5nrYHJ5jc+gGjPbdI77tGulI/DyMzoR8gKMFWs/H4/L05WxAx1i/mgnna+Bv355uLA==
+sidebar_class_name: "post api-method"
+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 OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Add a log to an action run"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"post"}
+  path={"/v1/actions/runs/{run_id}/logs"}
+>
+
+</MethodEndpoint>
+
+
+
+This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.<br/><br/>To learn more about action runs, check out the [documentation](https://docs.getport.io/create-self-service-experiences/reflect-action-progress/).
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+>
+</Heading>
+
+<details
+  style={{"marginBottom":"1rem"}}
+  className={"openapi-markdown__details"}
+  data-collapsed={false}
+  open={true}
+>
+  <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","required":true}}
+      >
+
+      </ParamsItem>
+    </ul>
+  </div>
+</details><MimeTabs
+  className={"openapi-tabs__mime"}
+>
+  <TabItem
+    label={"application/json"}
+    value={"application/json-schema"}
+  >
+    <details
+      style={{}}
+      className={"openapi-markdown__details mime"}
+      data-collapsed={false}
+      open={true}
+    >
+      <summary
+        style={{}}
+        className={"openapi-markdown__details-summary-mime"}
+      >
+        <h3
+          className={"openapi-markdown__details-summary-header-body"}
+        >
+          Body
+        </h3><strong
+          className={"openapi-schema__required"}
+        >
+          required
+        </strong>
+      </summary><div
+        style={{"textAlign":"left","marginLeft":"1rem"}}
+      >
+
+      </div><ul
+        style={{"marginLeft":"1rem"}}
+      >
+        <SchemaItem
+          collapsible={false}
+          name={"terminationStatus"}
+          required={false}
+          schemaName={"string"}
+          qualifierMessage={"**Possible values:** [`SUCCESS`, `FAILURE`]"}
+          schema={{"type":"string","description":"The termination status of the action run. Can be left blank if you only want to send a log message.<br/>","enum":["SUCCESS","FAILURE"]}}
+        >
+
+        </SchemaItem><SchemaItem
+          collapsible={false}
+          name={"statusLabel"}
+          required={false}
+          schemaName={"string"}
+          qualifierMessage={undefined}
+          schema={{"type":"string","description":"A label to describe the status of the action run. Can be left blank if you only want to send a log message.<br/>"}}
+        >
+
+        </SchemaItem><SchemaItem
+          collapsible={false}
+          name={"message"}
+          required={true}
+          schemaName={"string"}
+          qualifierMessage={undefined}
+          schema={{"type":"string","description":"The log message to send back to Port.<br/>"}}
+        >
+
+        </SchemaItem>
+      </ul>
+    </details>
+  </TabItem>
+</MimeTabs><div>
+  <div>
+    <ApiTabs
+      label={undefined}
+      id={undefined}
+    >
+      <TabItem
+        label={"200"}
+        value={"200"}
+      >
+        <div>
+
+
+          Default Response
+
+
+        </div><div>
+
+        </div>
+      </TabItem>
+    </ApiTabs>
+  </div>
+</div>
+
diff --git a/docs/api-reference/api-reference.mdx b/docs/api-reference/api-reference.mdx
diff --git a/docs/api-reference/approve-an-actions-run.api.mdx b/docs/api-reference/approve-an-actions-run.api.mdx
@@ -0,0 +1,156 @@
+---
+id: approve-an-actions-run
+title: "Approve an action's run"
+description: "This route allows you to approve or decline a request to execute an action that requires approval.<br/><br/>To learn more about manual approval for actions, check out the [documentation](https://docs.getport.io/create-self-service-experiences/set-self-service-actions-rbac/#configure-manual-approval-for-actions)."
+sidebar_label: "Approve an action's run"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVdtu2zAM/RVBe1gLJHG7x6AokLUFVmzYgizbSxcMis3Eah3J0yVtFvjfR0qy6/TytD0OARRdSOkc8pDe8wJsbmTtpFZ8zOeltMxo74CJqtL3lu20Z04zUddGb4FpwwrIK6nQgBn45cE6OocHyIOXYiKny5grhQsW0oBN/qIanS1Ndh6GuWYVCKPYRht0XOKrbCOUF1VnzVb4XrzPDlheQn7HyMyVwG4KnfsNKCfoeHFUOlfbcZbhth2twdXauJHUWW5AOBhaqFY4mK3MYQgPNRgJKgebWXCHh+m9oVmKPHuTa7WSa29gGLENW2xDxNbaHo/4gDuxtnx8wyeR/8wryxcDnoL0Xhc7Pt5zvM8haJriTZXMA/zs1lL899wiyY2gmdvVgBnRy1vIHV6PryJoJ8EGO6Ttbc/OOiPVGu1A+U2AMZ3Ovny/wp3Lq4tP15+v+KIZHKb7ufOhGiast8bUFhmmA8OJWENmKA1ruQXFIpyYXN7gO6IoJHmJatrDvRKVhRgSVEVBMBORRUNejwfOeMCNWhixAQeGIvtCdBJwtJQEuBauRBYKfXBlvPopi2es5ohaFpgDuZJgmF4FHkm16BMkfy+U6+k+S6JPDJ8hxTxbLAAj3S4AXaKwweB00QQJ2BpVEjP37uSE/g4xXcJK+MqxWbIMMUTipS4irZx4BXpjnm1PsyS8DPHabB+ZNlmrTU5wzLYNmzcVurUFImrZqw/ex/6V4hthtgy6UKPbR9g9RnfiEZ2Rv4N+eUpACaJAL0JPip49av/qQWzqCvra7Un0MBr9rK50wCAd+fIpgmaT6TW6ELtofjo6IdtaW4c1SuYtxNS0uqb01lKCn77XK8r/DfBvGmAUioMHl9WVQEFgVoL29km6N3x7iobJicrIh79xV6qdglGVJSaUfPb7pbDwzVRNQ9sYckNVhtOtMFIsSRmo8kJamhddm3k1yUezVL3H7J80gxeJt2WjqGaQkacVTu+wiLre1FBPTkVDHOLhRUQ6nNMVj87PvhdUul2TmE7mFx/Qepk+NBtdhCYo7inOOI75D/zhQtcx/GgU9ve8EmrtxZrs48WhhXtKWb/+70L9pwnBfZHj08YQOdHYDF5xOcOSZthdzjvzePKqQwpZa00Rpy/IH+dOEwM=
+sidebar_class_name: "patch api-method"
+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 OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Approve an action's run"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"patch"}
+  path={"/v1/actions/runs/{run_id}/approval"}
+>
+
+</MethodEndpoint>
+
+
+
+This route allows you to approve or decline a request to execute an action that requires approval.<br/><br/>To learn more about manual approval for actions, check out the [documentation](https://docs.getport.io/create-self-service-experiences/set-self-service-actions-rbac/#configure-manual-approval-for-actions).
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+>
+</Heading>
+
+<details
+  style={{"marginBottom":"1rem"}}
+  className={"openapi-markdown__details"}
+  data-collapsed={false}
+  open={true}
+>
+  <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 approve/decline.<br/>","required":true}}
+      >
+
+      </ParamsItem>
+    </ul>
+  </div>
+</details><MimeTabs
+  className={"openapi-tabs__mime"}
+>
+  <TabItem
+    label={"application/json"}
+    value={"application/json-schema"}
+  >
+    <details
+      style={{}}
+      className={"openapi-markdown__details mime"}
+      data-collapsed={false}
+      open={true}
+    >
+      <summary
+        style={{}}
+        className={"openapi-markdown__details-summary-mime"}
+      >
+        <h3
+          className={"openapi-markdown__details-summary-header-body"}
+        >
+          Body
+        </h3><strong
+          className={"openapi-schema__required"}
+        >
+          required
+        </strong>
+      </summary><div
+        style={{"textAlign":"left","marginLeft":"1rem"}}
+      >
+
+      </div><ul
+        style={{"marginLeft":"1rem"}}
+      >
+        <SchemaItem
+          collapsible={false}
+          name={"status"}
+          required={true}
+          schemaName={"string"}
+          qualifierMessage={"**Possible values:** [`APPROVE`, `DECLINE`]"}
+          schema={{"type":"string","enum":["APPROVE","DECLINE"]}}
+        >
+
+        </SchemaItem><SchemaItem
+          collapsible={false}
+          name={"description"}
+          required={false}
+          schemaName={"string"}
+          qualifierMessage={undefined}
+          schema={{"type":"string","description":"A description and/or reason for the given status.<br/>"}}
+        >
+
+        </SchemaItem>
+      </ul>
+    </details>
+  </TabItem>
+</MimeTabs><div>
+  <div>
+    <ApiTabs
+      label={undefined}
+      id={undefined}
+    >
+      <TabItem
+        label={"200"}
+        value={"200"}
+      >
+        <div>
+
+
+          Default Response
+
+
+        </div><div>
+
+        </div>
+      </TabItem>
+    </ApiTabs>
+  </div>
+</div>
+
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Check out Port's [API reference](./api-reference.mdx) to learn more.
		Check out Port's [API reference](/api-reference/port-api) to learn more.