Skip to content

Commit

Permalink
Updated domain name
Browse files Browse the repository at this point in the history
  • Loading branch information
kanad-smartbear committed Jan 15, 2025
1 parent 399bb7c commit 48b4181
Show file tree
Hide file tree
Showing 17 changed files with 267 additions and 267 deletions.
2 changes: 1 addition & 1 deletion source/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
studio-api.cucumber.io
studio-api.cucumberstudio.com
32 changes: 16 additions & 16 deletions source/includes/_actionwords.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Get action words of a given project

```http
GET https://studio.cucumber.io/api/projects/<project_id>/actionwords HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -16,7 +16,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/actionwords" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -77,7 +77,7 @@ project_id | The ID of the project you want to retrieve the actionwords from
> Find actionwords by tags key
```http
GET https://studio.cucumber.io/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key> HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key> HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -89,7 +89,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key>" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key>" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -151,7 +151,7 @@ curl "https://studio.cucumber.io/api/projects/<project_id>/actionwords/find_by_t
> Find actionwords by tags key and value
```http
GET https://studio.cucumber.io/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key>&value=<tag_value> HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key>&value=<tag_value> HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -163,7 +163,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key>&value=<tag_value>" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/find_by_tags?key=<tag_key>&value=<tag_value>" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -223,7 +223,7 @@ value | The value of the tag
## Get a single action word

```http
GET https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id> HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id> HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -236,7 +236,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id>" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id>" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -277,7 +277,7 @@ actionword_id | The ID of the action word you want to get
## Create an action word

```http
POST https://studio.cucumber.io/api/projects/<project_id>/actionwords HTTP/1.1
POST https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords HTTP/1.1
Content-Type: application/json; charset=utf-8
Accept: application/vnd.api+json; version=1
access-token: <your access token>
Expand All @@ -301,7 +301,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl -XPOST "https://studio.cucumber.io/api/projects/<project_id>/actionwords" \
curl -XPOST "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords" \
-H 'Content-Type: application/json' \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
Expand Down Expand Up @@ -365,7 +365,7 @@ errors will be in the "errors" attribute of the returned data.
## Update an action word

```http
PATCH https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id> HTTP/1.1
PATCH https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id> HTTP/1.1
Content-Type: application/json; charset=utf-8
Accept: application/vnd.api+json; version=1
access-token: <your access token>
Expand All @@ -392,7 +392,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl -XPATCH "https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id>" \
curl -XPATCH "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id>" \
-H 'Content-Type: application/json' \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
Expand Down Expand Up @@ -446,7 +446,7 @@ You can rename an action word and update its definition by specifying the new na
## Delete an action word

```http
DELETE https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id> HTTP/1.1
DELETE https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id> HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -459,7 +459,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl -XDELETE "https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id>" \
curl -XDELETE "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id>" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand All @@ -482,7 +482,7 @@ Caution: your action word will be totaly and permanently removed from your proje
## Get an action word callers

```http
GET https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id>/callers HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id>/callers HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -495,7 +495,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/actionwords/<actionword_id>/callers" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/actionwords/<actionword_id>/callers" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down
8 changes: 4 additions & 4 deletions source/includes/_authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> To get your credentials:
```http
POST https://studio.cucumber.io/api/auth/sign_in HTTP/1.1
POST https://studio.cucumberstudio.com/api/auth/sign_in HTTP/1.1
Content-Type: application/json
{"email": "my_cucumberstudio_account", "password": "my_cucumberstudio_account"}
Expand All @@ -23,7 +23,7 @@ uid: my_cucumberstudio_account
curl -XPOST \
-H "Content-Type: application/json" \
-d '{"email": "my_cucumberstudio_account", "password": "my_cucumberstudio_account"}' \
-D - https://studio.cucumber.io/api/auth/sign_in
-D - https://studio.cucumberstudio.com/api/auth/sign_in

HTTP/1.1 200 OK
# snip.
Expand All @@ -39,15 +39,15 @@ uid: my_cucumberstudio_account
> An API call example
```http
GET https://studio.cucumber.io/api/<endpoint> HTTP/1.1
GET https://studio.cucumberstudio.com/api/<endpoint> HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
uid: <your uid>
```

```shell
curl https://studio.cucumber.io/api/<endpoint> \
curl https://studio.cucumberstudio.com/api/<endpoint> \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down
36 changes: 18 additions & 18 deletions source/includes/_builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can find more details on test executions and builds in the [Test execution i

## List builds of a test run
```http
GET https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -20,7 +20,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -78,7 +78,7 @@ test_run_id | The ID of the test run you want to retrieve the builds from
## Create a new build in a test run

```http
POST https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds" HTTP/1.1
POST https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds" HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -98,7 +98,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds" \
-XPOST \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
Expand Down Expand Up @@ -146,7 +146,7 @@ name | The name of the build. It should not be empty and uniq
## Update a build

```http
PATCH https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" HTTP/1.1
PATCH https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -168,7 +168,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" \
-XPOST \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
Expand Down Expand Up @@ -211,7 +211,7 @@ name | The new name of the build.
## Get a specific build of a test run

```http
GET https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -223,7 +223,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -264,7 +264,7 @@ test_run_id | The ID of the test run you want to retrieve the build from
## Get test execution results of a build

```http
GET https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>?include=test-results HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>?include=test-results HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -276,7 +276,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>?include=test-results" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>?include=test-results" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -367,7 +367,7 @@ test_run_id | The ID of the test run you want to retrieve the build from
## Get the current build of a test run

```http
GET https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/current" HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/current" HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -379,7 +379,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/current" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/current" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -423,7 +423,7 @@ test_run_id | The ID of the test run you want to retrieve the build from
## Get test execution results of the current build of a test run

```http
GET https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/current?include=test-results" HTTP/1.1
GET https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/current?include=test-results" HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -435,7 +435,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/current?include=test-results" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/current?include=test-results" \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
-H 'uid: <your uid>' \
Expand Down Expand Up @@ -529,7 +529,7 @@ test_run_id | The ID of the test run you want to retrieve the build from
## Add a test execution result to a build

```http
POST https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>/test_results HTTP/1.1
POST https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>/test_results HTTP/1.1
Content-Type: application/json; charset=utf-8
Accept: application/vnd.api+json; version=1
access-token: <your access token>
Expand Down Expand Up @@ -562,7 +562,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl -XPOST "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/test_snapshots/<test_snapshot_id>/test_results" \
curl -XPOST "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/test_snapshots/<test_snapshot_id>/test_results" \
-H 'Content-Type: application/json' \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
Expand Down Expand Up @@ -657,7 +657,7 @@ If the provided 'status' value does not match any of the listed possible values,
## Close a build

```http
POST https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>/close" HTTP/1.1
POST https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>/close" HTTP/1.1
Accept: application/vnd.api+json; version=1
access-token: <your access token>
client: <your client id>
Expand All @@ -669,7 +669,7 @@ Content-Type: application/vnd.api+json
```

```shell
curl "https://studio.cucumber.io/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>/close" \
curl "https://studio.cucumberstudio.com/api/projects/<project_id>/test_runs/<test_run_id>/builds/<build_id>/close" \
-XPOST \
-H 'accept: application/vnd.api+json; version=1' \
-H 'access-token: <your access token>' \
Expand Down
Loading

0 comments on commit 48b4181

Please sign in to comment.