Skip to content

Commit

Permalink
chore: add docs prefix to textile redirection links
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiehenson committed Jan 16, 2025
1 parent 1478e0c commit 497a41f
Show file tree
Hide file tree
Showing 133 changed files with 1,078 additions and 1,078 deletions.
2 changes: 1 addition & 1 deletion content/account/app/index.textile
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Create, manage, and configure "API keys":/account/dashboard/api by setting capab

h3. Integrations

"Integrate":/general/integrations Ably with external services, enabling data to flow between Ably channels and third-party platforms:
"Integrate":/docs/general/integrations Ably with external services, enabling data to flow between Ably channels and third-party platforms:

* Ably events can trigger webhook requests to external services, or external services can send data to Ably using incoming webhooks.
* Ably enables continuous streaming of events to external services like Amazon Kinesis or Kafka, or can receive inbound streams from external services.
Expand Down
6 changes: 3 additions & 3 deletions content/account/app/queues.textile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ meta_description: Manage and configure Ably queues, monitor realtime data, and o
meta_keywords: “Ably Queues, realtime data, AMQP, STOMP, queue management, TTL, queue settings"
---

Ably queues provide a way to consume realtime data using the "AMQP":/general/queues#consume-amqp or "STOMP":/general/queues#consume-stomp protocols. Find out more about using "Ably queues":/general/queues#what.
Ably queues provide a way to consume realtime data using the "AMQP":/docs/general/queues#consume-amqp or "STOMP":/docs/general/queues#consume-stomp protocols. Find out more about using "Ably queues":/docs/general/queues#what.

h2. Manage your Ably queues

Expand All @@ -26,6 +26,6 @@ When provisioning a new queue, you'll need to specify several things:

h3(#setup). Set up queue rules

Once you have provisioned a physical queue, you need to set up one or more queue rules to republish messages, presence events or channel events from pub/sub channels into a queue. Queue rules can either be used to publish to internal queues (hosted by Ably) or external external streams or queues (such as Amazon Kinesis and RabbitMQ). Publishing to external streams or queues is part of our "Ably Firehose servers":/general/firehose.
Once you have provisioned a physical queue, you need to set up one or more queue rules to republish messages, presence events or channel events from pub/sub channels into a queue. Queue rules can either be used to publish to internal queues (hosted by Ably) or external external streams or queues (such as Amazon Kinesis and RabbitMQ). Publishing to external streams or queues is part of our "Ably Firehose servers":/docs/general/firehose.

Ably queue rules are setup in the *Integrations* tab found within your app *dashboard*. Find out more about setting up "queue rules":/general/queues#setup.
Ably queue rules are setup in the *Integrations* tab found within your app *dashboard*. Find out more about setting up "queue rules":/docs/general/queues#setup.
34 changes: 17 additions & 17 deletions content/account/control-api.textile
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Programmatic management with Control API
meta_description: "The Control API is a REST API that enables you to manage your Ably account programmatically. This is the Control API user guide."
meta_keywords: "Ably, applications, apps, Control API, account management, control, REST API, OpenAPI Specification, OAS3."
redirect_from:
- /control-api
- /control-api/curl-examples
- /control-api/testing-with-postman
- /docs/control-api
- /docs/control-api/curl-examples
- /docs/control-api/testing-with-postman
---

Ably Control API is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure. Details of the API can be found in the "Control API Reference":/api/control-api.
Ably Control API is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure. Details of the API can be found in the "Control API Reference":/docs/api/control-api.

Using the Control API you can automate the provisioning, management, and testing of your Ably realtime infrastructure. You can dynamically create Ably apps, configure them, and delete them if necessary. You can implement multi-tenancy solutions for your customers, and create configuration-driven environments that can easily be replicated under programmatic control. Once these environments are created you can also test them using Control API.

Expand All @@ -18,8 +18,8 @@ With the Control API you can create and manage:
* API keys for an Ably app
* "Account and app statistics":/metadata-stats/stats
* "Namespaces":/channels#namespaces (for channel rules)
* "Queues":/general/queues
* "Integration rules":/general/integrations
* "Queues":/docs/general/queues
* "Integration rules":/docs/general/integrations

Repetitive operations such as creating, updating or deleting Ably apps, enumerating queues, creation of rules, and other tasks that would be time-consuming to carry out manually, can be automated using the Control API.

Expand All @@ -29,7 +29,7 @@ The following diagram illustrates an example use case:
<img src="@content/screenshots/control-api/provision-and-test.png" style="width: 100%" alt="Provision and Test">
</a>

In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/api/realtime-sdk or "REST API":/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/docs/api/realtime-sdk or "REST API":/docs/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.

In order to use the Control API you must first create an access token in the "Ably dashboard":https://ably.com/accounts/any. You can then use the Control API to manage many account functions without having to interact with the dashboard.

Expand Down Expand Up @@ -123,7 +123,7 @@ Sample response:

h2(#ids). Account ID and app ID

Operations that affect your entire account, such as "listing the apps":/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
Operations that affect your entire account, such as "listing the apps":/docs/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/docs/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.

h3(#account-id). How to find your account ID

Expand Down Expand Up @@ -178,7 +178,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
}'
```

See the "API reference":/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
See the "API reference":/docs/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.

Sample response, with @entries@ trimmed for readability:

Expand Down Expand Up @@ -243,7 +243,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
}'
```

See the "API reference":/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
See the "API reference":/docs/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.

Sample response:

Expand Down Expand Up @@ -302,7 +302,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/stats
}'
```

See the "API reference":/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
See the "API reference":/docs/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.

Sample response, with @entries@ trimmed for readability:

Expand All @@ -325,7 +325,7 @@ Sample response, with @entries@ trimmed for readability:

h3(#examples-queues). Queues

You can use the Control API to manage "Ably queues":/general/queues. The main operations are:
You can use the Control API to manage "Ably queues":/docs/general/queues. The main operations are:

* List all Ably queues
* Create a queue
Expand Down Expand Up @@ -394,7 +394,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/queue
}'
```

See the "API reference":/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
See the "API reference":/docs/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.

Sample response:

Expand Down Expand Up @@ -577,7 +577,7 @@ In this case there is only a status code returned (200), or an error code.

h3(#examples-rules). Rules

You can use the Control API to manage Ably "integration rules":/general/integrations. The main operations are:
You can use the Control API to manage Ably "integration rules":/docs/general/integrations. The main operations are:

* List all rules for an app
* List details of a specific rule using rule ID
Expand Down Expand Up @@ -642,7 +642,7 @@ The rule details are returned for the specified rule.

h4(#examples-rules-create). Create a rule

The following example creates a rule with the following "configuration":/general/webhooks#configure:
The following example creates a rule with the following "configuration":/docs/general/webhooks#configure:

|_. Parameter |_. Value |_. Description |
| @ruleType@ | http | The type of rule, in this case a webhook rule |
Expand All @@ -653,7 +653,7 @@ The following example creates a rule with the following "configuration":/general
| @format@ | json | Format of encoding for the rule, in this case JSON |
| @name@ | User-Agent | Optional header or headers, including custom headers that might be required. In this case a user agent header is specified (this needs to be set for some providers) |
| @value@ | user-agent-name | The value of the header |
| @enveloped@ | true | Wrap packet in "metadata":/general/webhooks#envelope |
| @enveloped@ | true | Wrap packet in "metadata":/docs/general/webhooks#envelope |

The corresponding request is:

Expand Down Expand Up @@ -827,4 +827,4 @@ Now that you have obtained the token and IDs, you can learn how to send a reques
<img src="@content/screenshots/control-api/list-apps-response.png" style="width: 70%" alt="Response">
</a>

You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/api/control-api for further information.
You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/docs/api/control-api for further information.
18 changes: 9 additions & 9 deletions content/api/index.textile
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ This section of the documentation contains the API references for Ably.

The following API references are available:

* "Client library Realtime SDK":/api/realtime-sdk
* "Client library REST SDK":/api/rest-sdk
* "REST API":/api/rest-api
* "SSE API":/api/sse
* "Control API":/api/control-api
* "Client library Realtime SDK":/docs/api/realtime-sdk
* "Client library REST SDK":/docs/api/rest-sdk
* "REST API":/docs/api/rest-api
* "SSE API":/docs/api/sse
* "Control API":/docs/api/control-api

h2(#sdks). Client library SDKs

Depending on availability, an Ably client library SDK may support both a realtime interface and a REST interface. Some SDKs only provide a REST interface. You can check availability on the "SDK page":https://ably.com/download.

The "realtime interface":/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
The "realtime interface":/docs/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/docs/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.

Typically the REST interface is used on the server, as the server's main task is to authenticate clients, but does not usually need to subscribe to a channel to obtain realtime events.

Expand All @@ -47,15 +47,15 @@ The SDKs that have API references generated from source code are:

h2(#rest-api). REST API

A raw "REST API":/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
A raw "REST API":/docs/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.

h2(#sse-api). SSE API

The "Ably Server-Sent Events API":/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
The "Ably Server-Sent Events API":/docs/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.

h2(#control-api). Control API

"Ably Control API":/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
"Ably Control API":/docs/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.

h2(#spaces). Spaces SDK

Expand Down
Loading

0 comments on commit 497a41f

Please sign in to comment.