Skip to content

Commit

Permalink
Fix Symphony REST API doc links (#803)
Browse files Browse the repository at this point in the history
  • Loading branch information
yinan-symphony authored Jun 18, 2024
1 parent da71aed commit bed194d
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 52 deletions.
24 changes: 12 additions & 12 deletions docs/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ nav_order: 12

# Application API

The Application Service is a component at the service layer of the BDK which aims to cover the Applications part of the [REST API documentation](https://developers.symphony.com/restapi/reference).
The Application Service is a component at the service layer of the BDK which aims to cover the Applications part of the [REST API documentation](https://developers.symphony.com/restapi/main/manage-apps).
More precisely:
* [Create application](https://developers.symphony.com/restapi/reference#create-app)
* [Create application with an RSA public key](https://developers.symphony.com/restapi/reference#create-application-with-an-rsa-public-key)
* [Update application](https://developers.symphony.com/restapi/reference#update-application)
* [Update application with an RSA public key](https://developers.symphony.com/restapi/reference#update-application-with-an-rsa-public-key)
* [Delete application](https://developers.symphony.com/restapi/reference#delete-application)
* [Get application](https://developers.symphony.com/restapi/reference#get-application)
* [List application entitlements](https://developers.symphony.com/restapi/reference#list-app-entitlements)
* [Update application entitlements](https://developers.symphony.com/restapi/reference#update-application-entitlements)
* [List user applications](https://developers.symphony.com/restapi/reference#user-apps)
* [Update user applications](https://developers.symphony.com/restapi/reference#update-user-apps)
* [Patch user applications](https://developers.symphony.com/restapi/reference/partial-update-user-apps)
* [Create application](https://developers.symphony.com/restapi/main/manage-apps/create-app)
* [Create application with an RSA public key](https://developers.symphony.com/restapi/main/manage-apps/create-app#rsa-application-authentication)
* [Update application](https://developers.symphony.com/restapi/main/manage-apps/update-application)
* [Update application with an RSA public key](https://developers.symphony.com/restapi/main/manage-apps/update-application#rsa-application-authentication)
* [Delete application](hhttps://developers.symphony.com/restapi/main/manage-apps/delete-application)
* [Get application](https://developers.symphony.com/restapi/main/manage-apps/get-application)
* [List application entitlements](https://developers.symphony.com/restapi/main/apps-entitlements/list-app-entitlements)
* [Update application entitlements](https://developers.symphony.com/restapi/main/apps-entitlements/update-application-entitlements)
* [List user applications](https://developers.symphony.com/restapi/main/apps-entitlements/user-apps)
* [Update user applications](https://developers.symphony.com/restapi/main/apps-entitlements/update-user-apps)
* [Patch user applications](https://developers.symphony.com/restapi/main/apps-entitlements/partial-update-user-apps)


## How to use
Expand Down
14 changes: 7 additions & 7 deletions docs/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ nav_order: 14

# Connection API

The Connection Service is a component at the service layer of the BDK which aims to cover the Connections part of the [REST API documentation](https://developers.symphony.com/restapi/reference).
The Connection Service is a component at the service layer of the BDK which aims to cover the Connections part of the [REST API documentation](https://developers.symphony.com/restapi/main/connections).
More precisely:
* [Get connection](https://developers.symphony.com/restapi/reference#get-connection)
* [List connections](https://developers.symphony.com/restapi/reference#list-connections)
* [Create connection](https://developers.symphony.com/restapi/reference#create-connection)
* [Accept connection](https://developers.symphony.com/restapi/reference#accepted-connection)
* [Reject connection](https://developers.symphony.com/restapi/reference#reject-connection)
* [Remove connection](https://developers.symphony.com/restapi/reference#remove-connection)
* [Get connection](https://developers.symphony.com/restapi/main/connections/get-connection)
* [List connections](https://developers.symphony.com/restapi/main/connections/list-connections)
* [Create connection](https://developers.symphony.com/restapi/main/connections/create-connection)
* [Accept connection](https://developers.symphony.com/restapi/main/connections/accepted-connection)
* [Reject connection](https://developers.symphony.com/restapi/main/connections/reject-connection)
* [Remove connection](https://developers.symphony.com/restapi/main/connections/remove-connection)


## How to use
Expand Down
8 changes: 4 additions & 4 deletions docs/disclaimer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ nav_order: 15

# Disclaimer API

The Disclaimer Service is a component at the service layer of the BDK which aims to cover the Disclaimers part of the [REST API documentation](https://developers.symphony.com/restapi/reference).
The Disclaimer Service is a component at the service layer of the BDK which aims to cover the Disclaimers part of the [REST API documentation](https://developers.symphony.com/restapi/main/disclaimers).
More precisely:
* [Get disclaimer](https://developers.symphony.com/restapi/reference/disclaimer)
* [List disclaimers](https://developers.symphony.com/restapi/reference/list-disclaimers)
* [List disclaimer Users](https://developers.symphony.com/restapi/reference/disclaimer-users)
* [Get disclaimer](https://developers.symphony.com/restapi/main/disclaimers/disclaimer)
* [List disclaimers](https://developers.symphony.com/restapi/main/disclaimers/list-disclaimers)
* [List disclaimer Users](https://developers.symphony.com/restapi/main/disclaimers/disclaimer-users)


## How to use
Expand Down
8 changes: 4 additions & 4 deletions docs/health.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ nav_order: 16
---

# Health API
The Health Service is a component at the service layer of the BDK which covers the Health Service part of the [REST API documentation](https://developers.symphony.com/restapi/reference).
The Health Service is a component at the service layer of the BDK which covers the Health Service part of the [REST API documentation](https://developers.symphony.com/restapi/main/info-health-check).
More precisely:
* [Health check](https://developers.symphony.com/restapi/reference/health-check-v3)
* [Health check extended](https://developers.symphony.com/restapi/reference/health-check-extended-v3)
* [Agent info](https://developers.symphony.com/restapi/reference/agent-info-v1)
* [Health check](https://developers.symphony.com/restapi/main/info-health-check/health-check-v3)
* [Health check extended](https://developers.symphony.com/restapi/main/info-health-check/health-check-extended-v3)
* [Agent info](https://developers.symphony.com/restapi/main/info-health-check/agent-info-v1)


## How to use
Expand Down
30 changes: 15 additions & 15 deletions docs/message.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ nav_order: 8

# Message API

The Message API aims to cover the Messages part of the [REST API documentation](https://developers.symphony.com/restapi/reference/messages-v4).
The Message API aims to cover the Messages part of the [REST API documentation](https://developers.symphony.com/restapi/main/messages).
More precisely:
* [Get a message](https://developers.symphony.com/restapi/reference/get-message-v1)
* [Get messages](https://developers.symphony.com/restapi/reference/messages-v4)
* [Search messages](https://developers.symphony.com/restapi/reference/message-search-post)
* [Get message IDs by timestamp](https://developers.symphony.com/restapi/reference/get-message-ids-by-timestamp)
* [Send message](https://developers.symphony.com/restapi/reference/create-message-v4)
* [Update message](https://developers.symphony.com/restapi/reference/update-message-v4)
* [Import messages](https://developers.symphony.com/restapi/reference/import-message-v4)
* [Get attachment](https://developers.symphony.com/restapi/reference/attachment)
* [List attachments](https://developers.symphony.com/restapi/reference/list-attachments)
* [Get allowed attachment types](https://developers.symphony.com/restapi/reference/attachment-types)
* [Suppress message](https://developers.symphony.com/restapi/reference/suppress-message)
* [Get message status](https://developers.symphony.com/restapi/reference/message-status)
* [Get message receipts](https://developers.symphony.com/restapi/reference/list-message-receipts)
* [Get message relationships](https://developers.symphony.com/restapi/reference/message-metadata-relationship)
* [Get a message](https://developers.symphony.com/restapi/main/messages/get-message-v1)
* [Get messages](hhttps://developers.symphony.com/restapi/main/messages/messages-v4)
* [Search messages](https://developers.symphony.com/restapi/main/messages/message-search-post)
* [Get message by multiple query params](https://developers.symphony.com/restapi/main/messages/message-search-get)
* [Send message](https://developers.symphony.com/restapi/main/messages/create-message-v4)
* [Update message](https://developers.symphony.com/restapi/main/messages/update-message-v4)
* [Import messages](https://developers.symphony.com/restapi/main/messages/import-message-v4)
* [Get attachment](hhttps://developers.symphony.com/restapi/main/messages/attachment)
* [List attachments](https://developers.symphony.com/restapi/main/messages/list-attachments)
* [Get allowed attachment types](https://developers.symphony.com/restapi/main/messages/attachment-types)
* [Suppress message](hhttps://developers.symphony.com/restapi/main/messages/suppress-message)
* [Get message status](https://developers.symphony.com/restapi/main/messages/message-status)
* [Get message receipts](https://developers.symphony.com/restapi/main/messages/list-message-receipts)
* [Get message relationships](https://developers.symphony.com/restapi/main/messages/message-metadata-relationship)

## How to use
The central component for the Message API is the `MessageService`.
Expand Down
20 changes: 10 additions & 10 deletions docs/presence.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ nav_order: 11

# Presence API

The Presence Service is a component at the service layer of the BDK which covers the Presence part of the [REST API documentation](https://developers.symphony.com/restapi/reference).
The Presence Service is a component at the service layer of the BDK which covers the Presence part of the [REST API documentation](https://developers.symphony.com/restapi/main/presence).
More precisely:
* [Get presence](https://developers.symphony.com/restapi/reference#get-presence)
* [Get All Presence](https://developers.symphony.com/restapi/reference#get-all-presence)
* [Get User Presence](https://developers.symphony.com/restapi/reference#user-presence-v3)
* [External Presence Interest](https://developers.symphony.com/restapi/reference#register-user-presence-interest)
* [Set Presence](https://developers.symphony.com/restapi/reference#set-presence)
* [Create Presence Feed](https://developers.symphony.com/restapi/reference#create-presence-feed)
* [Read Presence Feed](https://developers.symphony.com/restapi/reference#read-presence-feed)
* [Delete Presence Feed](https://developers.symphony.com/restapi/reference#delete-presence-feed)
* [Set Other User's Presence](https://developers.symphony.com/restapi/reference#set-user-presence)
* [Get presence](https://developers.symphony.com/restapi/main/presence/get-presence)
* [Get All Presence](https://developers.symphony.com/restapi/main/presence/get-all-presence)
* [Get User Presence](https://developers.symphony.com/restapi/main/presence/user-presence-v3)
* [External Presence Interest](https://developers.symphony.com/restapi/main/presence/register-user-presence-interest)
* [Set Presence](https://developers.symphony.com/restapi/main/presence/set-presence)
* [Create Presence Feed](https://developers.symphony.com/restapi/deprecated-endpoints/create-presence-feed) :warning: **Deprecated**
* [Read Presence Feed](https://developers.symphony.com/restapi/deprecated-endpoints/read-presence-feed) :warning: **Deprecated**
* [Delete Presence Feed](https://developers.symphony.com/restapi/deprecated-endpoints/delete-presence-feed) :warning: **Deprecated**
* [Set Other User's Presence](https://developers.symphony.com/restapi/main/presence/set-user-presence)


## How to use
Expand Down

0 comments on commit bed194d

Please sign in to comment.