Skip to content

Commit e3393b6

Browse files
authored
Merge pull request #215 from quixio/tonybedford/sc-49709/update-ai-to-io-in-docs
Change quix.ai to quix.io
2 parents 08b202c + a9ac3bb commit e3393b6

File tree

41 files changed

+116
-119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+116
-119
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
This repository is the source content for the Quix documentation that is published on the web at https://quix.io/docs. The source files for the documentation are in GitHub-flavoured Markdown, with the additions supported by our tooling, [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
77

8-
To get a free Quix account, [sign up](https://portal.platform.quix.ai/self-sign-up).
8+
To get a free Quix account, [sign up](https://portal.platform.quix.io/self-sign-up).
99

1010
## Docs releases
1111

docs/apis/portal-api/http-requests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ Read the documentation on how to obtain your environment ID.
2929
The API endpoint URL has the following format:
3030

3131
```
32-
https://<api-name>-<environment-id>.platform.quix.ai/<action>
32+
https://<api-name>-<environment-id>.platform.quix.io/<action>
3333
```
3434

3535
So, for example, the endpoint URL for the streaming writer might resemble the following:
3636

3737
```
38-
https://writer-acme-weather.platform.quix.ai/<action>
38+
https://writer-acme-weather.platform.quix.io/<action>
3939
```
4040

4141
The API is `writer`, and the environment ID is `acme-weather`.
@@ -81,5 +81,5 @@ You should structure most of your requests to the API around this pattern:
8181
curl -H "Authorization: bearer ${token}" \
8282
-H "Content-Type: application/json" \
8383
-d "@data.json" \
84-
https://${api-name}-${environment-id}.platform.quix.ai/<action>
84+
https://${api-name}-${environment-id}.platform.quix.io/<action>
8585
```

docs/apis/portal-api/setup.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To use the APIs you'll typically need the following:
44

5-
1. [Sign up to Quix](https://portal.platform.quix.ai/self-sign-up).
5+
1. [Sign up to Quix](https://portal.platform.quix.io/self-sign-up).
66

77
2. Obtain a Personal Access Token - you need this to authenticate requests.
88

@@ -42,19 +42,19 @@ In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to gener
4242

4343
When using APIs you’ll need to obtain an ID based on a specific environment. For example, endpoints for the [Query API](../../apis/query-api/overview.md) use a domain with the following pattern:
4444

45-
https://telemetry-query-${environment-id}.platform.quix.ai/
45+
https://telemetry-query-${environment-id}.platform.quix.io/
4646

4747
The environment ID is a combination of your organization and environment names, converted to URL friendly values.
4848

4949
### Obtain your environment ID from the URL
5050

51-
1. Go to the [Portal home](https://portal.platform.quix.ai/){target=_blank}.
51+
1. Go to the [Portal home](https://portal.platform.quix.io/){target=_blank}.
5252

5353
2. Locate the environment you’re interested in and open it.
5454

5555
3. At this point, take note of the URL. It will be in the form:
5656

57-
https://portal.platform.quix.ai/home?workspace={environment-id}
57+
https://portal.platform.quix.io/home?workspace={environment-id}
5858

5959
### Obtain environment ID from settings
6060

@@ -67,7 +67,7 @@ You can also get the environment ID from Settings. Click `Settings` in the botto
6767
Given the following URL for the environment:
6868

6969
```
70-
https://portal.platform.quix.ai/pipeline?workspace=joeengland-apitests-testing
70+
https://portal.platform.quix.io/pipeline?workspace=joeengland-apitests-testing
7171
```
7272

7373
The environment ID is:
@@ -86,7 +86,7 @@ Copy the value for `environment-id` and use it wherever you need an environment
8686

8787
!!! note
8888

89-
The `workspace=` parameter in the URL `https://portal.platform.quix.ai/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
89+
The `workspace=` parameter in the URL `https://portal.platform.quix.io/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
9090

9191
## API reference documentation
9292

@@ -96,10 +96,10 @@ The URLs for the API references are specific to your environment, so you can eas
9696

9797
| API | API reference URL (Swagger documentation)|
9898
|---|---|
99-
| Streaming Writer | https://writer-`<environment-id>`.platform.quix.ai/swagger |
99+
| Streaming Writer | https://writer-`<environment-id>`.platform.quix.io/swagger |
100100
| Streaming Reader | No HTTP/REST interface - SignalR (WebSockets or Long Polling)|
101-
| Portal | https://portal-api.platform.quix.ai/swagger |
102-
| Query | https://telemetry-query-`<environment-id>`.platform.quix.ai/swagger |
101+
| Portal | https://portal-api.platform.quix.io/swagger |
102+
| Query | https://telemetry-query-`<environment-id>`.platform.quix.io/swagger |
103103

104104
Replace `<environment-id>` with your environment ID.
105105

docs/apis/query-api/filter-tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Each object in the `tagFilters` array can support the following `operator` value
6666
`Like` and `NotLike` perform a regular expression match, so you can search by pattern. For example, to get the Speed parameter values tagged with a LapNumber which is either 2 or 4, you can use the expression `^\[24\]\\.` to match values 2.0 and 4.0:
6767

6868
```bash
69-
curl "https://telemetry-query-testing-quickstart.platform.quix.ai/parameters/data" \
69+
curl "https://telemetry-query-testing-quickstart.platform.quix.io/parameters/data" \
7070
-H "Authorization: bearer ${token}" \
7171
-H "Content-Type: application/json" \
7272
-d '{

docs/apis/query-api/http-requests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ APIs are available on a per-environment basis (with the exception of the Portal
2727
The API endpoint URL has the following format:
2828

2929
```
30-
https://<api-name>-<environment-id>.platform.quix.ai/<action>
30+
https://<api-name>-<environment-id>.platform.quix.io/<action>
3131
```
3232

3333
So, for example, the endpoint URL for the streaming writer might resemble the following:
3434

3535
```
36-
https://writer-acme-weather.platform.quix.ai/<action>
36+
https://writer-acme-weather.platform.quix.io/<action>
3737
```
3838

3939
The API is `writer`, and the environment ID is `acme-weather`.
@@ -79,5 +79,5 @@ You should structure most of your requests to the API around this pattern:
7979
curl -H "Authorization: bearer ${token}" \
8080
-H "Content-Type: application/json" \
8181
-d "@data.json" \
82-
https://${api-name}-${environment-id}.platform.quix.ai/<action>
82+
https://${api-name}-${environment-id}.platform.quix.io/<action>
8383
```

docs/apis/query-api/raw-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ In this example, we’re requesting a single numeric parameter, `Speed`. Each ar
2525
### Example
2626

2727
```bash
28-
curl "https://${domain}.platform.quix.ai/parameters/data" \
28+
curl "https://${domain}.platform.quix.io/parameters/data" \
2929
-H "accept: text/plain" \
3030
-H "Authorization: bearer <token>" \
3131
-H "Content-Type: application/json" \

docs/apis/query-api/setup.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To use the APIs you'll typically need the following:
44

5-
1. [Sign up to Quix](https://portal.platform.quix.ai/self-sign-up).
5+
1. [Sign up to Quix](https://portal.platform.quix.io/self-sign-up).
66

77
2. Obtain a Personal Access Token - you need this to authenticate requests.
88

@@ -42,19 +42,19 @@ In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to gener
4242

4343
When using APIs you’ll need to obtain an ID based on a specific environment. For example, endpoints for the Query API use a domain with the following pattern:
4444

45-
https://telemetry-query-${environment-id}.platform.quix.ai/
45+
https://telemetry-query-${environment-id}.platform.quix.io/
4646

4747
The environment ID is a combination of your organization and environment names, converted to URL friendly values.
4848

4949
### Obtain your environment ID from the URL
5050

51-
1. Go to the [Portal home](https://portal.platform.quix.ai/){target=_blank}.
51+
1. Go to the [Portal home](https://portal.platform.quix.io/){target=_blank}.
5252

5353
2. Locate the environment you’re interested in and open it.
5454

5555
3. At this point, take note of the URL. It will be in the form:
5656

57-
https://portal.platform.quix.ai/home?workspace={environment-id}
57+
https://portal.platform.quix.io/home?workspace={environment-id}
5858

5959
### Obtain environment ID from settings
6060

@@ -67,7 +67,7 @@ You can also get the environment ID from Settings. Click `Settings` in the botto
6767
Given the following URL for the environment:
6868

6969
```
70-
https://portal.platform.quix.ai/pipeline?workspace=joeengland-apitests-testing
70+
https://portal.platform.quix.io/pipeline?workspace=joeengland-apitests-testing
7171
```
7272

7373
The environment ID is:
@@ -86,7 +86,7 @@ Copy the value for `environment-id` and use it wherever you need an environment
8686

8787
!!! note
8888

89-
The `workspace=` parameter in the URL `https://portal.platform.quix.ai/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
89+
The `workspace=` parameter in the URL `https://portal.platform.quix.io/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
9090

9191
## API reference documentation
9292

@@ -96,10 +96,10 @@ The URLs for the API references are specific to your environment, so you can eas
9696

9797
| API | API reference URL (Swagger documentation)|
9898
|---|---|
99-
| Streaming Writer | https://writer-`<environment-id>`.platform.quix.ai/swagger |
99+
| Streaming Writer | https://writer-`<environment-id>`.platform.quix.io/swagger |
100100
| Streaming Reader | No HTTP/REST interface - SignalR (WebSockets or Long Polling)|
101-
| Portal | https://portal-api.platform.quix.ai/swagger |
102-
| Query | https://telemetry-query-`<environment-id>`.platform.quix.ai/swagger |
101+
| Portal | https://portal-api.platform.quix.io/swagger |
102+
| Query | https://telemetry-query-`<environment-id>`.platform.quix.io/swagger |
103103

104104
Replace `<environment-id>` with your environment ID.
105105

docs/apis/query-api/streams-filtered.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To fetch specific streams, you can include various filters with your request to
77
The most basic filter matches against a stream’s ID:
88

99
```bash
10-
curl "https://${domain}.platform.quix.ai/streams" \
10+
curl "https://${domain}.platform.quix.io/streams" \
1111
-H "Authorization: bearer ${token}" \
1212
-H "Content-Type: application/json" \
1313
-d '{"streamIds": ["302b1de3-2338-43cb-8148-3f0d6e8c0b8a"]}'
@@ -20,7 +20,7 @@ Note that you can supply multiple IDs in the `streamIds` array to match multiple
2020
The **location** of a stream defines its position in a hierarchy. A stream location looks just like a filesystem path. You can filter streams based on the start of this path, so you can easily find streams contained within any point in the hierarchy. For example, this query will find streams with a location of `/one` but it will also find streams with a `/one/two` location:
2121

2222
```bash
23-
curl "https://${domain}.platform.quix.ai/streams" \
23+
curl "https://${domain}.platform.quix.io/streams" \
2424
-H "Authorization: bearer ${token}" \
2525
-H "Content-Type: application/json" \
2626
-d '{"location": "/one"}'
@@ -37,7 +37,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
3737
You can filter streams based on their use of a given **parameter** with the `parameterIds` property. For example, to find all streams that contain at least one single occurence of `Gear` data:
3838

3939
```bash
40-
curl "https://${domain}.platform.quix.ai/streams" \
40+
curl "https://${domain}.platform.quix.io/streams" \
4141
-H "Authorization: bearer ${token}" \
4242
-H "Content-Type: application/json" \
4343
-d '{"parameterIds": [ "Gear"] }'
@@ -46,7 +46,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
4646
You can filter based on the presence or absence of a certain stream **status**, for example, if the stream is `Open` or was `Interrupted`. The `includeStatuses` and `excludeStatuses` properties each take an array of values to act on. So to get all streams that aren’t Interrupted or Closed, use this query:
4747

4848
```bash
49-
curl "https://${domain}.platform.quix.ai/streams" \
49+
curl "https://${domain}.platform.quix.io/streams" \
5050
-H "Authorization: bearer ${token}" \
5151
-H "Content-Type: application/json" \
5252
-d '{"excludeStatuses": [ "Interrupted", "Closed" ]}'
@@ -108,7 +108,7 @@ Calls to the `/streams` endpoint can include an `ordering` property in the paylo
108108
For example, to sort all streams in ascending order by topic:
109109

110110
```bash
111-
curl "https://${domain}.platform.quix.ai/streams" \
111+
curl "https://${domain}.platform.quix.io/streams" \
112112
-H "Authorization: bearer ${token}" \
113113
-H "Content-Type: application/json" \
114114
-d '{"ordering": [{ "by": "topic", "direction": "asc" }]}'

docs/apis/query-api/streams-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The `/streams/models` endpoint will return data in the same structure as [the `/
1111
The payload requirements are the same as those for `/streams`. You can fetch model information across all streams with an empty payload:
1212

1313
```shell
14-
curl "https://${domain}.platform.quix.ai/streams/models" \
14+
curl "https://${domain}.platform.quix.io/streams/models" \
1515
-H "Authorization: bearer ${token}" \
1616
-H "Content-Type: application/json" \
1717
-d "{}"

docs/apis/query-api/streams-paged.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `/streams` endpoint provides read access to all streams within the environme
1313
### Example request
1414

1515
```shell
16-
curl "https://${domain}.platform.quix.ai/streams" \
16+
curl "https://${domain}.platform.quix.io/streams" \
1717
-H "Authorization: bearer ${token}" \
1818
-H "Content-Type: application/json" \
1919
-d "{}"
@@ -61,7 +61,7 @@ For example, to group all streams in pages of 10 and receive the 2nd page, use t
6161
### Example request
6262

6363
```shell
64-
curl "https://${domain}.platform.quix.ai/streams" \
64+
curl "https://${domain}.platform.quix.io/streams" \
6565
-H "Authorization: bearer ${token}" \
6666
-H "Content-Type: application/json" \
6767
-d '{"paging":{"index": 1,"length": 10}}'

0 commit comments

Comments
 (0)