Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/help/add-external-link/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Add an External Link"
description: "Add an link to an external service or document."
description: "Add a link to an external service, website, or document."
---

import ImageEnhancer from '@/components/ImageEnhancer.astro';
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/comments/create.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "create"
description: "Generated reference for the mutation endpoint comments/create."
title: "Comments API: Create"
description: "Reference for the create mutation in the Comments API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/comments/delete.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "delete"
description: "Generated reference for the mutation endpoint comments/delete."
title: "Comments API: Delete"
description: "Reference for the delete mutation in the Comments API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/help/api/comments/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: API Comments
description: Generated endpoint reference for the Comments namespace.
title: "Comments API"
description: "Endpoint reference for comments in the Operately API."
---

List, create and manage comments on resources
Expand All @@ -18,28 +18,28 @@ List, create and manage comments on resources
</thead>
<tbody>
<tr>
<td><a href="./create">create</a></td>
<td><a href="./create">Create</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/comments/create</code></td>
</tr>

<tr>
<td><a href="./delete">delete</a></td>
<td><a href="./delete">Delete</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/comments/delete</code></td>
</tr>

<tr>
<td><a href="./list">list</a></td>
<td><a href="./list">List</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/comments/list</code></td>
</tr>

<tr>
<td><a href="./update">update</a></td>
<td><a href="./update">Update</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/comments/update</code></td>
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/comments/list.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "list"
description: "Generated reference for the query endpoint comments/list."
title: "Comments API: List"
description: "Reference for the list query in the Comments API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/comments/update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "update"
description: "Generated reference for the mutation endpoint comments/update."
title: "Comments API: Update"
description: "Reference for the update mutation in the Comments API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "convert_member_to_guest"
description: "Generated reference for the mutation endpoint companies/convert_member_to_guest."
title: "Companies API: Convert member to guest"
description: "Reference for the convert member to guest mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/create.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "create"
description: "Generated reference for the mutation endpoint companies/create."
title: "Companies API: Create"
description: "Reference for the create mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/create_admins.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "create_admins"
description: "Generated reference for the mutation endpoint companies/create_admins."
title: "Companies API: Create admins"
description: "Reference for the create admins mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/create_member.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "create_member"
description: "Generated reference for the mutation endpoint companies/create_member."
title: "Companies API: Create member"
description: "Reference for the create member mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/delete_admin.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "delete_admin"
description: "Generated reference for the mutation endpoint companies/delete_admin."
title: "Companies API: Delete admin"
description: "Reference for the delete admin mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/delete_member.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "delete_member"
description: "Generated reference for the mutation endpoint companies/delete_member."
title: "Companies API: Delete member"
description: "Reference for the delete member mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/delete_owner.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "delete_owner"
description: "Generated reference for the mutation endpoint companies/delete_owner."
title: "Companies API: Delete owner"
description: "Reference for the delete owner mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "delete_trusted_email_domain"
description: "Generated reference for the mutation endpoint companies/delete_trusted_email_domain."
title: "Companies API: Delete trusted email domain"
description: "Reference for the delete trusted email domain mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/get.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "get"
description: "Generated reference for the query endpoint companies/get."
title: "Companies API: Get"
description: "Reference for the get query in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/get_activity.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "get_activity"
description: "Generated reference for the query endpoint companies/get_activity."
title: "Companies API: Get activity"
description: "Reference for the get activity query in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/get_flat_work_map.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "get_flat_work_map"
description: "Generated reference for the query endpoint companies/get_flat_work_map."
title: "Companies API: Get flat work map"
description: "Reference for the get flat work map query in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/get_work_map.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "get_work_map"
description: "Generated reference for the query endpoint companies/get_work_map."
title: "Companies API: Get work map"
description: "Reference for the get work map query in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/global_search.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "global_search"
description: "Generated reference for the query endpoint companies/global_search."
title: "Companies API: Global search"
description: "Reference for the global search query in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/grant_resource_access.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "grant_resource_access"
description: "Generated reference for the mutation endpoint companies/grant_resource_access."
title: "Companies API: Grant resource access"
description: "Reference for the grant resource access mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
44 changes: 22 additions & 22 deletions src/content/docs/help/api/companies/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: API Companies
description: Generated endpoint reference for the Companies namespace.
title: "Companies API"
description: "Endpoint reference for companies in the Operately API."
---

Get, list, update and manage company settings, members, and permissions
Expand All @@ -18,140 +18,140 @@ Get, list, update and manage company settings, members, and permissions
</thead>
<tbody>
<tr>
<td><a href="./convert_member_to_guest">convert_member_to_guest</a></td>
<td><a href="./convert_member_to_guest">Convert member to guest</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/convert_member_to_guest</code></td>
</tr>

<tr>
<td><a href="./create">create</a></td>
<td><a href="./create">Create</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/create</code></td>
</tr>

<tr>
<td><a href="./create_admins">create_admins</a></td>
<td><a href="./create_admins">Create admins</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/create_admins</code></td>
</tr>

<tr>
<td><a href="./create_member">create_member</a></td>
<td><a href="./create_member">Create member</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/create_member</code></td>
</tr>

<tr>
<td><a href="./delete_admin">delete_admin</a></td>
<td><a href="./delete_admin">Delete admin</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/delete_admin</code></td>
</tr>

<tr>
<td><a href="./delete_member">delete_member</a></td>
<td><a href="./delete_member">Delete member</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/delete_member</code></td>
</tr>

<tr>
<td><a href="./delete_owner">delete_owner</a></td>
<td><a href="./delete_owner">Delete owner</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/delete_owner</code></td>
</tr>

<tr>
<td><a href="./delete_trusted_email_domain">delete_trusted_email_domain</a></td>
<td><a href="./delete_trusted_email_domain">Delete trusted email domain</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/delete_trusted_email_domain</code></td>
</tr>

<tr>
<td><a href="./get">get</a></td>
<td><a href="./get">Get</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/get</code></td>
</tr>

<tr>
<td><a href="./get_activity">get_activity</a></td>
<td><a href="./get_activity">Get activity</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/get_activity</code></td>
</tr>

<tr>
<td><a href="./get_flat_work_map">get_flat_work_map</a></td>
<td><a href="./get_flat_work_map">Get flat work map</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/get_flat_work_map</code></td>
</tr>

<tr>
<td><a href="./get_work_map">get_work_map</a></td>
<td><a href="./get_work_map">Get work map</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/get_work_map</code></td>
</tr>

<tr>
<td><a href="./global_search">global_search</a></td>
<td><a href="./global_search">Global search</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/global_search</code></td>
</tr>

<tr>
<td><a href="./grant_resource_access">grant_resource_access</a></td>
<td><a href="./grant_resource_access">Grant resource access</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/grant_resource_access</code></td>
</tr>

<tr>
<td><a href="./invite_guest">invite_guest</a></td>
<td><a href="./invite_guest">Invite guest</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/invite_guest</code></td>
</tr>

<tr>
<td><a href="./list">list</a></td>
<td><a href="./list">List</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/list</code></td>
</tr>

<tr>
<td><a href="./list_activities">list_activities</a></td>
<td><a href="./list_activities">List activities</a></td>
<td><code>GET</code></td>
<td><code>query</code></td>
<td><code>/api/external/v1/companies/list_activities</code></td>
</tr>

<tr>
<td><a href="./restore_member">restore_member</a></td>
<td><a href="./restore_member">Restore member</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/restore_member</code></td>
</tr>

<tr>
<td><a href="./update">update</a></td>
<td><a href="./update">Update</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/update</code></td>
</tr>

<tr>
<td><a href="./update_members_permissions">update_members_permissions</a></td>
<td><a href="./update_members_permissions">Update members permissions</a></td>
<td><code>POST</code></td>
<td><code>mutation</code></td>
<td><code>/api/external/v1/companies/update_members_permissions</code></td>
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/invite_guest.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "invite_guest"
description: "Generated reference for the mutation endpoint companies/invite_guest."
title: "Companies API: Invite guest"
description: "Reference for the invite guest mutation in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/help/api/companies/list.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "list"
description: "Generated reference for the query endpoint companies/list."
title: "Companies API: List"
description: "Reference for the list query in the Companies API."
---

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
Expand Down
Loading