diff --git a/src/content/docs/help/add-external-link/index.mdx b/src/content/docs/help/add-external-link/index.mdx index 898bbc6..a05f08c 100644 --- a/src/content/docs/help/add-external-link/index.mdx +++ b/src/content/docs/help/add-external-link/index.mdx @@ -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'; diff --git a/src/content/docs/help/api/comments/create.mdx b/src/content/docs/help/api/comments/create.mdx index ca58ea0..61b5a12 100644 --- a/src/content/docs/help/api/comments/create.mdx +++ b/src/content/docs/help/api/comments/create.mdx @@ -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" diff --git a/src/content/docs/help/api/comments/delete.mdx b/src/content/docs/help/api/comments/delete.mdx index 1b02317..80125bc 100644 --- a/src/content/docs/help/api/comments/delete.mdx +++ b/src/content/docs/help/api/comments/delete.mdx @@ -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" diff --git a/src/content/docs/help/api/comments/index.mdx b/src/content/docs/help/api/comments/index.mdx index 1422d36..4aad6fc 100644 --- a/src/content/docs/help/api/comments/index.mdx +++ b/src/content/docs/help/api/comments/index.mdx @@ -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 @@ -18,28 +18,28 @@ List, create and manage comments on resources - create + Create POST mutation /api/external/v1/comments/create - delete + Delete POST mutation /api/external/v1/comments/delete - list + List GET query /api/external/v1/comments/list - update + Update POST mutation /api/external/v1/comments/update diff --git a/src/content/docs/help/api/comments/list.mdx b/src/content/docs/help/api/comments/list.mdx index 9a4ea33..f0ce467 100644 --- a/src/content/docs/help/api/comments/list.mdx +++ b/src/content/docs/help/api/comments/list.mdx @@ -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" diff --git a/src/content/docs/help/api/comments/update.mdx b/src/content/docs/help/api/comments/update.mdx index d0eb03b..380c0d8 100644 --- a/src/content/docs/help/api/comments/update.mdx +++ b/src/content/docs/help/api/comments/update.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/convert_member_to_guest.mdx b/src/content/docs/help/api/companies/convert_member_to_guest.mdx index 3873711..bcd7779 100644 --- a/src/content/docs/help/api/companies/convert_member_to_guest.mdx +++ b/src/content/docs/help/api/companies/convert_member_to_guest.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/create.mdx b/src/content/docs/help/api/companies/create.mdx index 5479f9c..53db7c8 100644 --- a/src/content/docs/help/api/companies/create.mdx +++ b/src/content/docs/help/api/companies/create.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/create_admins.mdx b/src/content/docs/help/api/companies/create_admins.mdx index 5ac6e0d..344458b 100644 --- a/src/content/docs/help/api/companies/create_admins.mdx +++ b/src/content/docs/help/api/companies/create_admins.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/create_member.mdx b/src/content/docs/help/api/companies/create_member.mdx index 0449158..29ff54a 100644 --- a/src/content/docs/help/api/companies/create_member.mdx +++ b/src/content/docs/help/api/companies/create_member.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/delete_admin.mdx b/src/content/docs/help/api/companies/delete_admin.mdx index dbe1dbf..7a90e1c 100644 --- a/src/content/docs/help/api/companies/delete_admin.mdx +++ b/src/content/docs/help/api/companies/delete_admin.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/delete_member.mdx b/src/content/docs/help/api/companies/delete_member.mdx index c87e427..3ae4bed 100644 --- a/src/content/docs/help/api/companies/delete_member.mdx +++ b/src/content/docs/help/api/companies/delete_member.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/delete_owner.mdx b/src/content/docs/help/api/companies/delete_owner.mdx index 0faee3c..0140689 100644 --- a/src/content/docs/help/api/companies/delete_owner.mdx +++ b/src/content/docs/help/api/companies/delete_owner.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/delete_trusted_email_domain.mdx b/src/content/docs/help/api/companies/delete_trusted_email_domain.mdx index 9e3abd2..11f7b91 100644 --- a/src/content/docs/help/api/companies/delete_trusted_email_domain.mdx +++ b/src/content/docs/help/api/companies/delete_trusted_email_domain.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/get.mdx b/src/content/docs/help/api/companies/get.mdx index 3b3e614..dba0e6c 100644 --- a/src/content/docs/help/api/companies/get.mdx +++ b/src/content/docs/help/api/companies/get.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/get_activity.mdx b/src/content/docs/help/api/companies/get_activity.mdx index 2c5206e..e33e266 100644 --- a/src/content/docs/help/api/companies/get_activity.mdx +++ b/src/content/docs/help/api/companies/get_activity.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/get_flat_work_map.mdx b/src/content/docs/help/api/companies/get_flat_work_map.mdx index 5f0a340..7542679 100644 --- a/src/content/docs/help/api/companies/get_flat_work_map.mdx +++ b/src/content/docs/help/api/companies/get_flat_work_map.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/get_work_map.mdx b/src/content/docs/help/api/companies/get_work_map.mdx index 8db1b33..8783f00 100644 --- a/src/content/docs/help/api/companies/get_work_map.mdx +++ b/src/content/docs/help/api/companies/get_work_map.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/global_search.mdx b/src/content/docs/help/api/companies/global_search.mdx index baaed7c..ae9ee19 100644 --- a/src/content/docs/help/api/companies/global_search.mdx +++ b/src/content/docs/help/api/companies/global_search.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/grant_resource_access.mdx b/src/content/docs/help/api/companies/grant_resource_access.mdx index 6c7f7a5..06792d2 100644 --- a/src/content/docs/help/api/companies/grant_resource_access.mdx +++ b/src/content/docs/help/api/companies/grant_resource_access.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/index.mdx b/src/content/docs/help/api/companies/index.mdx index f170bab..6abd9c6 100644 --- a/src/content/docs/help/api/companies/index.mdx +++ b/src/content/docs/help/api/companies/index.mdx @@ -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 @@ -18,140 +18,140 @@ Get, list, update and manage company settings, members, and permissions - convert_member_to_guest + Convert member to guest POST mutation /api/external/v1/companies/convert_member_to_guest - create + Create POST mutation /api/external/v1/companies/create - create_admins + Create admins POST mutation /api/external/v1/companies/create_admins - create_member + Create member POST mutation /api/external/v1/companies/create_member - delete_admin + Delete admin POST mutation /api/external/v1/companies/delete_admin - delete_member + Delete member POST mutation /api/external/v1/companies/delete_member - delete_owner + Delete owner POST mutation /api/external/v1/companies/delete_owner - delete_trusted_email_domain + Delete trusted email domain POST mutation /api/external/v1/companies/delete_trusted_email_domain - get + Get GET query /api/external/v1/companies/get - get_activity + Get activity GET query /api/external/v1/companies/get_activity - get_flat_work_map + Get flat work map GET query /api/external/v1/companies/get_flat_work_map - get_work_map + Get work map GET query /api/external/v1/companies/get_work_map - global_search + Global search GET query /api/external/v1/companies/global_search - grant_resource_access + Grant resource access POST mutation /api/external/v1/companies/grant_resource_access - invite_guest + Invite guest POST mutation /api/external/v1/companies/invite_guest - list + List GET query /api/external/v1/companies/list - list_activities + List activities GET query /api/external/v1/companies/list_activities - restore_member + Restore member POST mutation /api/external/v1/companies/restore_member - update + Update POST mutation /api/external/v1/companies/update - update_members_permissions + Update members permissions POST mutation /api/external/v1/companies/update_members_permissions diff --git a/src/content/docs/help/api/companies/invite_guest.mdx b/src/content/docs/help/api/companies/invite_guest.mdx index bb1376c..e7127cc 100644 --- a/src/content/docs/help/api/companies/invite_guest.mdx +++ b/src/content/docs/help/api/companies/invite_guest.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/list.mdx b/src/content/docs/help/api/companies/list.mdx index b75b620..327f764 100644 --- a/src/content/docs/help/api/companies/list.mdx +++ b/src/content/docs/help/api/companies/list.mdx @@ -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" diff --git a/src/content/docs/help/api/companies/list_activities.mdx b/src/content/docs/help/api/companies/list_activities.mdx index 600a4bf..b12e837 100644 --- a/src/content/docs/help/api/companies/list_activities.mdx +++ b/src/content/docs/help/api/companies/list_activities.mdx @@ -1,6 +1,6 @@ --- -title: "list_activities" -description: "Generated reference for the query endpoint companies/list_activities." +title: "Companies API: List activities" +description: "Reference for the list activities query in the Companies API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/companies/restore_member.mdx b/src/content/docs/help/api/companies/restore_member.mdx index 04e933f..26bcd18 100644 --- a/src/content/docs/help/api/companies/restore_member.mdx +++ b/src/content/docs/help/api/companies/restore_member.mdx @@ -1,6 +1,6 @@ --- -title: "restore_member" -description: "Generated reference for the mutation endpoint companies/restore_member." +title: "Companies API: Restore member" +description: "Reference for the restore member mutation in the Companies API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/companies/update.mdx b/src/content/docs/help/api/companies/update.mdx index 5d6cad7..b639408 100644 --- a/src/content/docs/help/api/companies/update.mdx +++ b/src/content/docs/help/api/companies/update.mdx @@ -1,6 +1,6 @@ --- -title: "update" -description: "Generated reference for the mutation endpoint companies/update." +title: "Companies API: Update" +description: "Reference for the update mutation in the Companies API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/companies/update_members_permissions.mdx b/src/content/docs/help/api/companies/update_members_permissions.mdx index 407d14d..1f219de 100644 --- a/src/content/docs/help/api/companies/update_members_permissions.mdx +++ b/src/content/docs/help/api/companies/update_members_permissions.mdx @@ -1,6 +1,6 @@ --- -title: "update_members_permissions" -description: "Generated reference for the mutation endpoint companies/update_members_permissions." +title: "Companies API: Update members permissions" +description: "Reference for the update members permissions mutation in the Companies API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/documents/create.mdx b/src/content/docs/help/api/documents/create.mdx index d0c854c..d50546d 100644 --- a/src/content/docs/help/api/documents/create.mdx +++ b/src/content/docs/help/api/documents/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint documents/create." +title: "Documents API: Create" +description: "Reference for the create mutation in the Documents API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/documents/delete.mdx b/src/content/docs/help/api/documents/delete.mdx index f2bdb39..da55773 100644 --- a/src/content/docs/help/api/documents/delete.mdx +++ b/src/content/docs/help/api/documents/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint documents/delete." +title: "Documents API: Delete" +description: "Reference for the delete mutation in the Documents API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/documents/get.mdx b/src/content/docs/help/api/documents/get.mdx index 249ef65..2d34d2d 100644 --- a/src/content/docs/help/api/documents/get.mdx +++ b/src/content/docs/help/api/documents/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint documents/get." +title: "Documents API: Get" +description: "Reference for the get query in the Documents API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/documents/index.mdx b/src/content/docs/help/api/documents/index.mdx index d30f702..b13292a 100644 --- a/src/content/docs/help/api/documents/index.mdx +++ b/src/content/docs/help/api/documents/index.mdx @@ -1,6 +1,6 @@ --- -title: API Documents -description: Generated endpoint reference for the Documents namespace. +title: "Documents API" +description: "Endpoint reference for documents in the Operately API." --- Get, create and manage documents in resource hubs @@ -18,35 +18,35 @@ Get, create and manage documents in resource hubs - create + Create POST mutation /api/external/v1/documents/create - delete + Delete POST mutation /api/external/v1/documents/delete - get + Get GET query /api/external/v1/documents/get - publish + Publish POST mutation /api/external/v1/documents/publish - update + Update POST mutation /api/external/v1/documents/update diff --git a/src/content/docs/help/api/documents/publish.mdx b/src/content/docs/help/api/documents/publish.mdx index 398f487..2575189 100644 --- a/src/content/docs/help/api/documents/publish.mdx +++ b/src/content/docs/help/api/documents/publish.mdx @@ -1,6 +1,6 @@ --- -title: "publish" -description: "Generated reference for the mutation endpoint documents/publish." +title: "Documents API: Publish" +description: "Reference for the publish mutation in the Documents API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/documents/update.mdx b/src/content/docs/help/api/documents/update.mdx index 6f558ce..733dfd5 100644 --- a/src/content/docs/help/api/documents/update.mdx +++ b/src/content/docs/help/api/documents/update.mdx @@ -1,6 +1,6 @@ --- -title: "update" -description: "Generated reference for the mutation endpoint documents/update." +title: "Documents API: Update" +description: "Reference for the update mutation in the Documents API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/acknowledge_check_in.mdx b/src/content/docs/help/api/goals/acknowledge_check_in.mdx index fd2de2c..6a7ff4c 100644 --- a/src/content/docs/help/api/goals/acknowledge_check_in.mdx +++ b/src/content/docs/help/api/goals/acknowledge_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "acknowledge_check_in" -description: "Generated reference for the mutation endpoint goals/acknowledge_check_in." +title: "Goals API: Acknowledge check-in" +description: "Reference for the acknowledge check-in mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/change_parent.mdx b/src/content/docs/help/api/goals/change_parent.mdx index 3814697..c653343 100644 --- a/src/content/docs/help/api/goals/change_parent.mdx +++ b/src/content/docs/help/api/goals/change_parent.mdx @@ -1,6 +1,6 @@ --- -title: "change_parent" -description: "Generated reference for the mutation endpoint goals/change_parent." +title: "Goals API: Change parent" +description: "Reference for the change parent mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/close.mdx b/src/content/docs/help/api/goals/close.mdx index 80e789c..419c78f 100644 --- a/src/content/docs/help/api/goals/close.mdx +++ b/src/content/docs/help/api/goals/close.mdx @@ -1,6 +1,6 @@ --- -title: "close" -description: "Generated reference for the mutation endpoint goals/close." +title: "Goals API: Close" +description: "Reference for the close mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/create.mdx b/src/content/docs/help/api/goals/create.mdx index af02ebe..5fd9b95 100644 --- a/src/content/docs/help/api/goals/create.mdx +++ b/src/content/docs/help/api/goals/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint goals/create." +title: "Goals API: Create" +description: "Reference for the create mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/create_access_members.mdx b/src/content/docs/help/api/goals/create_access_members.mdx index 3def815..cb4b448 100644 --- a/src/content/docs/help/api/goals/create_access_members.mdx +++ b/src/content/docs/help/api/goals/create_access_members.mdx @@ -1,6 +1,6 @@ --- -title: "create_access_members" -description: "Generated reference for the mutation endpoint goals/create_access_members." +title: "Goals API: Create access members" +description: "Reference for the create access members mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/create_check.mdx b/src/content/docs/help/api/goals/create_check.mdx index 5b9e6fc..0a59300 100644 --- a/src/content/docs/help/api/goals/create_check.mdx +++ b/src/content/docs/help/api/goals/create_check.mdx @@ -1,6 +1,6 @@ --- -title: "create_check" -description: "Generated reference for the mutation endpoint goals/create_check." +title: "Goals API: Create check" +description: "Reference for the create check mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/create_check_in.mdx b/src/content/docs/help/api/goals/create_check_in.mdx index a3d47d4..796ca4b 100644 --- a/src/content/docs/help/api/goals/create_check_in.mdx +++ b/src/content/docs/help/api/goals/create_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "create_check_in" -description: "Generated reference for the mutation endpoint goals/create_check_in." +title: "Goals API: Create check-in" +description: "Reference for the create check-in mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/create_discussion.mdx b/src/content/docs/help/api/goals/create_discussion.mdx index 683ba58..0e99b18 100644 --- a/src/content/docs/help/api/goals/create_discussion.mdx +++ b/src/content/docs/help/api/goals/create_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "create_discussion" -description: "Generated reference for the mutation endpoint goals/create_discussion." +title: "Goals API: Create discussion" +description: "Reference for the create discussion mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/create_target.mdx b/src/content/docs/help/api/goals/create_target.mdx index c095156..dd464da 100644 --- a/src/content/docs/help/api/goals/create_target.mdx +++ b/src/content/docs/help/api/goals/create_target.mdx @@ -1,6 +1,6 @@ --- -title: "create_target" -description: "Generated reference for the mutation endpoint goals/create_target." +title: "Goals API: Create target" +description: "Reference for the create target mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/delete.mdx b/src/content/docs/help/api/goals/delete.mdx index 5a4b8ec..541d175 100644 --- a/src/content/docs/help/api/goals/delete.mdx +++ b/src/content/docs/help/api/goals/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint goals/delete." +title: "Goals API: Delete" +description: "Reference for the delete mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/delete_access_member.mdx b/src/content/docs/help/api/goals/delete_access_member.mdx index 017a22e..760e124 100644 --- a/src/content/docs/help/api/goals/delete_access_member.mdx +++ b/src/content/docs/help/api/goals/delete_access_member.mdx @@ -1,6 +1,6 @@ --- -title: "delete_access_member" -description: "Generated reference for the mutation endpoint goals/delete_access_member." +title: "Goals API: Delete access member" +description: "Reference for the delete access member mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/delete_check.mdx b/src/content/docs/help/api/goals/delete_check.mdx index 16d2965..66528d4 100644 --- a/src/content/docs/help/api/goals/delete_check.mdx +++ b/src/content/docs/help/api/goals/delete_check.mdx @@ -1,6 +1,6 @@ --- -title: "delete_check" -description: "Generated reference for the mutation endpoint goals/delete_check." +title: "Goals API: Delete check" +description: "Reference for the delete check mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/delete_target.mdx b/src/content/docs/help/api/goals/delete_target.mdx index 034c5de..723980a 100644 --- a/src/content/docs/help/api/goals/delete_target.mdx +++ b/src/content/docs/help/api/goals/delete_target.mdx @@ -1,6 +1,6 @@ --- -title: "delete_target" -description: "Generated reference for the mutation endpoint goals/delete_target." +title: "Goals API: Delete target" +description: "Reference for the delete target mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/get.mdx b/src/content/docs/help/api/goals/get.mdx index 22fe84d..c4140d7 100644 --- a/src/content/docs/help/api/goals/get.mdx +++ b/src/content/docs/help/api/goals/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint goals/get." +title: "Goals API: Get" +description: "Reference for the get query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/get_check_in.mdx b/src/content/docs/help/api/goals/get_check_in.mdx index 2261a4d..2543df7 100644 --- a/src/content/docs/help/api/goals/get_check_in.mdx +++ b/src/content/docs/help/api/goals/get_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "get_check_in" -description: "Generated reference for the query endpoint goals/get_check_in." +title: "Goals API: Get check-in" +description: "Reference for the get check-in query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/index.mdx b/src/content/docs/help/api/goals/index.mdx index 621fab0..b149a11 100644 --- a/src/content/docs/help/api/goals/index.mdx +++ b/src/content/docs/help/api/goals/index.mdx @@ -1,6 +1,6 @@ --- -title: API Goals -description: Generated endpoint reference for the Goals namespace. +title: "Goals API" +description: "Endpoint reference for goals in the Operately API." --- Get, list, create and manage goals @@ -18,280 +18,280 @@ Get, list, create and manage goals - acknowledge_check_in + Acknowledge check-in POST mutation /api/external/v1/goals/acknowledge_check_in - change_parent + Change parent POST mutation /api/external/v1/goals/change_parent - close + Close POST mutation /api/external/v1/goals/close - create + Create POST mutation /api/external/v1/goals/create - create_access_members + Create access members POST mutation /api/external/v1/goals/create_access_members - create_check + Create check POST mutation /api/external/v1/goals/create_check - create_check_in + Create check-in POST mutation /api/external/v1/goals/create_check_in - create_discussion + Create discussion POST mutation /api/external/v1/goals/create_discussion - create_target + Create target POST mutation /api/external/v1/goals/create_target - delete + Delete POST mutation /api/external/v1/goals/delete - delete_access_member + Delete access member POST mutation /api/external/v1/goals/delete_access_member - delete_check + Delete check POST mutation /api/external/v1/goals/delete_check - delete_target + Delete target POST mutation /api/external/v1/goals/delete_target - get + Get GET query /api/external/v1/goals/get - get_check_in + Get check-in GET query /api/external/v1/goals/get_check_in - list + List GET query /api/external/v1/goals/list - list_access_members + List access members GET query /api/external/v1/goals/list_access_members - list_check_ins + List check-ins GET query /api/external/v1/goals/list_check_ins - list_contributors + List contributors GET query /api/external/v1/goals/list_contributors - list_discussions + List discussions GET query /api/external/v1/goals/list_discussions - reopen + Reopen POST mutation /api/external/v1/goals/reopen - search_parent_goal + Search parent goal GET query /api/external/v1/goals/search_parent_goal - toggle_check + Toggle check POST mutation /api/external/v1/goals/toggle_check - update_access_levels + Update access levels POST mutation /api/external/v1/goals/update_access_levels - update_access_member + Update access member POST mutation /api/external/v1/goals/update_access_member - update_champion + Update champion POST mutation /api/external/v1/goals/update_champion - update_check + Update check POST mutation /api/external/v1/goals/update_check - update_check_in + Update check-in POST mutation /api/external/v1/goals/update_check_in - update_check_index + Update check index POST mutation /api/external/v1/goals/update_check_index - update_description + Update description POST mutation /api/external/v1/goals/update_description - update_discussion + Update discussion POST mutation /api/external/v1/goals/update_discussion - update_due_date + Update due date POST mutation /api/external/v1/goals/update_due_date - update_name + Update name POST mutation /api/external/v1/goals/update_name - update_parent_goal + Update parent goal POST mutation /api/external/v1/goals/update_parent_goal - update_reviewer + Update reviewer POST mutation /api/external/v1/goals/update_reviewer - update_space + Update space POST mutation /api/external/v1/goals/update_space - update_start_date + Update start date POST mutation /api/external/v1/goals/update_start_date - update_target + Update target POST mutation /api/external/v1/goals/update_target - update_target_index + Update target index POST mutation /api/external/v1/goals/update_target_index - update_target_value + Update target value POST mutation /api/external/v1/goals/update_target_value diff --git a/src/content/docs/help/api/goals/list.mdx b/src/content/docs/help/api/goals/list.mdx index e001a62..8065ca2 100644 --- a/src/content/docs/help/api/goals/list.mdx +++ b/src/content/docs/help/api/goals/list.mdx @@ -1,6 +1,6 @@ --- -title: "list" -description: "Generated reference for the query endpoint goals/list." +title: "Goals API: List" +description: "Reference for the list query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/list_access_members.mdx b/src/content/docs/help/api/goals/list_access_members.mdx index a39ffda..5bd4984 100644 --- a/src/content/docs/help/api/goals/list_access_members.mdx +++ b/src/content/docs/help/api/goals/list_access_members.mdx @@ -1,6 +1,6 @@ --- -title: "list_access_members" -description: "Generated reference for the query endpoint goals/list_access_members." +title: "Goals API: List access members" +description: "Reference for the list access members query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/list_check_ins.mdx b/src/content/docs/help/api/goals/list_check_ins.mdx index fe51151..6f29e34 100644 --- a/src/content/docs/help/api/goals/list_check_ins.mdx +++ b/src/content/docs/help/api/goals/list_check_ins.mdx @@ -1,6 +1,6 @@ --- -title: "list_check_ins" -description: "Generated reference for the query endpoint goals/list_check_ins." +title: "Goals API: List check-ins" +description: "Reference for the list check-ins query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/list_contributors.mdx b/src/content/docs/help/api/goals/list_contributors.mdx index 3160b06..fb7e21e 100644 --- a/src/content/docs/help/api/goals/list_contributors.mdx +++ b/src/content/docs/help/api/goals/list_contributors.mdx @@ -1,6 +1,6 @@ --- -title: "list_contributors" -description: "Generated reference for the query endpoint goals/list_contributors." +title: "Goals API: List contributors" +description: "Reference for the list contributors query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/list_discussions.mdx b/src/content/docs/help/api/goals/list_discussions.mdx index 5fca770..f0e3e5d 100644 --- a/src/content/docs/help/api/goals/list_discussions.mdx +++ b/src/content/docs/help/api/goals/list_discussions.mdx @@ -1,6 +1,6 @@ --- -title: "list_discussions" -description: "Generated reference for the query endpoint goals/list_discussions." +title: "Goals API: List discussions" +description: "Reference for the list discussions query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/reopen.mdx b/src/content/docs/help/api/goals/reopen.mdx index 419e31d..74314e7 100644 --- a/src/content/docs/help/api/goals/reopen.mdx +++ b/src/content/docs/help/api/goals/reopen.mdx @@ -1,6 +1,6 @@ --- -title: "reopen" -description: "Generated reference for the mutation endpoint goals/reopen." +title: "Goals API: Reopen" +description: "Reference for the reopen mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/search_parent_goal.mdx b/src/content/docs/help/api/goals/search_parent_goal.mdx index eb79e1c..f2dd107 100644 --- a/src/content/docs/help/api/goals/search_parent_goal.mdx +++ b/src/content/docs/help/api/goals/search_parent_goal.mdx @@ -1,6 +1,6 @@ --- -title: "search_parent_goal" -description: "Generated reference for the query endpoint goals/search_parent_goal." +title: "Goals API: Search parent goal" +description: "Reference for the search parent goal query in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/toggle_check.mdx b/src/content/docs/help/api/goals/toggle_check.mdx index c175045..ee06b3c 100644 --- a/src/content/docs/help/api/goals/toggle_check.mdx +++ b/src/content/docs/help/api/goals/toggle_check.mdx @@ -1,6 +1,6 @@ --- -title: "toggle_check" -description: "Generated reference for the mutation endpoint goals/toggle_check." +title: "Goals API: Toggle check" +description: "Reference for the toggle check mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_access_levels.mdx b/src/content/docs/help/api/goals/update_access_levels.mdx index 344b072..be83a29 100644 --- a/src/content/docs/help/api/goals/update_access_levels.mdx +++ b/src/content/docs/help/api/goals/update_access_levels.mdx @@ -1,6 +1,6 @@ --- -title: "update_access_levels" -description: "Generated reference for the mutation endpoint goals/update_access_levels." +title: "Goals API: Update access levels" +description: "Reference for the update access levels mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_access_member.mdx b/src/content/docs/help/api/goals/update_access_member.mdx index 12ee44d..77360df 100644 --- a/src/content/docs/help/api/goals/update_access_member.mdx +++ b/src/content/docs/help/api/goals/update_access_member.mdx @@ -1,6 +1,6 @@ --- -title: "update_access_member" -description: "Generated reference for the mutation endpoint goals/update_access_member." +title: "Goals API: Update access member" +description: "Reference for the update access member mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_champion.mdx b/src/content/docs/help/api/goals/update_champion.mdx index 7f61d3a..464f76b 100644 --- a/src/content/docs/help/api/goals/update_champion.mdx +++ b/src/content/docs/help/api/goals/update_champion.mdx @@ -1,6 +1,6 @@ --- -title: "update_champion" -description: "Generated reference for the mutation endpoint goals/update_champion." +title: "Goals API: Update champion" +description: "Reference for the update champion mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_check.mdx b/src/content/docs/help/api/goals/update_check.mdx index e52cfe1..00328d3 100644 --- a/src/content/docs/help/api/goals/update_check.mdx +++ b/src/content/docs/help/api/goals/update_check.mdx @@ -1,6 +1,6 @@ --- -title: "update_check" -description: "Generated reference for the mutation endpoint goals/update_check." +title: "Goals API: Update check" +description: "Reference for the update check mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_check_in.mdx b/src/content/docs/help/api/goals/update_check_in.mdx index 74a0371..6a99534 100644 --- a/src/content/docs/help/api/goals/update_check_in.mdx +++ b/src/content/docs/help/api/goals/update_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "update_check_in" -description: "Generated reference for the mutation endpoint goals/update_check_in." +title: "Goals API: Update check-in" +description: "Reference for the update check-in mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_check_index.mdx b/src/content/docs/help/api/goals/update_check_index.mdx index 5228825..50a08cc 100644 --- a/src/content/docs/help/api/goals/update_check_index.mdx +++ b/src/content/docs/help/api/goals/update_check_index.mdx @@ -1,6 +1,6 @@ --- -title: "update_check_index" -description: "Generated reference for the mutation endpoint goals/update_check_index." +title: "Goals API: Update check index" +description: "Reference for the update check index mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_description.mdx b/src/content/docs/help/api/goals/update_description.mdx index 17dde8f..5d1e33b 100644 --- a/src/content/docs/help/api/goals/update_description.mdx +++ b/src/content/docs/help/api/goals/update_description.mdx @@ -1,6 +1,6 @@ --- -title: "update_description" -description: "Generated reference for the mutation endpoint goals/update_description." +title: "Goals API: Update description" +description: "Reference for the update description mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_discussion.mdx b/src/content/docs/help/api/goals/update_discussion.mdx index d35bd93..1adb53f 100644 --- a/src/content/docs/help/api/goals/update_discussion.mdx +++ b/src/content/docs/help/api/goals/update_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "update_discussion" -description: "Generated reference for the mutation endpoint goals/update_discussion." +title: "Goals API: Update discussion" +description: "Reference for the update discussion mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_due_date.mdx b/src/content/docs/help/api/goals/update_due_date.mdx index 18a98e3..6349771 100644 --- a/src/content/docs/help/api/goals/update_due_date.mdx +++ b/src/content/docs/help/api/goals/update_due_date.mdx @@ -1,6 +1,6 @@ --- -title: "update_due_date" -description: "Generated reference for the mutation endpoint goals/update_due_date." +title: "Goals API: Update due date" +description: "Reference for the update due date mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_name.mdx b/src/content/docs/help/api/goals/update_name.mdx index 9798ea5..2ec070d 100644 --- a/src/content/docs/help/api/goals/update_name.mdx +++ b/src/content/docs/help/api/goals/update_name.mdx @@ -1,6 +1,6 @@ --- -title: "update_name" -description: "Generated reference for the mutation endpoint goals/update_name." +title: "Goals API: Update name" +description: "Reference for the update name mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_parent_goal.mdx b/src/content/docs/help/api/goals/update_parent_goal.mdx index 2786803..a2034e2 100644 --- a/src/content/docs/help/api/goals/update_parent_goal.mdx +++ b/src/content/docs/help/api/goals/update_parent_goal.mdx @@ -1,6 +1,6 @@ --- -title: "update_parent_goal" -description: "Generated reference for the mutation endpoint goals/update_parent_goal." +title: "Goals API: Update parent goal" +description: "Reference for the update parent goal mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_reviewer.mdx b/src/content/docs/help/api/goals/update_reviewer.mdx index 5d4d1d0..b092b71 100644 --- a/src/content/docs/help/api/goals/update_reviewer.mdx +++ b/src/content/docs/help/api/goals/update_reviewer.mdx @@ -1,6 +1,6 @@ --- -title: "update_reviewer" -description: "Generated reference for the mutation endpoint goals/update_reviewer." +title: "Goals API: Update reviewer" +description: "Reference for the update reviewer mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_space.mdx b/src/content/docs/help/api/goals/update_space.mdx index 368c87b..49604bc 100644 --- a/src/content/docs/help/api/goals/update_space.mdx +++ b/src/content/docs/help/api/goals/update_space.mdx @@ -1,6 +1,6 @@ --- -title: "update_space" -description: "Generated reference for the mutation endpoint goals/update_space." +title: "Goals API: Update space" +description: "Reference for the update space mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_start_date.mdx b/src/content/docs/help/api/goals/update_start_date.mdx index 4074391..4dd5bfc 100644 --- a/src/content/docs/help/api/goals/update_start_date.mdx +++ b/src/content/docs/help/api/goals/update_start_date.mdx @@ -1,6 +1,6 @@ --- -title: "update_start_date" -description: "Generated reference for the mutation endpoint goals/update_start_date." +title: "Goals API: Update start date" +description: "Reference for the update start date mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_target.mdx b/src/content/docs/help/api/goals/update_target.mdx index 8bf35cc..339ac62 100644 --- a/src/content/docs/help/api/goals/update_target.mdx +++ b/src/content/docs/help/api/goals/update_target.mdx @@ -1,6 +1,6 @@ --- -title: "update_target" -description: "Generated reference for the mutation endpoint goals/update_target." +title: "Goals API: Update target" +description: "Reference for the update target mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_target_index.mdx b/src/content/docs/help/api/goals/update_target_index.mdx index 8528a96..4a77a65 100644 --- a/src/content/docs/help/api/goals/update_target_index.mdx +++ b/src/content/docs/help/api/goals/update_target_index.mdx @@ -1,6 +1,6 @@ --- -title: "update_target_index" -description: "Generated reference for the mutation endpoint goals/update_target_index." +title: "Goals API: Update target index" +description: "Reference for the update target index mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/goals/update_target_value.mdx b/src/content/docs/help/api/goals/update_target_value.mdx index baae5b6..82b2317 100644 --- a/src/content/docs/help/api/goals/update_target_value.mdx +++ b/src/content/docs/help/api/goals/update_target_value.mdx @@ -1,6 +1,6 @@ --- -title: "update_target_value" -description: "Generated reference for the mutation endpoint goals/update_target_value." +title: "Goals API: Update target value" +description: "Reference for the update target value mutation in the Goals API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/index.mdx b/src/content/docs/help/api/index.mdx index 3afdd20..761c722 100644 --- a/src/content/docs/help/api/index.mdx +++ b/src/content/docs/help/api/index.mdx @@ -1,10 +1,15 @@ --- -title: API docs -description: Generated reference for Operately API endpoints. +title: "Operately API docs" +description: "Learn how to authenticate and use the Operately API with namespace-by-namespace endpoint reference." --- Operately API provides HTTP endpoints for querying and mutating Operately resources. +## Start here + +- [Create an API token](/help/create-api-token) to authenticate your requests. +- [Use the Operately CLI](/help/cli) if you want to work with the API from your terminal. + - Every endpoint is authenticated with an API token. - Use the header `Authorization: Bearer `. - Queries are read operations (`GET`). @@ -29,4 +34,3 @@ Operately API provides HTTP endpoints for querying and mutating Operately resour | [Tasks](./tasks) | 3 | 10 | 13 | - diff --git a/src/content/docs/help/api/links/create.mdx b/src/content/docs/help/api/links/create.mdx index d858904..e7366c1 100644 --- a/src/content/docs/help/api/links/create.mdx +++ b/src/content/docs/help/api/links/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint links/create." +title: "Links API: Create" +description: "Reference for the create mutation in the Links API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/links/delete.mdx b/src/content/docs/help/api/links/delete.mdx index 63d6bbb..b8d2ab8 100644 --- a/src/content/docs/help/api/links/delete.mdx +++ b/src/content/docs/help/api/links/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint links/delete." +title: "Links API: Delete" +description: "Reference for the delete mutation in the Links API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/links/get.mdx b/src/content/docs/help/api/links/get.mdx index ec09dc4..51aff0a 100644 --- a/src/content/docs/help/api/links/get.mdx +++ b/src/content/docs/help/api/links/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint links/get." +title: "Links API: Get" +description: "Reference for the get query in the Links API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/links/index.mdx b/src/content/docs/help/api/links/index.mdx index 647d0fa..0c52bc8 100644 --- a/src/content/docs/help/api/links/index.mdx +++ b/src/content/docs/help/api/links/index.mdx @@ -1,6 +1,6 @@ --- -title: API Links -description: Generated endpoint reference for the Links namespace. +title: "Links API" +description: "Endpoint reference for links in the Operately API." --- Get, create and manage links in resource hubs @@ -18,28 +18,28 @@ Get, create and manage links in resource hubs - create + Create POST mutation /api/external/v1/links/create - delete + Delete POST mutation /api/external/v1/links/delete - get + Get GET query /api/external/v1/links/get - update + Update POST mutation /api/external/v1/links/update diff --git a/src/content/docs/help/api/links/update.mdx b/src/content/docs/help/api/links/update.mdx index ae97930..e4ad2ac 100644 --- a/src/content/docs/help/api/links/update.mdx +++ b/src/content/docs/help/api/links/update.mdx @@ -1,6 +1,6 @@ --- -title: "update" -description: "Generated reference for the mutation endpoint links/update." +title: "Links API: Update" +description: "Reference for the update mutation in the Links API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/get_unread_count.mdx b/src/content/docs/help/api/notifications/get_unread_count.mdx index 755ff80..dec4f45 100644 --- a/src/content/docs/help/api/notifications/get_unread_count.mdx +++ b/src/content/docs/help/api/notifications/get_unread_count.mdx @@ -1,6 +1,6 @@ --- -title: "get_unread_count" -description: "Generated reference for the query endpoint notifications/get_unread_count." +title: "Notifications API: Get unread count" +description: "Reference for the get unread count query in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/index.mdx b/src/content/docs/help/api/notifications/index.mdx index 06b02e5..979c9f8 100644 --- a/src/content/docs/help/api/notifications/index.mdx +++ b/src/content/docs/help/api/notifications/index.mdx @@ -1,6 +1,6 @@ --- -title: API Notifications -description: Generated endpoint reference for the Notifications namespace. +title: "Notifications API" +description: "Endpoint reference for notifications in the Operately API." --- List and manage notifications and subscriptions @@ -18,63 +18,63 @@ List and manage notifications and subscriptions - get_unread_count + Get unread count GET query /api/external/v1/notifications/get_unread_count - is_subscribed + Is subscribed GET query /api/external/v1/notifications/is_subscribed - list + List GET query /api/external/v1/notifications/list - mark_all_as_read + Mark all as read POST mutation /api/external/v1/notifications/mark_all_as_read - mark_as_read + Mark as read POST mutation /api/external/v1/notifications/mark_as_read - mark_many_as_read + Mark many as read POST mutation /api/external/v1/notifications/mark_many_as_read - subscribe + Subscribe POST mutation /api/external/v1/notifications/subscribe - unsubscribe + Unsubscribe POST mutation /api/external/v1/notifications/unsubscribe - update_subscriptions_list + Update subscriptions list POST mutation /api/external/v1/notifications/update_subscriptions_list diff --git a/src/content/docs/help/api/notifications/is_subscribed.mdx b/src/content/docs/help/api/notifications/is_subscribed.mdx index 4a7cea4..dae635f 100644 --- a/src/content/docs/help/api/notifications/is_subscribed.mdx +++ b/src/content/docs/help/api/notifications/is_subscribed.mdx @@ -1,6 +1,6 @@ --- -title: "is_subscribed" -description: "Generated reference for the query endpoint notifications/is_subscribed." +title: "Notifications API: Is subscribed" +description: "Reference for the is subscribed query in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/list.mdx b/src/content/docs/help/api/notifications/list.mdx index c4ac3f8..8f43127 100644 --- a/src/content/docs/help/api/notifications/list.mdx +++ b/src/content/docs/help/api/notifications/list.mdx @@ -1,6 +1,6 @@ --- -title: "list" -description: "Generated reference for the query endpoint notifications/list." +title: "Notifications API: List" +description: "Reference for the list query in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/mark_all_as_read.mdx b/src/content/docs/help/api/notifications/mark_all_as_read.mdx index caf195b..8bf2193 100644 --- a/src/content/docs/help/api/notifications/mark_all_as_read.mdx +++ b/src/content/docs/help/api/notifications/mark_all_as_read.mdx @@ -1,6 +1,6 @@ --- -title: "mark_all_as_read" -description: "Generated reference for the mutation endpoint notifications/mark_all_as_read." +title: "Notifications API: Mark all as read" +description: "Reference for the mark all as read mutation in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/mark_as_read.mdx b/src/content/docs/help/api/notifications/mark_as_read.mdx index b0ddba1..424afdf 100644 --- a/src/content/docs/help/api/notifications/mark_as_read.mdx +++ b/src/content/docs/help/api/notifications/mark_as_read.mdx @@ -1,6 +1,6 @@ --- -title: "mark_as_read" -description: "Generated reference for the mutation endpoint notifications/mark_as_read." +title: "Notifications API: Mark as read" +description: "Reference for the mark as read mutation in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/mark_many_as_read.mdx b/src/content/docs/help/api/notifications/mark_many_as_read.mdx index 9cc7195..ac80ee3 100644 --- a/src/content/docs/help/api/notifications/mark_many_as_read.mdx +++ b/src/content/docs/help/api/notifications/mark_many_as_read.mdx @@ -1,6 +1,6 @@ --- -title: "mark_many_as_read" -description: "Generated reference for the mutation endpoint notifications/mark_many_as_read." +title: "Notifications API: Mark many as read" +description: "Reference for the mark many as read mutation in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/subscribe.mdx b/src/content/docs/help/api/notifications/subscribe.mdx index 864b13c..ce161e6 100644 --- a/src/content/docs/help/api/notifications/subscribe.mdx +++ b/src/content/docs/help/api/notifications/subscribe.mdx @@ -1,6 +1,6 @@ --- -title: "subscribe" -description: "Generated reference for the mutation endpoint notifications/subscribe." +title: "Notifications API: Subscribe" +description: "Reference for the subscribe mutation in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/unsubscribe.mdx b/src/content/docs/help/api/notifications/unsubscribe.mdx index b49ec9a..090c806 100644 --- a/src/content/docs/help/api/notifications/unsubscribe.mdx +++ b/src/content/docs/help/api/notifications/unsubscribe.mdx @@ -1,6 +1,6 @@ --- -title: "unsubscribe" -description: "Generated reference for the mutation endpoint notifications/unsubscribe." +title: "Notifications API: Unsubscribe" +description: "Reference for the unsubscribe mutation in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/notifications/update_subscriptions_list.mdx b/src/content/docs/help/api/notifications/update_subscriptions_list.mdx index 5676ba3..a3c4283 100644 --- a/src/content/docs/help/api/notifications/update_subscriptions_list.mdx +++ b/src/content/docs/help/api/notifications/update_subscriptions_list.mdx @@ -1,6 +1,6 @@ --- -title: "update_subscriptions_list" -description: "Generated reference for the mutation endpoint notifications/update_subscriptions_list." +title: "Notifications API: Update subscriptions list" +description: "Reference for the update subscriptions list mutation in the Notifications API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/get.mdx b/src/content/docs/help/api/people/get.mdx index f96e15a..6b93ca3 100644 --- a/src/content/docs/help/api/people/get.mdx +++ b/src/content/docs/help/api/people/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint people/get." +title: "People API: Get" +description: "Reference for the get query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/get_account.mdx b/src/content/docs/help/api/people/get_account.mdx index 3cf60b3..423cf65 100644 --- a/src/content/docs/help/api/people/get_account.mdx +++ b/src/content/docs/help/api/people/get_account.mdx @@ -1,6 +1,6 @@ --- -title: "get_account" -description: "Generated reference for the query endpoint people/get_account." +title: "People API: Get account" +description: "Reference for the get account query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/get_assignments_count.mdx b/src/content/docs/help/api/people/get_assignments_count.mdx index a38211a..03c046c 100644 --- a/src/content/docs/help/api/people/get_assignments_count.mdx +++ b/src/content/docs/help/api/people/get_assignments_count.mdx @@ -1,6 +1,6 @@ --- -title: "get_assignments_count" -description: "Generated reference for the query endpoint people/get_assignments_count." +title: "People API: Get assignments count" +description: "Reference for the get assignments count query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/get_binded.mdx b/src/content/docs/help/api/people/get_binded.mdx index 91fc329..3a50d64 100644 --- a/src/content/docs/help/api/people/get_binded.mdx +++ b/src/content/docs/help/api/people/get_binded.mdx @@ -1,6 +1,6 @@ --- -title: "get_binded" -description: "Generated reference for the query endpoint people/get_binded." +title: "People API: Get binded" +description: "Reference for the get binded query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/get_me.mdx b/src/content/docs/help/api/people/get_me.mdx index 04f661a..57d97d6 100644 --- a/src/content/docs/help/api/people/get_me.mdx +++ b/src/content/docs/help/api/people/get_me.mdx @@ -1,6 +1,6 @@ --- -title: "get_me" -description: "Generated reference for the query endpoint people/get_me." +title: "People API: Get me" +description: "Reference for the get me query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/index.mdx b/src/content/docs/help/api/people/index.mdx index 0afe6fd..b13e2fb 100644 --- a/src/content/docs/help/api/people/index.mdx +++ b/src/content/docs/help/api/people/index.mdx @@ -1,6 +1,6 @@ --- -title: API People -description: Generated endpoint reference for the People namespace. +title: "People API" +description: "Endpoint reference for people in the Operately API." --- Get, list, update and manage user profiles and account settings @@ -18,84 +18,84 @@ Get, list, update and manage user profiles and account settings - get + Get GET query /api/external/v1/people/get - get_account + Get account GET query /api/external/v1/people/get_account - get_assignments_count + Get assignments count GET query /api/external/v1/people/get_assignments_count - get_binded + Get binded GET query /api/external/v1/people/get_binded - get_me + Get me GET query /api/external/v1/people/get_me - list + List GET query /api/external/v1/people/list - list_assignments + List assignments GET query /api/external/v1/people/list_assignments - list_possible_managers + List possible managers GET query /api/external/v1/people/list_possible_managers - search + Search GET query /api/external/v1/people/search - update + Update POST mutation /api/external/v1/people/update - update_picture + Update picture POST mutation /api/external/v1/people/update_picture - update_theme + Update theme POST mutation /api/external/v1/people/update_theme diff --git a/src/content/docs/help/api/people/list.mdx b/src/content/docs/help/api/people/list.mdx index 14b2234..aec0ac7 100644 --- a/src/content/docs/help/api/people/list.mdx +++ b/src/content/docs/help/api/people/list.mdx @@ -1,6 +1,6 @@ --- -title: "list" -description: "Generated reference for the query endpoint people/list." +title: "People API: List" +description: "Reference for the list query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/list_assignments.mdx b/src/content/docs/help/api/people/list_assignments.mdx index 1216211..3b49105 100644 --- a/src/content/docs/help/api/people/list_assignments.mdx +++ b/src/content/docs/help/api/people/list_assignments.mdx @@ -1,6 +1,6 @@ --- -title: "list_assignments" -description: "Generated reference for the query endpoint people/list_assignments." +title: "People API: List assignments" +description: "Reference for the list assignments query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/list_possible_managers.mdx b/src/content/docs/help/api/people/list_possible_managers.mdx index a5b56b7..c748e08 100644 --- a/src/content/docs/help/api/people/list_possible_managers.mdx +++ b/src/content/docs/help/api/people/list_possible_managers.mdx @@ -1,6 +1,6 @@ --- -title: "list_possible_managers" -description: "Generated reference for the query endpoint people/list_possible_managers." +title: "People API: List possible managers" +description: "Reference for the list possible managers query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/search.mdx b/src/content/docs/help/api/people/search.mdx index d4e580e..05bb510 100644 --- a/src/content/docs/help/api/people/search.mdx +++ b/src/content/docs/help/api/people/search.mdx @@ -1,6 +1,6 @@ --- -title: "search" -description: "Generated reference for the query endpoint people/search." +title: "People API: Search" +description: "Reference for the search query in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/update.mdx b/src/content/docs/help/api/people/update.mdx index f83785b..fc5a7c5 100644 --- a/src/content/docs/help/api/people/update.mdx +++ b/src/content/docs/help/api/people/update.mdx @@ -1,6 +1,6 @@ --- -title: "update" -description: "Generated reference for the mutation endpoint people/update." +title: "People API: Update" +description: "Reference for the update mutation in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/update_picture.mdx b/src/content/docs/help/api/people/update_picture.mdx index e0ac8e6..9df9c2f 100644 --- a/src/content/docs/help/api/people/update_picture.mdx +++ b/src/content/docs/help/api/people/update_picture.mdx @@ -1,6 +1,6 @@ --- -title: "update_picture" -description: "Generated reference for the mutation endpoint people/update_picture." +title: "People API: Update picture" +description: "Reference for the update picture mutation in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/people/update_theme.mdx b/src/content/docs/help/api/people/update_theme.mdx index a4378d8..82b1bb7 100644 --- a/src/content/docs/help/api/people/update_theme.mdx +++ b/src/content/docs/help/api/people/update_theme.mdx @@ -1,6 +1,6 @@ --- -title: "update_theme" -description: "Generated reference for the mutation endpoint people/update_theme." +title: "People API: Update theme" +description: "Reference for the update theme mutation in the People API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/acknowledge_check_in.mdx b/src/content/docs/help/api/projects/acknowledge_check_in.mdx index cf95770..32e63eb 100644 --- a/src/content/docs/help/api/projects/acknowledge_check_in.mdx +++ b/src/content/docs/help/api/projects/acknowledge_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "acknowledge_check_in" -description: "Generated reference for the mutation endpoint projects/acknowledge_check_in." +title: "Projects API: Acknowledge check-in" +description: "Reference for the acknowledge check-in mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/close.mdx b/src/content/docs/help/api/projects/close.mdx index 9e06b20..9ae6179 100644 --- a/src/content/docs/help/api/projects/close.mdx +++ b/src/content/docs/help/api/projects/close.mdx @@ -1,6 +1,6 @@ --- -title: "close" -description: "Generated reference for the mutation endpoint projects/close." +title: "Projects API: Close" +description: "Reference for the close mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/count_children.mdx b/src/content/docs/help/api/projects/count_children.mdx index e008805..453a122 100644 --- a/src/content/docs/help/api/projects/count_children.mdx +++ b/src/content/docs/help/api/projects/count_children.mdx @@ -1,6 +1,6 @@ --- -title: "count_children" -description: "Generated reference for the query endpoint projects/count_children." +title: "Projects API: Count children" +description: "Reference for the count children query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create.mdx b/src/content/docs/help/api/projects/create.mdx index 5ee68f2..3a5bdcd 100644 --- a/src/content/docs/help/api/projects/create.mdx +++ b/src/content/docs/help/api/projects/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint projects/create." +title: "Projects API: Create" +description: "Reference for the create mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_check_in.mdx b/src/content/docs/help/api/projects/create_check_in.mdx index 0ea88cb..14f60b0 100644 --- a/src/content/docs/help/api/projects/create_check_in.mdx +++ b/src/content/docs/help/api/projects/create_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "create_check_in" -description: "Generated reference for the mutation endpoint projects/create_check_in." +title: "Projects API: Create check-in" +description: "Reference for the create check-in mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_contributor.mdx b/src/content/docs/help/api/projects/create_contributor.mdx index f28a6cd..e26c369 100644 --- a/src/content/docs/help/api/projects/create_contributor.mdx +++ b/src/content/docs/help/api/projects/create_contributor.mdx @@ -1,6 +1,6 @@ --- -title: "create_contributor" -description: "Generated reference for the mutation endpoint projects/create_contributor." +title: "Projects API: Create contributor" +description: "Reference for the create contributor mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_contributors.mdx b/src/content/docs/help/api/projects/create_contributors.mdx index 3e38790..268bacb 100644 --- a/src/content/docs/help/api/projects/create_contributors.mdx +++ b/src/content/docs/help/api/projects/create_contributors.mdx @@ -1,6 +1,6 @@ --- -title: "create_contributors" -description: "Generated reference for the mutation endpoint projects/create_contributors." +title: "Projects API: Create contributors" +description: "Reference for the create contributors mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_discussion.mdx b/src/content/docs/help/api/projects/create_discussion.mdx index ef03fe9..7470fab 100644 --- a/src/content/docs/help/api/projects/create_discussion.mdx +++ b/src/content/docs/help/api/projects/create_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "create_discussion" -description: "Generated reference for the mutation endpoint projects/create_discussion." +title: "Projects API: Create discussion" +description: "Reference for the create discussion mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_key_resource.mdx b/src/content/docs/help/api/projects/create_key_resource.mdx index b95bd95..1ca53b2 100644 --- a/src/content/docs/help/api/projects/create_key_resource.mdx +++ b/src/content/docs/help/api/projects/create_key_resource.mdx @@ -1,6 +1,6 @@ --- -title: "create_key_resource" -description: "Generated reference for the mutation endpoint projects/create_key_resource." +title: "Projects API: Create key resource" +description: "Reference for the create key resource mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_milestone.mdx b/src/content/docs/help/api/projects/create_milestone.mdx index 014d0e0..cf43079 100644 --- a/src/content/docs/help/api/projects/create_milestone.mdx +++ b/src/content/docs/help/api/projects/create_milestone.mdx @@ -1,6 +1,6 @@ --- -title: "create_milestone" -description: "Generated reference for the mutation endpoint projects/create_milestone." +title: "Projects API: Create milestone" +description: "Reference for the create milestone mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/create_milestone_comment.mdx b/src/content/docs/help/api/projects/create_milestone_comment.mdx index 60bab37..8f43910 100644 --- a/src/content/docs/help/api/projects/create_milestone_comment.mdx +++ b/src/content/docs/help/api/projects/create_milestone_comment.mdx @@ -1,6 +1,6 @@ --- -title: "create_milestone_comment" -description: "Generated reference for the mutation endpoint projects/create_milestone_comment." +title: "Projects API: Create milestone comment" +description: "Reference for the create milestone comment mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/delete.mdx b/src/content/docs/help/api/projects/delete.mdx index 1589f8f..82e841a 100644 --- a/src/content/docs/help/api/projects/delete.mdx +++ b/src/content/docs/help/api/projects/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint projects/delete." +title: "Projects API: Delete" +description: "Reference for the delete mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/delete_contributor.mdx b/src/content/docs/help/api/projects/delete_contributor.mdx index 5f1adc3..0cdd86b 100644 --- a/src/content/docs/help/api/projects/delete_contributor.mdx +++ b/src/content/docs/help/api/projects/delete_contributor.mdx @@ -1,6 +1,6 @@ --- -title: "delete_contributor" -description: "Generated reference for the mutation endpoint projects/delete_contributor." +title: "Projects API: Delete contributor" +description: "Reference for the delete contributor mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/delete_key_resource.mdx b/src/content/docs/help/api/projects/delete_key_resource.mdx index 3ada2ee..08913a4 100644 --- a/src/content/docs/help/api/projects/delete_key_resource.mdx +++ b/src/content/docs/help/api/projects/delete_key_resource.mdx @@ -1,6 +1,6 @@ --- -title: "delete_key_resource" -description: "Generated reference for the mutation endpoint projects/delete_key_resource." +title: "Projects API: Delete key resource" +description: "Reference for the delete key resource mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/delete_milestone.mdx b/src/content/docs/help/api/projects/delete_milestone.mdx index 8eb949e..2704acd 100644 --- a/src/content/docs/help/api/projects/delete_milestone.mdx +++ b/src/content/docs/help/api/projects/delete_milestone.mdx @@ -1,6 +1,6 @@ --- -title: "delete_milestone" -description: "Generated reference for the mutation endpoint projects/delete_milestone." +title: "Projects API: Delete milestone" +description: "Reference for the delete milestone mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get.mdx b/src/content/docs/help/api/projects/get.mdx index 98d2df8..af6c0ef 100644 --- a/src/content/docs/help/api/projects/get.mdx +++ b/src/content/docs/help/api/projects/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint projects/get." +title: "Projects API: Get" +description: "Reference for the get query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get_check_in.mdx b/src/content/docs/help/api/projects/get_check_in.mdx index 2431d01..8433cff 100644 --- a/src/content/docs/help/api/projects/get_check_in.mdx +++ b/src/content/docs/help/api/projects/get_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "get_check_in" -description: "Generated reference for the query endpoint projects/get_check_in." +title: "Projects API: Get check-in" +description: "Reference for the get check-in query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get_contributor.mdx b/src/content/docs/help/api/projects/get_contributor.mdx index 593d436..b5bdfa0 100644 --- a/src/content/docs/help/api/projects/get_contributor.mdx +++ b/src/content/docs/help/api/projects/get_contributor.mdx @@ -1,6 +1,6 @@ --- -title: "get_contributor" -description: "Generated reference for the query endpoint projects/get_contributor." +title: "Projects API: Get contributor" +description: "Reference for the get contributor query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get_discussion.mdx b/src/content/docs/help/api/projects/get_discussion.mdx index 48785a5..2c2f7ad 100644 --- a/src/content/docs/help/api/projects/get_discussion.mdx +++ b/src/content/docs/help/api/projects/get_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "get_discussion" -description: "Generated reference for the query endpoint projects/get_discussion." +title: "Projects API: Get discussion" +description: "Reference for the get discussion query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get_key_resource.mdx b/src/content/docs/help/api/projects/get_key_resource.mdx index c3051df..73396e8 100644 --- a/src/content/docs/help/api/projects/get_key_resource.mdx +++ b/src/content/docs/help/api/projects/get_key_resource.mdx @@ -1,6 +1,6 @@ --- -title: "get_key_resource" -description: "Generated reference for the query endpoint projects/get_key_resource." +title: "Projects API: Get key resource" +description: "Reference for the get key resource query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get_milestone.mdx b/src/content/docs/help/api/projects/get_milestone.mdx index a1d98d9..96028cb 100644 --- a/src/content/docs/help/api/projects/get_milestone.mdx +++ b/src/content/docs/help/api/projects/get_milestone.mdx @@ -1,6 +1,6 @@ --- -title: "get_milestone" -description: "Generated reference for the query endpoint projects/get_milestone." +title: "Projects API: Get milestone" +description: "Reference for the get milestone query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/get_retrospective.mdx b/src/content/docs/help/api/projects/get_retrospective.mdx index dd47d8b..eca0daa 100644 --- a/src/content/docs/help/api/projects/get_retrospective.mdx +++ b/src/content/docs/help/api/projects/get_retrospective.mdx @@ -1,6 +1,6 @@ --- -title: "get_retrospective" -description: "Generated reference for the query endpoint projects/get_retrospective." +title: "Projects API: Get retrospective" +description: "Reference for the get retrospective query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/index.mdx b/src/content/docs/help/api/projects/index.mdx index a01dc0e..6b91ba6 100644 --- a/src/content/docs/help/api/projects/index.mdx +++ b/src/content/docs/help/api/projects/index.mdx @@ -1,6 +1,6 @@ --- -title: API Projects -description: Generated endpoint reference for the Projects namespace. +title: "Projects API" +description: "Endpoint reference for projects in the Operately API." --- Get, list, create and manage projects @@ -18,378 +18,378 @@ Get, list, create and manage projects - acknowledge_check_in + Acknowledge check-in POST mutation /api/external/v1/projects/acknowledge_check_in - close + Close POST mutation /api/external/v1/projects/close - count_children + Count children GET query /api/external/v1/projects/count_children - create + Create POST mutation /api/external/v1/projects/create - create_check_in + Create check-in POST mutation /api/external/v1/projects/create_check_in - create_contributor + Create contributor POST mutation /api/external/v1/projects/create_contributor - create_contributors + Create contributors POST mutation /api/external/v1/projects/create_contributors - create_discussion + Create discussion POST mutation /api/external/v1/projects/create_discussion - create_key_resource + Create key resource POST mutation /api/external/v1/projects/create_key_resource - create_milestone + Create milestone POST mutation /api/external/v1/projects/create_milestone - create_milestone_comment + Create milestone comment POST mutation /api/external/v1/projects/create_milestone_comment - delete + Delete POST mutation /api/external/v1/projects/delete - delete_contributor + Delete contributor POST mutation /api/external/v1/projects/delete_contributor - delete_key_resource + Delete key resource POST mutation /api/external/v1/projects/delete_key_resource - delete_milestone + Delete milestone POST mutation /api/external/v1/projects/delete_milestone - get + Get GET query /api/external/v1/projects/get - get_check_in + Get check-in GET query /api/external/v1/projects/get_check_in - get_contributor + Get contributor GET query /api/external/v1/projects/get_contributor - get_discussion + Get discussion GET query /api/external/v1/projects/get_discussion - get_key_resource + Get key resource GET query /api/external/v1/projects/get_key_resource - get_milestone + Get milestone GET query /api/external/v1/projects/get_milestone - get_retrospective + Get retrospective GET query /api/external/v1/projects/get_retrospective - list + List GET query /api/external/v1/projects/list - list_check_ins + List check-ins GET query /api/external/v1/projects/list_check_ins - list_contributors + List contributors GET query /api/external/v1/projects/list_contributors - list_discussions + List discussions GET query /api/external/v1/projects/list_discussions - list_milestone_tasks + List milestone tasks GET query /api/external/v1/projects/list_milestone_tasks - list_milestones + List milestones GET query /api/external/v1/projects/list_milestones - move_to_space + Move to space POST mutation /api/external/v1/projects/move_to_space - pause + Pause POST mutation /api/external/v1/projects/pause - resume + Resume POST mutation /api/external/v1/projects/resume - search + Search GET query /api/external/v1/projects/search - search_parent_goal + Search parent goal GET query /api/external/v1/projects/search_parent_goal - search_potential_contributors + Search potential contributors GET query /api/external/v1/projects/search_potential_contributors - update_champion + Update champion POST mutation /api/external/v1/projects/update_champion - update_check_in + Update check-in POST mutation /api/external/v1/projects/update_check_in - update_contributor + Update contributor POST mutation /api/external/v1/projects/update_contributor - update_description + Update description POST mutation /api/external/v1/projects/update_description - update_discussion + Update discussion POST mutation /api/external/v1/projects/update_discussion - update_due_date + Update due date POST mutation /api/external/v1/projects/update_due_date - update_key_resource + Update key resource POST mutation /api/external/v1/projects/update_key_resource - update_milestone + Update milestone POST mutation /api/external/v1/projects/update_milestone - update_milestone_description + Update milestone description POST mutation /api/external/v1/projects/update_milestone_description - update_milestone_due_date + Update milestone due date POST mutation /api/external/v1/projects/update_milestone_due_date - update_milestone_kanban + Update milestone kanban POST mutation /api/external/v1/projects/update_milestone_kanban - update_milestone_ordering + Update milestone ordering POST mutation /api/external/v1/projects/update_milestone_ordering - update_milestone_title + Update milestone title POST mutation /api/external/v1/projects/update_milestone_title - update_name + Update name POST mutation /api/external/v1/projects/update_name - update_parent_goal + Update parent goal POST mutation /api/external/v1/projects/update_parent_goal - update_permissions + Update permissions POST mutation /api/external/v1/projects/update_permissions - update_retrospective + Update retrospective POST mutation /api/external/v1/projects/update_retrospective - update_reviewer + Update reviewer POST mutation /api/external/v1/projects/update_reviewer - update_start_date + Update start date POST mutation /api/external/v1/projects/update_start_date - update_task_statuses + Update task statuses POST mutation /api/external/v1/projects/update_task_statuses diff --git a/src/content/docs/help/api/projects/list.mdx b/src/content/docs/help/api/projects/list.mdx index a41ccd5..f8c6287 100644 --- a/src/content/docs/help/api/projects/list.mdx +++ b/src/content/docs/help/api/projects/list.mdx @@ -1,6 +1,6 @@ --- -title: "list" -description: "Generated reference for the query endpoint projects/list." +title: "Projects API: List" +description: "Reference for the list query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/list_check_ins.mdx b/src/content/docs/help/api/projects/list_check_ins.mdx index 08598c4..588b296 100644 --- a/src/content/docs/help/api/projects/list_check_ins.mdx +++ b/src/content/docs/help/api/projects/list_check_ins.mdx @@ -1,6 +1,6 @@ --- -title: "list_check_ins" -description: "Generated reference for the query endpoint projects/list_check_ins." +title: "Projects API: List check-ins" +description: "Reference for the list check-ins query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/list_contributors.mdx b/src/content/docs/help/api/projects/list_contributors.mdx index 1294824..26fced2 100644 --- a/src/content/docs/help/api/projects/list_contributors.mdx +++ b/src/content/docs/help/api/projects/list_contributors.mdx @@ -1,6 +1,6 @@ --- -title: "list_contributors" -description: "Generated reference for the query endpoint projects/list_contributors." +title: "Projects API: List contributors" +description: "Reference for the list contributors query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/list_discussions.mdx b/src/content/docs/help/api/projects/list_discussions.mdx index 37142df..ab852e1 100644 --- a/src/content/docs/help/api/projects/list_discussions.mdx +++ b/src/content/docs/help/api/projects/list_discussions.mdx @@ -1,6 +1,6 @@ --- -title: "list_discussions" -description: "Generated reference for the query endpoint projects/list_discussions." +title: "Projects API: List discussions" +description: "Reference for the list discussions query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/list_milestone_tasks.mdx b/src/content/docs/help/api/projects/list_milestone_tasks.mdx index 0ca3a88..a607904 100644 --- a/src/content/docs/help/api/projects/list_milestone_tasks.mdx +++ b/src/content/docs/help/api/projects/list_milestone_tasks.mdx @@ -1,6 +1,6 @@ --- -title: "list_milestone_tasks" -description: "Generated reference for the query endpoint projects/list_milestone_tasks." +title: "Projects API: List milestone tasks" +description: "Reference for the list milestone tasks query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/list_milestones.mdx b/src/content/docs/help/api/projects/list_milestones.mdx index 2ce1e4d..fae1fd2 100644 --- a/src/content/docs/help/api/projects/list_milestones.mdx +++ b/src/content/docs/help/api/projects/list_milestones.mdx @@ -1,6 +1,6 @@ --- -title: "list_milestones" -description: "Generated reference for the query endpoint projects/list_milestones." +title: "Projects API: List milestones" +description: "Reference for the list milestones query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/move_to_space.mdx b/src/content/docs/help/api/projects/move_to_space.mdx index 1120604..9e4a490 100644 --- a/src/content/docs/help/api/projects/move_to_space.mdx +++ b/src/content/docs/help/api/projects/move_to_space.mdx @@ -1,6 +1,6 @@ --- -title: "move_to_space" -description: "Generated reference for the mutation endpoint projects/move_to_space." +title: "Projects API: Move to space" +description: "Reference for the move to space mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/pause.mdx b/src/content/docs/help/api/projects/pause.mdx index c11efe4..38171c9 100644 --- a/src/content/docs/help/api/projects/pause.mdx +++ b/src/content/docs/help/api/projects/pause.mdx @@ -1,6 +1,6 @@ --- -title: "pause" -description: "Generated reference for the mutation endpoint projects/pause." +title: "Projects API: Pause" +description: "Reference for the pause mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/resume.mdx b/src/content/docs/help/api/projects/resume.mdx index f44acb4..b3dbde6 100644 --- a/src/content/docs/help/api/projects/resume.mdx +++ b/src/content/docs/help/api/projects/resume.mdx @@ -1,6 +1,6 @@ --- -title: "resume" -description: "Generated reference for the mutation endpoint projects/resume." +title: "Projects API: Resume" +description: "Reference for the resume mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/search.mdx b/src/content/docs/help/api/projects/search.mdx index 00e7234..683cf26 100644 --- a/src/content/docs/help/api/projects/search.mdx +++ b/src/content/docs/help/api/projects/search.mdx @@ -1,6 +1,6 @@ --- -title: "search" -description: "Generated reference for the query endpoint projects/search." +title: "Projects API: Search" +description: "Reference for the search query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/search_parent_goal.mdx b/src/content/docs/help/api/projects/search_parent_goal.mdx index 5dcb80f..e72a701 100644 --- a/src/content/docs/help/api/projects/search_parent_goal.mdx +++ b/src/content/docs/help/api/projects/search_parent_goal.mdx @@ -1,6 +1,6 @@ --- -title: "search_parent_goal" -description: "Generated reference for the query endpoint projects/search_parent_goal." +title: "Projects API: Search parent goal" +description: "Reference for the search parent goal query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/search_potential_contributors.mdx b/src/content/docs/help/api/projects/search_potential_contributors.mdx index bea2eb8..556e29e 100644 --- a/src/content/docs/help/api/projects/search_potential_contributors.mdx +++ b/src/content/docs/help/api/projects/search_potential_contributors.mdx @@ -1,6 +1,6 @@ --- -title: "search_potential_contributors" -description: "Generated reference for the query endpoint projects/search_potential_contributors." +title: "Projects API: Search potential contributors" +description: "Reference for the search potential contributors query in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_champion.mdx b/src/content/docs/help/api/projects/update_champion.mdx index c461ddc..b6c3523 100644 --- a/src/content/docs/help/api/projects/update_champion.mdx +++ b/src/content/docs/help/api/projects/update_champion.mdx @@ -1,6 +1,6 @@ --- -title: "update_champion" -description: "Generated reference for the mutation endpoint projects/update_champion." +title: "Projects API: Update champion" +description: "Reference for the update champion mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_check_in.mdx b/src/content/docs/help/api/projects/update_check_in.mdx index 006cff5..0fdf43a 100644 --- a/src/content/docs/help/api/projects/update_check_in.mdx +++ b/src/content/docs/help/api/projects/update_check_in.mdx @@ -1,6 +1,6 @@ --- -title: "update_check_in" -description: "Generated reference for the mutation endpoint projects/update_check_in." +title: "Projects API: Update check-in" +description: "Reference for the update check-in mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_contributor.mdx b/src/content/docs/help/api/projects/update_contributor.mdx index 048d9fd..d1dcf26 100644 --- a/src/content/docs/help/api/projects/update_contributor.mdx +++ b/src/content/docs/help/api/projects/update_contributor.mdx @@ -1,6 +1,6 @@ --- -title: "update_contributor" -description: "Generated reference for the mutation endpoint projects/update_contributor." +title: "Projects API: Update contributor" +description: "Reference for the update contributor mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_description.mdx b/src/content/docs/help/api/projects/update_description.mdx index 7de1a1b..50222d1 100644 --- a/src/content/docs/help/api/projects/update_description.mdx +++ b/src/content/docs/help/api/projects/update_description.mdx @@ -1,6 +1,6 @@ --- -title: "update_description" -description: "Generated reference for the mutation endpoint projects/update_description." +title: "Projects API: Update description" +description: "Reference for the update description mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_discussion.mdx b/src/content/docs/help/api/projects/update_discussion.mdx index a9d06da..ec86b87 100644 --- a/src/content/docs/help/api/projects/update_discussion.mdx +++ b/src/content/docs/help/api/projects/update_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "update_discussion" -description: "Generated reference for the mutation endpoint projects/update_discussion." +title: "Projects API: Update discussion" +description: "Reference for the update discussion mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_due_date.mdx b/src/content/docs/help/api/projects/update_due_date.mdx index 34a3b7d..47fa466 100644 --- a/src/content/docs/help/api/projects/update_due_date.mdx +++ b/src/content/docs/help/api/projects/update_due_date.mdx @@ -1,6 +1,6 @@ --- -title: "update_due_date" -description: "Generated reference for the mutation endpoint projects/update_due_date." +title: "Projects API: Update due date" +description: "Reference for the update due date mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_key_resource.mdx b/src/content/docs/help/api/projects/update_key_resource.mdx index c849e81..52e12de 100644 --- a/src/content/docs/help/api/projects/update_key_resource.mdx +++ b/src/content/docs/help/api/projects/update_key_resource.mdx @@ -1,6 +1,6 @@ --- -title: "update_key_resource" -description: "Generated reference for the mutation endpoint projects/update_key_resource." +title: "Projects API: Update key resource" +description: "Reference for the update key resource mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_milestone.mdx b/src/content/docs/help/api/projects/update_milestone.mdx index f693605..52b1c3c 100644 --- a/src/content/docs/help/api/projects/update_milestone.mdx +++ b/src/content/docs/help/api/projects/update_milestone.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone" -description: "Generated reference for the mutation endpoint projects/update_milestone." +title: "Projects API: Update milestone" +description: "Reference for the update milestone mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_milestone_description.mdx b/src/content/docs/help/api/projects/update_milestone_description.mdx index d1a3290..c79ccfb 100644 --- a/src/content/docs/help/api/projects/update_milestone_description.mdx +++ b/src/content/docs/help/api/projects/update_milestone_description.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone_description" -description: "Generated reference for the mutation endpoint projects/update_milestone_description." +title: "Projects API: Update milestone description" +description: "Reference for the update milestone description mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_milestone_due_date.mdx b/src/content/docs/help/api/projects/update_milestone_due_date.mdx index e69d837..12a79d4 100644 --- a/src/content/docs/help/api/projects/update_milestone_due_date.mdx +++ b/src/content/docs/help/api/projects/update_milestone_due_date.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone_due_date" -description: "Generated reference for the mutation endpoint projects/update_milestone_due_date." +title: "Projects API: Update milestone due date" +description: "Reference for the update milestone due date mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_milestone_kanban.mdx b/src/content/docs/help/api/projects/update_milestone_kanban.mdx index ddb4e84..c17609e 100644 --- a/src/content/docs/help/api/projects/update_milestone_kanban.mdx +++ b/src/content/docs/help/api/projects/update_milestone_kanban.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone_kanban" -description: "Generated reference for the mutation endpoint projects/update_milestone_kanban." +title: "Projects API: Update milestone kanban" +description: "Reference for the update milestone kanban mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_milestone_ordering.mdx b/src/content/docs/help/api/projects/update_milestone_ordering.mdx index 5453158..051b7b2 100644 --- a/src/content/docs/help/api/projects/update_milestone_ordering.mdx +++ b/src/content/docs/help/api/projects/update_milestone_ordering.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone_ordering" -description: "Generated reference for the mutation endpoint projects/update_milestone_ordering." +title: "Projects API: Update milestone ordering" +description: "Reference for the update milestone ordering mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_milestone_title.mdx b/src/content/docs/help/api/projects/update_milestone_title.mdx index 2ff94c5..4f26b6a 100644 --- a/src/content/docs/help/api/projects/update_milestone_title.mdx +++ b/src/content/docs/help/api/projects/update_milestone_title.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone_title" -description: "Generated reference for the mutation endpoint projects/update_milestone_title." +title: "Projects API: Update milestone title" +description: "Reference for the update milestone title mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_name.mdx b/src/content/docs/help/api/projects/update_name.mdx index 13eabe0..e3f7d18 100644 --- a/src/content/docs/help/api/projects/update_name.mdx +++ b/src/content/docs/help/api/projects/update_name.mdx @@ -1,6 +1,6 @@ --- -title: "update_name" -description: "Generated reference for the mutation endpoint projects/update_name." +title: "Projects API: Update name" +description: "Reference for the update name mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_parent_goal.mdx b/src/content/docs/help/api/projects/update_parent_goal.mdx index f98188c..9c6109c 100644 --- a/src/content/docs/help/api/projects/update_parent_goal.mdx +++ b/src/content/docs/help/api/projects/update_parent_goal.mdx @@ -1,6 +1,6 @@ --- -title: "update_parent_goal" -description: "Generated reference for the mutation endpoint projects/update_parent_goal." +title: "Projects API: Update parent goal" +description: "Reference for the update parent goal mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_permissions.mdx b/src/content/docs/help/api/projects/update_permissions.mdx index 663dce4..717e263 100644 --- a/src/content/docs/help/api/projects/update_permissions.mdx +++ b/src/content/docs/help/api/projects/update_permissions.mdx @@ -1,6 +1,6 @@ --- -title: "update_permissions" -description: "Generated reference for the mutation endpoint projects/update_permissions." +title: "Projects API: Update permissions" +description: "Reference for the update permissions mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_retrospective.mdx b/src/content/docs/help/api/projects/update_retrospective.mdx index e8dcb88..b962c9f 100644 --- a/src/content/docs/help/api/projects/update_retrospective.mdx +++ b/src/content/docs/help/api/projects/update_retrospective.mdx @@ -1,6 +1,6 @@ --- -title: "update_retrospective" -description: "Generated reference for the mutation endpoint projects/update_retrospective." +title: "Projects API: Update retrospective" +description: "Reference for the update retrospective mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_reviewer.mdx b/src/content/docs/help/api/projects/update_reviewer.mdx index 974cd24..3031eae 100644 --- a/src/content/docs/help/api/projects/update_reviewer.mdx +++ b/src/content/docs/help/api/projects/update_reviewer.mdx @@ -1,6 +1,6 @@ --- -title: "update_reviewer" -description: "Generated reference for the mutation endpoint projects/update_reviewer." +title: "Projects API: Update reviewer" +description: "Reference for the update reviewer mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_start_date.mdx b/src/content/docs/help/api/projects/update_start_date.mdx index 22e96bb..c25668f 100644 --- a/src/content/docs/help/api/projects/update_start_date.mdx +++ b/src/content/docs/help/api/projects/update_start_date.mdx @@ -1,6 +1,6 @@ --- -title: "update_start_date" -description: "Generated reference for the mutation endpoint projects/update_start_date." +title: "Projects API: Update start date" +description: "Reference for the update start date mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/projects/update_task_statuses.mdx b/src/content/docs/help/api/projects/update_task_statuses.mdx index 0db0d17..4da6296 100644 --- a/src/content/docs/help/api/projects/update_task_statuses.mdx +++ b/src/content/docs/help/api/projects/update_task_statuses.mdx @@ -1,6 +1,6 @@ --- -title: "update_task_statuses" -description: "Generated reference for the mutation endpoint projects/update_task_statuses." +title: "Projects API: Update task statuses" +description: "Reference for the update task statuses mutation in the Projects API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/reactions/create.mdx b/src/content/docs/help/api/reactions/create.mdx index 17709ce..139c60a 100644 --- a/src/content/docs/help/api/reactions/create.mdx +++ b/src/content/docs/help/api/reactions/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint reactions/create." +title: "Reactions API: Create" +description: "Reference for the create mutation in the Reactions API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/reactions/delete.mdx b/src/content/docs/help/api/reactions/delete.mdx index 0f9d2f2..7b27b30 100644 --- a/src/content/docs/help/api/reactions/delete.mdx +++ b/src/content/docs/help/api/reactions/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint reactions/delete." +title: "Reactions API: Delete" +description: "Reference for the delete mutation in the Reactions API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/reactions/index.mdx b/src/content/docs/help/api/reactions/index.mdx index d0edbf6..c58460f 100644 --- a/src/content/docs/help/api/reactions/index.mdx +++ b/src/content/docs/help/api/reactions/index.mdx @@ -1,6 +1,6 @@ --- -title: API Reactions -description: Generated endpoint reference for the Reactions namespace. +title: "Reactions API" +description: "Endpoint reference for reactions in the Operately API." --- Add or remove emoji reactions to content @@ -18,14 +18,14 @@ Add or remove emoji reactions to content - create + Create POST mutation /api/external/v1/reactions/create - delete + Delete POST mutation /api/external/v1/reactions/delete diff --git a/src/content/docs/help/api/resource_hubs/copy_folder.mdx b/src/content/docs/help/api/resource_hubs/copy_folder.mdx index 7503029..bcc3629 100644 --- a/src/content/docs/help/api/resource_hubs/copy_folder.mdx +++ b/src/content/docs/help/api/resource_hubs/copy_folder.mdx @@ -1,6 +1,6 @@ --- -title: "copy_folder" -description: "Generated reference for the mutation endpoint resource_hubs/copy_folder." +title: "Resource Hubs API: Copy folder" +description: "Reference for the copy folder mutation in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/create.mdx b/src/content/docs/help/api/resource_hubs/create.mdx index 0c56783..6888ca4 100644 --- a/src/content/docs/help/api/resource_hubs/create.mdx +++ b/src/content/docs/help/api/resource_hubs/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint resource_hubs/create." +title: "Resource Hubs API: Create" +description: "Reference for the create mutation in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/create_folder.mdx b/src/content/docs/help/api/resource_hubs/create_folder.mdx index cc2ee20..fc25332 100644 --- a/src/content/docs/help/api/resource_hubs/create_folder.mdx +++ b/src/content/docs/help/api/resource_hubs/create_folder.mdx @@ -1,6 +1,6 @@ --- -title: "create_folder" -description: "Generated reference for the mutation endpoint resource_hubs/create_folder." +title: "Resource Hubs API: Create folder" +description: "Reference for the create folder mutation in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/delete_folder.mdx b/src/content/docs/help/api/resource_hubs/delete_folder.mdx index 98f68e2..25d2632 100644 --- a/src/content/docs/help/api/resource_hubs/delete_folder.mdx +++ b/src/content/docs/help/api/resource_hubs/delete_folder.mdx @@ -1,6 +1,6 @@ --- -title: "delete_folder" -description: "Generated reference for the mutation endpoint resource_hubs/delete_folder." +title: "Resource Hubs API: Delete folder" +description: "Reference for the delete folder mutation in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/get.mdx b/src/content/docs/help/api/resource_hubs/get.mdx index d42b935..9d1b8c2 100644 --- a/src/content/docs/help/api/resource_hubs/get.mdx +++ b/src/content/docs/help/api/resource_hubs/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint resource_hubs/get." +title: "Resource Hubs API: Get" +description: "Reference for the get query in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/get_folder.mdx b/src/content/docs/help/api/resource_hubs/get_folder.mdx index 5add389..4ebe020 100644 --- a/src/content/docs/help/api/resource_hubs/get_folder.mdx +++ b/src/content/docs/help/api/resource_hubs/get_folder.mdx @@ -1,6 +1,6 @@ --- -title: "get_folder" -description: "Generated reference for the query endpoint resource_hubs/get_folder." +title: "Resource Hubs API: Get folder" +description: "Reference for the get folder query in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/index.mdx b/src/content/docs/help/api/resource_hubs/index.mdx index 0e87a71..9cc46f3 100644 --- a/src/content/docs/help/api/resource_hubs/index.mdx +++ b/src/content/docs/help/api/resource_hubs/index.mdx @@ -1,6 +1,6 @@ --- -title: API Resource hubs -description: Generated endpoint reference for the Resource hubs namespace. +title: "Resource Hubs API" +description: "Endpoint reference for resource hubs in the Operately API." --- Get and create resource hubs @@ -18,63 +18,63 @@ Get and create resource hubs - copy_folder + Copy folder POST mutation /api/external/v1/resource_hubs/copy_folder - create + Create POST mutation /api/external/v1/resource_hubs/create - create_folder + Create folder POST mutation /api/external/v1/resource_hubs/create_folder - delete_folder + Delete folder POST mutation /api/external/v1/resource_hubs/delete_folder - get + Get GET query /api/external/v1/resource_hubs/get - get_folder + Get folder GET query /api/external/v1/resource_hubs/get_folder - list_nodes + List nodes GET query /api/external/v1/resource_hubs/list_nodes - rename_folder + Rename folder POST mutation /api/external/v1/resource_hubs/rename_folder - update_parent_folder + Update parent folder POST mutation /api/external/v1/resource_hubs/update_parent_folder diff --git a/src/content/docs/help/api/resource_hubs/list_nodes.mdx b/src/content/docs/help/api/resource_hubs/list_nodes.mdx index dd72d94..864161d 100644 --- a/src/content/docs/help/api/resource_hubs/list_nodes.mdx +++ b/src/content/docs/help/api/resource_hubs/list_nodes.mdx @@ -1,6 +1,6 @@ --- -title: "list_nodes" -description: "Generated reference for the query endpoint resource_hubs/list_nodes." +title: "Resource Hubs API: List nodes" +description: "Reference for the list nodes query in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/rename_folder.mdx b/src/content/docs/help/api/resource_hubs/rename_folder.mdx index f9546a9..6687bbe 100644 --- a/src/content/docs/help/api/resource_hubs/rename_folder.mdx +++ b/src/content/docs/help/api/resource_hubs/rename_folder.mdx @@ -1,6 +1,6 @@ --- -title: "rename_folder" -description: "Generated reference for the mutation endpoint resource_hubs/rename_folder." +title: "Resource Hubs API: Rename folder" +description: "Reference for the rename folder mutation in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/resource_hubs/update_parent_folder.mdx b/src/content/docs/help/api/resource_hubs/update_parent_folder.mdx index 3a1ad0b..ec9f706 100644 --- a/src/content/docs/help/api/resource_hubs/update_parent_folder.mdx +++ b/src/content/docs/help/api/resource_hubs/update_parent_folder.mdx @@ -1,6 +1,6 @@ --- -title: "update_parent_folder" -description: "Generated reference for the mutation endpoint resource_hubs/update_parent_folder." +title: "Resource Hubs API: Update parent folder" +description: "Reference for the update parent folder mutation in the Resource Hubs API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/add_members.mdx b/src/content/docs/help/api/spaces/add_members.mdx index 7d41520..a2d2afd 100644 --- a/src/content/docs/help/api/spaces/add_members.mdx +++ b/src/content/docs/help/api/spaces/add_members.mdx @@ -1,6 +1,6 @@ --- -title: "add_members" -description: "Generated reference for the mutation endpoint spaces/add_members." +title: "Spaces API: Add members" +description: "Reference for the add members mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/archive_discussion.mdx b/src/content/docs/help/api/spaces/archive_discussion.mdx index bbe5777..8b0bce8 100644 --- a/src/content/docs/help/api/spaces/archive_discussion.mdx +++ b/src/content/docs/help/api/spaces/archive_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "archive_discussion" -description: "Generated reference for the mutation endpoint spaces/archive_discussion." +title: "Spaces API: Archive discussion" +description: "Reference for the archive discussion mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/count_by_access_level.mdx b/src/content/docs/help/api/spaces/count_by_access_level.mdx index df8579e..5b1f20f 100644 --- a/src/content/docs/help/api/spaces/count_by_access_level.mdx +++ b/src/content/docs/help/api/spaces/count_by_access_level.mdx @@ -1,6 +1,6 @@ --- -title: "count_by_access_level" -description: "Generated reference for the query endpoint spaces/count_by_access_level." +title: "Spaces API: Count by access level" +description: "Reference for the count by access level query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/create.mdx b/src/content/docs/help/api/spaces/create.mdx index e710e0a..2ef8f23 100644 --- a/src/content/docs/help/api/spaces/create.mdx +++ b/src/content/docs/help/api/spaces/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint spaces/create." +title: "Spaces API: Create" +description: "Reference for the create mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/create_discussion.mdx b/src/content/docs/help/api/spaces/create_discussion.mdx index dbf72b4..effa9af 100644 --- a/src/content/docs/help/api/spaces/create_discussion.mdx +++ b/src/content/docs/help/api/spaces/create_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "create_discussion" -description: "Generated reference for the mutation endpoint spaces/create_discussion." +title: "Spaces API: Create discussion" +description: "Reference for the create discussion mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/delete.mdx b/src/content/docs/help/api/spaces/delete.mdx index 3a48473..814a8ee 100644 --- a/src/content/docs/help/api/spaces/delete.mdx +++ b/src/content/docs/help/api/spaces/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint spaces/delete." +title: "Spaces API: Delete" +description: "Reference for the delete mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/delete_member.mdx b/src/content/docs/help/api/spaces/delete_member.mdx index 2017d01..0a9ed0d 100644 --- a/src/content/docs/help/api/spaces/delete_member.mdx +++ b/src/content/docs/help/api/spaces/delete_member.mdx @@ -1,6 +1,6 @@ --- -title: "delete_member" -description: "Generated reference for the mutation endpoint spaces/delete_member." +title: "Spaces API: Delete member" +description: "Reference for the delete member mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/get.mdx b/src/content/docs/help/api/spaces/get.mdx index 9f9474e..62b971c 100644 --- a/src/content/docs/help/api/spaces/get.mdx +++ b/src/content/docs/help/api/spaces/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint spaces/get." +title: "Spaces API: Get" +description: "Reference for the get query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/get_discussion.mdx b/src/content/docs/help/api/spaces/get_discussion.mdx index 477fc4d..c4d07b1 100644 --- a/src/content/docs/help/api/spaces/get_discussion.mdx +++ b/src/content/docs/help/api/spaces/get_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "get_discussion" -description: "Generated reference for the query endpoint spaces/get_discussion." +title: "Spaces API: Get discussion" +description: "Reference for the get discussion query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/index.mdx b/src/content/docs/help/api/spaces/index.mdx index 001b2ab..56907c8 100644 --- a/src/content/docs/help/api/spaces/index.mdx +++ b/src/content/docs/help/api/spaces/index.mdx @@ -1,6 +1,6 @@ --- -title: API Spaces -description: Generated endpoint reference for the Spaces namespace. +title: "Spaces API" +description: "Endpoint reference for spaces in the Operately API." --- Get, list, create and manage spaces @@ -18,168 +18,168 @@ Get, list, create and manage spaces - add_members + Add members POST mutation /api/external/v1/spaces/add_members - archive_discussion + Archive discussion POST mutation /api/external/v1/spaces/archive_discussion - count_by_access_level + Count by access level GET query /api/external/v1/spaces/count_by_access_level - create + Create POST mutation /api/external/v1/spaces/create - create_discussion + Create discussion POST mutation /api/external/v1/spaces/create_discussion - delete + Delete POST mutation /api/external/v1/spaces/delete - delete_member + Delete member POST mutation /api/external/v1/spaces/delete_member - get + Get GET query /api/external/v1/spaces/get - get_discussion + Get discussion GET query /api/external/v1/spaces/get_discussion - join + Join POST mutation /api/external/v1/spaces/join - list + List GET query /api/external/v1/spaces/list - list_discussions + List discussions GET query /api/external/v1/spaces/list_discussions - list_members + List members GET query /api/external/v1/spaces/list_members - list_tasks + List tasks GET query /api/external/v1/spaces/list_tasks - list_tools + List tools GET query /api/external/v1/spaces/list_tools - publish_discussion + Publish discussion POST mutation /api/external/v1/spaces/publish_discussion - search + Search GET query /api/external/v1/spaces/search - search_potential_members + Search potential members GET query /api/external/v1/spaces/search_potential_members - update + Update POST mutation /api/external/v1/spaces/update - update_discussion + Update discussion POST mutation /api/external/v1/spaces/update_discussion - update_members_permissions + Update members permissions POST mutation /api/external/v1/spaces/update_members_permissions - update_permissions + Update permissions POST mutation /api/external/v1/spaces/update_permissions - update_task_statuses + Update task statuses POST mutation /api/external/v1/spaces/update_task_statuses - update_tools + Update tools POST mutation /api/external/v1/spaces/update_tools diff --git a/src/content/docs/help/api/spaces/join.mdx b/src/content/docs/help/api/spaces/join.mdx index 4862b91..af66973 100644 --- a/src/content/docs/help/api/spaces/join.mdx +++ b/src/content/docs/help/api/spaces/join.mdx @@ -1,6 +1,6 @@ --- -title: "join" -description: "Generated reference for the mutation endpoint spaces/join." +title: "Spaces API: Join" +description: "Reference for the join mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/list.mdx b/src/content/docs/help/api/spaces/list.mdx index b8f292a..d1c2fc1 100644 --- a/src/content/docs/help/api/spaces/list.mdx +++ b/src/content/docs/help/api/spaces/list.mdx @@ -1,6 +1,6 @@ --- -title: "list" -description: "Generated reference for the query endpoint spaces/list." +title: "Spaces API: List" +description: "Reference for the list query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/list_discussions.mdx b/src/content/docs/help/api/spaces/list_discussions.mdx index e497fcb..9237879 100644 --- a/src/content/docs/help/api/spaces/list_discussions.mdx +++ b/src/content/docs/help/api/spaces/list_discussions.mdx @@ -1,6 +1,6 @@ --- -title: "list_discussions" -description: "Generated reference for the query endpoint spaces/list_discussions." +title: "Spaces API: List discussions" +description: "Reference for the list discussions query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/list_members.mdx b/src/content/docs/help/api/spaces/list_members.mdx index d76db16..91d5ae9 100644 --- a/src/content/docs/help/api/spaces/list_members.mdx +++ b/src/content/docs/help/api/spaces/list_members.mdx @@ -1,6 +1,6 @@ --- -title: "list_members" -description: "Generated reference for the query endpoint spaces/list_members." +title: "Spaces API: List members" +description: "Reference for the list members query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/list_tasks.mdx b/src/content/docs/help/api/spaces/list_tasks.mdx index c715037..db0e9f6 100644 --- a/src/content/docs/help/api/spaces/list_tasks.mdx +++ b/src/content/docs/help/api/spaces/list_tasks.mdx @@ -1,6 +1,6 @@ --- -title: "list_tasks" -description: "Generated reference for the query endpoint spaces/list_tasks." +title: "Spaces API: List tasks" +description: "Reference for the list tasks query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/list_tools.mdx b/src/content/docs/help/api/spaces/list_tools.mdx index 8a16aa0..f2356d9 100644 --- a/src/content/docs/help/api/spaces/list_tools.mdx +++ b/src/content/docs/help/api/spaces/list_tools.mdx @@ -1,6 +1,6 @@ --- -title: "list_tools" -description: "Generated reference for the query endpoint spaces/list_tools." +title: "Spaces API: List tools" +description: "Reference for the list tools query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/publish_discussion.mdx b/src/content/docs/help/api/spaces/publish_discussion.mdx index ecbecbd..9e26156 100644 --- a/src/content/docs/help/api/spaces/publish_discussion.mdx +++ b/src/content/docs/help/api/spaces/publish_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "publish_discussion" -description: "Generated reference for the mutation endpoint spaces/publish_discussion." +title: "Spaces API: Publish discussion" +description: "Reference for the publish discussion mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/search.mdx b/src/content/docs/help/api/spaces/search.mdx index 275ad9a..3d02761 100644 --- a/src/content/docs/help/api/spaces/search.mdx +++ b/src/content/docs/help/api/spaces/search.mdx @@ -1,6 +1,6 @@ --- -title: "search" -description: "Generated reference for the query endpoint spaces/search." +title: "Spaces API: Search" +description: "Reference for the search query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/search_potential_members.mdx b/src/content/docs/help/api/spaces/search_potential_members.mdx index cab2ad6..4e35e3e 100644 --- a/src/content/docs/help/api/spaces/search_potential_members.mdx +++ b/src/content/docs/help/api/spaces/search_potential_members.mdx @@ -1,6 +1,6 @@ --- -title: "search_potential_members" -description: "Generated reference for the query endpoint spaces/search_potential_members." +title: "Spaces API: Search potential members" +description: "Reference for the search potential members query in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/update.mdx b/src/content/docs/help/api/spaces/update.mdx index cacfcf4..852670d 100644 --- a/src/content/docs/help/api/spaces/update.mdx +++ b/src/content/docs/help/api/spaces/update.mdx @@ -1,6 +1,6 @@ --- -title: "update" -description: "Generated reference for the mutation endpoint spaces/update." +title: "Spaces API: Update" +description: "Reference for the update mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/update_discussion.mdx b/src/content/docs/help/api/spaces/update_discussion.mdx index c5779c2..dd8f87d 100644 --- a/src/content/docs/help/api/spaces/update_discussion.mdx +++ b/src/content/docs/help/api/spaces/update_discussion.mdx @@ -1,6 +1,6 @@ --- -title: "update_discussion" -description: "Generated reference for the mutation endpoint spaces/update_discussion." +title: "Spaces API: Update discussion" +description: "Reference for the update discussion mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/update_members_permissions.mdx b/src/content/docs/help/api/spaces/update_members_permissions.mdx index cf0075b..7a6e2cf 100644 --- a/src/content/docs/help/api/spaces/update_members_permissions.mdx +++ b/src/content/docs/help/api/spaces/update_members_permissions.mdx @@ -1,6 +1,6 @@ --- -title: "update_members_permissions" -description: "Generated reference for the mutation endpoint spaces/update_members_permissions." +title: "Spaces API: Update members permissions" +description: "Reference for the update members permissions mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/update_permissions.mdx b/src/content/docs/help/api/spaces/update_permissions.mdx index 6a4667d..f88ce3e 100644 --- a/src/content/docs/help/api/spaces/update_permissions.mdx +++ b/src/content/docs/help/api/spaces/update_permissions.mdx @@ -1,6 +1,6 @@ --- -title: "update_permissions" -description: "Generated reference for the mutation endpoint spaces/update_permissions." +title: "Spaces API: Update permissions" +description: "Reference for the update permissions mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/update_task_statuses.mdx b/src/content/docs/help/api/spaces/update_task_statuses.mdx index 5cf592d..cf33150 100644 --- a/src/content/docs/help/api/spaces/update_task_statuses.mdx +++ b/src/content/docs/help/api/spaces/update_task_statuses.mdx @@ -1,6 +1,6 @@ --- -title: "update_task_statuses" -description: "Generated reference for the mutation endpoint spaces/update_task_statuses." +title: "Spaces API: Update task statuses" +description: "Reference for the update task statuses mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/spaces/update_tools.mdx b/src/content/docs/help/api/spaces/update_tools.mdx index b29ede8..88e115f 100644 --- a/src/content/docs/help/api/spaces/update_tools.mdx +++ b/src/content/docs/help/api/spaces/update_tools.mdx @@ -1,6 +1,6 @@ --- -title: "update_tools" -description: "Generated reference for the mutation endpoint spaces/update_tools." +title: "Spaces API: Update tools" +description: "Reference for the update tools mutation in the Spaces API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/create.mdx b/src/content/docs/help/api/tasks/create.mdx index dfb34d1..5719642 100644 --- a/src/content/docs/help/api/tasks/create.mdx +++ b/src/content/docs/help/api/tasks/create.mdx @@ -1,6 +1,6 @@ --- -title: "create" -description: "Generated reference for the mutation endpoint tasks/create." +title: "Tasks API: Create" +description: "Reference for the create mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/delete.mdx b/src/content/docs/help/api/tasks/delete.mdx index 47a57c4..d0c2fcc 100644 --- a/src/content/docs/help/api/tasks/delete.mdx +++ b/src/content/docs/help/api/tasks/delete.mdx @@ -1,6 +1,6 @@ --- -title: "delete" -description: "Generated reference for the mutation endpoint tasks/delete." +title: "Tasks API: Delete" +description: "Reference for the delete mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/get.mdx b/src/content/docs/help/api/tasks/get.mdx index 33e55a9..f579951 100644 --- a/src/content/docs/help/api/tasks/get.mdx +++ b/src/content/docs/help/api/tasks/get.mdx @@ -1,6 +1,6 @@ --- -title: "get" -description: "Generated reference for the query endpoint tasks/get." +title: "Tasks API: Get" +description: "Reference for the get query in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/index.mdx b/src/content/docs/help/api/tasks/index.mdx index 5bed1d5..2ceeb75 100644 --- a/src/content/docs/help/api/tasks/index.mdx +++ b/src/content/docs/help/api/tasks/index.mdx @@ -1,6 +1,6 @@ --- -title: API Tasks -description: Generated endpoint reference for the Tasks namespace. +title: "Tasks API" +description: "Endpoint reference for tasks in the Operately API." --- Get, list, create and manage tasks across projects and spaces @@ -18,91 +18,91 @@ Get, list, create and manage tasks across projects and spaces - create + Create POST mutation /api/external/v1/tasks/create - delete + Delete POST mutation /api/external/v1/tasks/delete - get + Get GET query /api/external/v1/tasks/get - list + List GET query /api/external/v1/tasks/list - list_potential_assignees + List potential assignees GET query /api/external/v1/tasks/list_potential_assignees - move + Move POST mutation /api/external/v1/tasks/move - update_assignee + Update assignee POST mutation /api/external/v1/tasks/update_assignee - update_description + Update description POST mutation /api/external/v1/tasks/update_description - update_due_date + Update due date POST mutation /api/external/v1/tasks/update_due_date - update_milestone + Update milestone POST mutation /api/external/v1/tasks/update_milestone - update_milestone_and_ordering + Update milestone and ordering POST mutation /api/external/v1/tasks/update_milestone_and_ordering - update_name + Update name POST mutation /api/external/v1/tasks/update_name - update_status + Update status POST mutation /api/external/v1/tasks/update_status diff --git a/src/content/docs/help/api/tasks/list.mdx b/src/content/docs/help/api/tasks/list.mdx index 3da33bf..a8e35dc 100644 --- a/src/content/docs/help/api/tasks/list.mdx +++ b/src/content/docs/help/api/tasks/list.mdx @@ -1,6 +1,6 @@ --- -title: "list" -description: "Generated reference for the query endpoint tasks/list." +title: "Tasks API: List" +description: "Reference for the list query in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/list_potential_assignees.mdx b/src/content/docs/help/api/tasks/list_potential_assignees.mdx index 5775423..bde925c 100644 --- a/src/content/docs/help/api/tasks/list_potential_assignees.mdx +++ b/src/content/docs/help/api/tasks/list_potential_assignees.mdx @@ -1,6 +1,6 @@ --- -title: "list_potential_assignees" -description: "Generated reference for the query endpoint tasks/list_potential_assignees." +title: "Tasks API: List potential assignees" +description: "Reference for the list potential assignees query in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/move.mdx b/src/content/docs/help/api/tasks/move.mdx index c12c59f..20ab33f 100644 --- a/src/content/docs/help/api/tasks/move.mdx +++ b/src/content/docs/help/api/tasks/move.mdx @@ -1,6 +1,6 @@ --- -title: "move" -description: "Generated reference for the mutation endpoint tasks/move." +title: "Tasks API: Move" +description: "Reference for the move mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_assignee.mdx b/src/content/docs/help/api/tasks/update_assignee.mdx index 80a9b1c..1ff6c1e 100644 --- a/src/content/docs/help/api/tasks/update_assignee.mdx +++ b/src/content/docs/help/api/tasks/update_assignee.mdx @@ -1,6 +1,6 @@ --- -title: "update_assignee" -description: "Generated reference for the mutation endpoint tasks/update_assignee." +title: "Tasks API: Update assignee" +description: "Reference for the update assignee mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_description.mdx b/src/content/docs/help/api/tasks/update_description.mdx index 910ad7e..779c2d1 100644 --- a/src/content/docs/help/api/tasks/update_description.mdx +++ b/src/content/docs/help/api/tasks/update_description.mdx @@ -1,6 +1,6 @@ --- -title: "update_description" -description: "Generated reference for the mutation endpoint tasks/update_description." +title: "Tasks API: Update description" +description: "Reference for the update description mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_due_date.mdx b/src/content/docs/help/api/tasks/update_due_date.mdx index 2ecfcdf..0cbef42 100644 --- a/src/content/docs/help/api/tasks/update_due_date.mdx +++ b/src/content/docs/help/api/tasks/update_due_date.mdx @@ -1,6 +1,6 @@ --- -title: "update_due_date" -description: "Generated reference for the mutation endpoint tasks/update_due_date." +title: "Tasks API: Update due date" +description: "Reference for the update due date mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_milestone.mdx b/src/content/docs/help/api/tasks/update_milestone.mdx index 23d85d3..cc03371 100644 --- a/src/content/docs/help/api/tasks/update_milestone.mdx +++ b/src/content/docs/help/api/tasks/update_milestone.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone" -description: "Generated reference for the mutation endpoint tasks/update_milestone." +title: "Tasks API: Update milestone" +description: "Reference for the update milestone mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_milestone_and_ordering.mdx b/src/content/docs/help/api/tasks/update_milestone_and_ordering.mdx index 05ee406..f192508 100644 --- a/src/content/docs/help/api/tasks/update_milestone_and_ordering.mdx +++ b/src/content/docs/help/api/tasks/update_milestone_and_ordering.mdx @@ -1,6 +1,6 @@ --- -title: "update_milestone_and_ordering" -description: "Generated reference for the mutation endpoint tasks/update_milestone_and_ordering." +title: "Tasks API: Update milestone and ordering" +description: "Reference for the update milestone and ordering mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_name.mdx b/src/content/docs/help/api/tasks/update_name.mdx index 36d0f12..19d23aa 100644 --- a/src/content/docs/help/api/tasks/update_name.mdx +++ b/src/content/docs/help/api/tasks/update_name.mdx @@ -1,6 +1,6 @@ --- -title: "update_name" -description: "Generated reference for the mutation endpoint tasks/update_name." +title: "Tasks API: Update name" +description: "Reference for the update name mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/api/tasks/update_status.mdx b/src/content/docs/help/api/tasks/update_status.mdx index 14e2c40..f575b2c 100644 --- a/src/content/docs/help/api/tasks/update_status.mdx +++ b/src/content/docs/help/api/tasks/update_status.mdx @@ -1,6 +1,6 @@ --- -title: "update_status" -description: "Generated reference for the mutation endpoint tasks/update_status." +title: "Tasks API: Update status" +description: "Reference for the update status mutation in the Tasks API." --- import CurlExampleBlock from "@components/CurlExampleBlock.jsx" diff --git a/src/content/docs/help/cli-authentication.mdx b/src/content/docs/help/cli-authentication.mdx index eed1118..413099b 100644 --- a/src/content/docs/help/cli-authentication.mdx +++ b/src/content/docs/help/cli-authentication.mdx @@ -1,5 +1,5 @@ --- -title: Authentication +title: CLI authentication description: Learn how to authenticate the Operately CLI with API tokens, profiles, and environment variables. --- diff --git a/src/content/docs/help/cli-installation.mdx b/src/content/docs/help/cli-installation.mdx index 7ac301b..cce7ffe 100644 --- a/src/content/docs/help/cli-installation.mdx +++ b/src/content/docs/help/cli-installation.mdx @@ -1,5 +1,5 @@ --- -title: Install and update +title: CLI install and update description: Learn how to install, update, and verify the Operately CLI. --- diff --git a/src/content/docs/help/cli-skills.mdx b/src/content/docs/help/cli-skills.mdx index 75e7aed..33f0ced 100644 --- a/src/content/docs/help/cli-skills.mdx +++ b/src/content/docs/help/cli-skills.mdx @@ -1,5 +1,5 @@ --- -title: Install skills +title: CLI skills description: Learn how to install the Operately skills with the skills package from npm. --- diff --git a/src/content/docs/help/cli-usage.mdx b/src/content/docs/help/cli-usage.mdx index 2179316..9020136 100644 --- a/src/content/docs/help/cli-usage.mdx +++ b/src/content/docs/help/cli-usage.mdx @@ -1,5 +1,5 @@ --- -title: Use the CLI +title: Use the Operately CLI description: Learn the Operately CLI command shape, help system, and a few common examples. --- diff --git a/src/content/docs/help/cli.mdx b/src/content/docs/help/cli.mdx index 995d2b1..db94818 100644 --- a/src/content/docs/help/cli.mdx +++ b/src/content/docs/help/cli.mdx @@ -1,5 +1,5 @@ --- -title: CLI +title: Operately CLI description: Learn how to use the Operately CLI to work with the external API from your terminal. --- diff --git a/src/content/docs/help/create-api-token.mdx b/src/content/docs/help/create-api-token.mdx index 1b9a07a..009973f 100644 --- a/src/content/docs/help/create-api-token.mdx +++ b/src/content/docs/help/create-api-token.mdx @@ -31,3 +31,9 @@ After you close the token modal, you will not be able to view the full token aga - You can rename tokens to keep them organized. - You can change an existing token between **Read-only** and **Full-access**. - You can delete a token at any time. + +## What to read next + +- [CLI authentication](/help/cli-authentication) +- [Operately CLI overview](/help/cli) +- [Operately API docs](/help/api) diff --git a/src/content/docs/help/self-hosted-beacon.mdx b/src/content/docs/help/self-hosted-beacon.mdx index 75377d8..766ab79 100644 --- a/src/content/docs/help/self-hosted-beacon.mdx +++ b/src/content/docs/help/self-hosted-beacon.mdx @@ -1,5 +1,5 @@ --- -title: Beacon +title: Self-hosted beacon description: Learn about Operately's beacon system, how it works, and how to disable it. --- diff --git a/src/content/docs/help/self-hosted-email-delivery/index.mdx b/src/content/docs/help/self-hosted-email-delivery/index.mdx index ef43f2e..7bfabf2 100644 --- a/src/content/docs/help/self-hosted-email-delivery/index.mdx +++ b/src/content/docs/help/self-hosted-email-delivery/index.mdx @@ -1,5 +1,5 @@ --- -title: Email Delivery +title: Self-hosted email delivery description: Learn how to configure email delivery for your self-hosted Operately installation using SendGrid API or SMTP. --- diff --git a/src/content/docs/help/self-hosted-google-sign-in.mdx b/src/content/docs/help/self-hosted-google-sign-in.mdx index 34cc7bc..89e35c6 100644 --- a/src/content/docs/help/self-hosted-google-sign-in.mdx +++ b/src/content/docs/help/self-hosted-google-sign-in.mdx @@ -1,5 +1,5 @@ --- -title: Google Sign-In +title: Self-hosted Google Sign-In description: Learn how to enable Google Sign-In (OAuth) for your self-hosted Operately installation. --- diff --git a/src/content/docs/help/self-hosted-installation.mdx b/src/content/docs/help/self-hosted-installation.mdx index 9b6bd47..6637091 100644 --- a/src/content/docs/help/self-hosted-installation.mdx +++ b/src/content/docs/help/self-hosted-installation.mdx @@ -1,5 +1,5 @@ --- -title: Installation +title: Self-hosted installation description: Learn how to download and install Operately on your own infrastructure. --- diff --git a/src/content/docs/help/self-hosted-update.mdx b/src/content/docs/help/self-hosted-update.mdx index a33c9d2..4582610 100644 --- a/src/content/docs/help/self-hosted-update.mdx +++ b/src/content/docs/help/self-hosted-update.mdx @@ -1,5 +1,5 @@ --- -title: Update Version +title: Update a self-hosted installation description: Learn how to update your self-hosted Operately installation to a newer version. ---