add org api docs

port-labs · Jun 15, 2024 · d61a92b · d61a92b
1 parent ef92e81
commit d61a92b
Show file tree

Hide file tree

Showing 5 changed files with 636 additions and 0 deletions.
diff --git a/docs/api-reference/get-organization-details.api.mdx b/docs/api-reference/get-organization-details.api.mdx
@@ -0,0 +1,69 @@
+---
+id: get-organization-details
+title: "Get organization details"
+description: "This route allows you to fetch the details of your Port organization, such as its name, id, and hidden blueprints."
+sidebar_label: "Get organization details"
+hide_title: true
+hide_table_of_contents: true
+api: eJzFUkGv0zAM/itWztW6cZwQ0pNAT4gDT/A4Pe3gtd4S0SUhcQqj6n/H7jro0DhzaZP4+2x//jyYlnKTXGQXvNmaZ+sypFCYALsufM9wDgU4wIG4scCWoCVG12UIB40leAqJIaQjevcTNU0FuQgWMzjO4PFEFbi2AvQtWNe25GHfFYrJec4rUxnGYzbbF/NxkcTsKpOpKcnxWWKD2RMmSnLcjRJKlGPwmYQ3mFfrtf5ulbylA5aO4dOMNONYmROxDa1Ej8RSOCJbudT9pl4KMFo69ZTyVLmkTkCWOeZtXWN0K2FHUb1ywYzVPUDJN5iFls+NpdOl7auiwfA5kmQQ5gc6S3WdmdwfinSb/jTlVJclbIWlapw/hInuuFP85MTD03uBavOXOWxWa2nSxJD5hF7hc/ZHurXtaqywbyY5mCZ4Js//bT0u02H6wXXsUKYgeqaZD7ODL6bfCDD8tT9WNGtwGPaY6UvqxlGfvxVKulNy7DE53OvwZK0W6/H47lnyYdHkS3u+TvbMB92Na8jre4/S9x3fJvD01W25S3kttoGY/+Y3/BL5J2Fegytah7Ibx/EXmZRNcQ==
+sidebar_class_name: "get 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={"Get organization details"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"get"}
+  path={"/v1/organization"}
+>
+
+</MethodEndpoint>
+
+
+
+This route allows you to fetch the details of your Port organization, such as its name, id, and hidden blueprints.
+
+<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/patch-organization-details.api.mdx b/docs/api-reference/patch-organization-details.api.mdx
@@ -0,0 +1,222 @@
+---
+id: patch-organization-details
+title: "Patch organization details"
+description: "This route allows you to patch the details of your Port organization, such as its name and hidden blueprints."
+sidebar_label: "Patch organization details"
+hide_title: true
+hide_table_of_contents: true
+api: eJy9VMFu2zAM/RVB5yxpdzSKAukwYMMOC7b2lOUg20ysVpY0iUqbGfn3kbLTOGm3YcCwBHAUiZTfe3xkJ2uIVdAetbOykLeNjiK4hCCUMe4xip1LAp3wCqtGYAOiBlTaROHWfBbEwgUULmyU1T8UXzMRMVGsikJjFFa1dJetRaPrGqwoTQIftMU4lROJahNlsZSfR/lyNZEBvieIeOPqnSw6WTmLYJGXynujqxw4u48MupOxaqBVvMKdB6LhynuokO73wXkIqCHyKWMZRUUkHBuKOtcAetTEkAmPuU2vyjC7lvuJjIBI2fHPb+2J3zzzHmWoENTuBYC5FfmAATzLJTRdgnqtIUSCpVDExiVTixIGaQdsE6kR2viS554/E6nqWvOLlFmMYK6VidDrrgPUXJOs1irnHLcxJMjsqxQ0UnGWnSxBBQicknytEAp3Us19rmf0zsZekLcXF/xzSvoup9bsnQpiXCdjduyQf1R698BPsKklnExi9VdaUPrqvEyvIx5UbgEbR6kyNw7DUdjQ39n2cnYiD2sZtlTULGUKhoIaRB+L2Ux5Pd0AeuqwqXbkutcCUjyJWR2L85W16ekfSnR0ntefgK3X94ScJ8IbjqA0M2xA1ZTFfFjvL8emfP+kWm/g2FTHZho3xkvrLw+BWX9t1y6D0siXyTxL5ouPdA1L0ut8Ob3ghvMuYqvs6JWLPJPGah6G03lLjSbI/x9xveAITzjzRpGwRCaXsRtMsZTbSwp0ZzOwIcJ82HWlinAXzH7P21SDwH1Hy60KWpWs3HJFlw7lYh89UG0L+a4n/eaWIXA4Acu1P+sjNlafMScre/xt7Gpk7sX89t0Hii6HOd26mpOCeqRNfhbyG32ZXK5ENkXe76RRdpPUhuP7i3NDJhZk7NKH7NJhwdQOR3Y3gnlu354NP5nbqylX5DNBPXD9HN6f/DJhkPcQzYXk6fgTLWmHDA==
+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={"Patch organization details"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"patch"}
+  path={"/v1/organization"}
+>
+
+</MethodEndpoint>
+
+
+
+This route allows you to patch the details of your Port organization, such as its name and hidden blueprints.
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+>
+</Heading>
+
+<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={"name"}
+          required={true}
+          schemaName={"string"}
+          qualifierMessage={undefined}
+          schema={{"type":"string","description":"The name of the organization.<br/>"}}
+        >
+
+        </SchemaItem><SchemaItem
+          collapsible={true}
+          className={"schemaItem"}
+        >
+          <details
+            style={{}}
+            className={"openapi-markdown__details"}
+          >
+            <summary
+              style={{}}
+            >
+              <span
+                className={"openapi-schema__container"}
+              >
+                <strong
+                  className={"openapi-schema__property"}
+                >
+                  settings
+                </strong><span
+                  className={"openapi-schema__name"}
+                >
+                   object
+                </span>
+              </span>
+            </summary><div
+              style={{"marginLeft":"1rem"}}
+            >
+              <SchemaItem
+                collapsible={false}
+                name={"hiddenBlueprints"}
+                required={false}
+                schemaName={"string[]"}
+                qualifierMessage={undefined}
+                schema={{"type":"array","description":"An array of blueprint identifiers that should be hidden.<br/>","items":{"type":"string"}}}
+              >
+
+              </SchemaItem>
+            </div>
+          </details>
+        </SchemaItem>
+      </ul>
+    </details>
+  </TabItem>
+</MimeTabs><div>
+  <div>
+    <ApiTabs
+      label={undefined}
+      id={undefined}
+    >
+      <TabItem
+        label={"200"}
+        value={"200"}
+      >
+        <div>
+
+
+          Updated successfully.
+
+
+        </div><div>
+          <MimeTabs
+            className={"openapi-tabs__mime"}
+            schemaType={"response"}
+          >
+            <TabItem
+              label={"application/json"}
+              value={"application/json"}
+            >
+              <SchemaTabs
+                className={"openapi-tabs__schema"}
+              >
+                <TabItem
+                  label={"Schema"}
+                  value={"Schema"}
+                >
+                  <details
+                    style={{}}
+                    className={"openapi-markdown__details response"}
+                    data-collapsed={false}
+                    open={true}
+                  >
+                    <summary
+                      style={{}}
+                      className={"openapi-markdown__details-summary-response"}
+                    >
+                      <strong>
+                        Schema
+                      </strong>
+                    </summary><div
+                      style={{"textAlign":"left","marginLeft":"1rem"}}
+                    >
+
+                    </div><ul
+                      style={{"marginLeft":"1rem"}}
+                    >
+                      <SchemaItem
+                        collapsible={false}
+                        name={"ok"}
+                        required={true}
+                        schemaName={""}
+                        qualifierMessage={"**Possible values:** [`true`]"}
+                        schema={{"enum":[true]}}
+                      >
+
+                      </SchemaItem>
+                    </ul>
+                  </details>
+                </TabItem><TabItem
+                  label={"Example (from schema)"}
+                  value={"Example (from schema)"}
+                >
+                  <ResponseSamples
+                    responseExample={"{}"}
+                    language={"json"}
+                  >
+
+                  </ResponseSamples>
+                </TabItem>
+              </SchemaTabs>
+            </TabItem>
+          </MimeTabs>
+        </div>
+      </TabItem>
+    </ApiTabs>
+  </div>
+</div>
+
diff --git a/docs/api-reference/sidebar.ts b/docs/api-reference/sidebar.ts
@@ -464,6 +464,30 @@ const sidebar: SidebarsConfig = {
         },
       ],
     },
+    {
+      type: "category",
+      label: "Organizations",
+      items: [
+        {
+          type: "doc",
+          id: "api-reference/get-organization-details",
+          label: "Get an organization",
+          className: "api-method get",
+        },
+        {
+          type: "doc",
+          id: "api-reference/patch-organization-details",
+          label: "Patch an organization",
+          className: "api-method patch",
+        },
+        {
+          type: "doc",
+          id: "api-reference/update-organization-details",
+          label: "Change an organization",
+          className: "api-method put",
+        }
+      ],
+    }
   ],
 };