Skip to content

fix: remove TOC from API reference pages #882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create an environment
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/environments
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete an environment
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v1/environments/{environmentId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List all environments
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/environments
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update an environment
full: true
hideTOC: true
_openapi:
method: PUT
route: /v1/environments/{environmentId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Broadcast event to all
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/events/trigger/broadcast
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/events/bulk-trigger-event.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bulk trigger event
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/events/trigger/bulk
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Cancel triggered event
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v1/events/trigger/{transactionId}
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/events/trigger-event.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Trigger event
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/events/trigger
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create an integration
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/integrations
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete an integration
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v1/integrations/{integrationId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List active integrations
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/integrations/active
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List all integrations
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/integrations
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update an integration
full: true
hideTOC: true
_openapi:
method: PUT
route: /v1/integrations/{integrationId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update integration as primary
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/integrations/{integrationId}/set-primary
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/messages/delete-a-message.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete a message
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v1/messages/{messageId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete messages by transactionId
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v1/messages/transaction/{transactionId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List all messages
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/messages
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List all events
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve an event
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/notifications/{notificationId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bulk create subscribers
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/subscribers/bulk
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create a subscriber
full: true
hideTOC: true
_openapi:
method: POST
route: /v2/subscribers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete a subscriber
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v2/subscribers/{subscriberId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete provider credentials
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v1/subscribers/{subscriberId}/credentials/{providerId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve a subscriber
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/subscribers/{subscriberId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve subscriber notifications
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/subscribers/{subscriberId}/notifications/feed
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve subscriber preferences
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/subscribers/{subscriberId}/preferences
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve subscriber subscriptions
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/subscribers/{subscriberId}/subscriptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve unseen notifications count
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/subscribers/{subscriberId}/notifications/unseen
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Search subscribers
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/subscribers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update a subscriber
full: true
hideTOC: true
_openapi:
method: PATCH
route: /v2/subscribers/{subscriberId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update all notifications state
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/subscribers/{subscriberId}/messages/mark-all
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update notification action status
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update notifications state
full: true
hideTOC: true
_openapi:
method: POST
route: /v1/subscribers/{subscriberId}/messages/mark-as
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update provider credentials
full: true
hideTOC: true
_openapi:
method: PUT
route: /v1/subscribers/{subscriberId}/credentials
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update subscriber online status
full: true
hideTOC: true
_openapi:
method: PATCH
route: /v1/subscribers/{subscriberId}/online-status
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update subscriber preferences
full: true
hideTOC: true
_openapi:
method: PATCH
route: /v2/subscribers/{subscriberId}/preferences
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Upsert provider credentials
full: true
hideTOC: true
_openapi:
method: PATCH
route: /v1/subscribers/{subscriberId}/credentials
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Check topic subscriber
full: true
hideTOC: true
_openapi:
method: GET
route: /v1/topics/{topicKey}/subscribers/{externalSubscriberId}
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/topics/create-a-topic.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create a topic
full: true
hideTOC: true
_openapi:
method: POST
route: /v2/topics
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create topic subscriptions
full: true
hideTOC: true
_openapi:
method: POST
route: /v2/topics/{topicKey}/subscriptions
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/topics/delete-a-topic.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete a topic
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v2/topics/{topicKey}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete topic subscriptions
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v2/topics/{topicKey}/subscriptions
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/topics/list-all-topics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List all topics
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/topics
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List topic subscriptions
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/topics/{topicKey}/subscriptions
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/topics/retrieve-a-topic.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve a topic
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/topics/{topicKey}
Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/topics/update-a-topic.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Update a topic
full: true
hideTOC: true
_openapi:
method: PATCH
route: /v2/topics/{topicKey}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create a workflow
full: true
hideTOC: true
_openapi:
method: POST
route: /v2/workflows
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Delete a workflow
full: true
hideTOC: true
_openapi:
method: DELETE
route: /v2/workflows/{workflowId}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: List all workflows
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/workflows
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Retrieve a workflow
full: true
hideTOC: true
_openapi:
method: GET
route: /v2/workflows/{workflowId}
Expand Down
Loading