Skip to content
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.

Sign up for GitHub

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

fix [docs]: correct invalid example request of basic auth in docs #1946

Merged
merged 1 commit into from
Jul 18, 2024
Merged

fix [docs]: correct invalid example request of basic auth in docs #1946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/docs/content/apis/import.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Retrieve the status of an import.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/import/subscribers'
curl -u "username:password" -X GET 'http://localhost:9000/api/import/subscribers'
```

##### Example Response
Expand All @@ -41,7 +41,7 @@ Retrieve logs related to imports.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/import/subscribers/logs'
curl -u "username:password" -X GET 'http://localhost:9000/api/import/subscribers/logs'
```

##### Example Response
Expand Down Expand Up @@ -85,7 +85,7 @@ Stop and delete an ongoing import.
##### Example Request

```shell
curl -u "username:username" -X DELETE 'http://localhost:9000/api/import/subscribers'
curl -u "username:password" -X DELETE 'http://localhost:9000/api/import/subscribers'
```

##### Example Response
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/content/apis/lists.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Retrieve lists.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/lists?page=1&per_page=100'
curl -u "username:password" -X GET 'http://localhost:9000/api/lists?page=1&per_page=100'
```

##### Example Response
Expand Down Expand Up @@ -85,7 +85,7 @@ Retrieve a specific list.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/lists/5'
curl -u "username:password" -X GET 'http://localhost:9000/api/lists/5'
```

##### Example Response
Expand Down Expand Up @@ -124,7 +124,7 @@ Create a new list.
##### Example Request

```shell
curl -u "username:username" -X POST 'http://localhost:9000/api/lists'
curl -u "username:password" -X POST 'http://localhost:9000/api/lists'
```

##### Example Response
Expand Down Expand Up @@ -164,7 +164,7 @@ Update a list.
##### Example Request

```shell
curl -u "username:username" -X PUT 'http://localhost:9000/api/lists/5' \
curl -u "username:password" -X PUT 'http://localhost:9000/api/lists/5' \
--form 'name=modified test list' \
--form 'type=private'
```
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/content/apis/media.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Get an uploaded media file.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/media' \
curl -u "username:password" -X GET 'http://localhost:9000/api/media' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------093715978792575906250298'
```

Expand Down Expand Up @@ -51,7 +51,7 @@ Upload a media file.
##### Example Request

```shell
curl -u "username:username" -X POST 'http://localhost:9000/api/media' \
curl -u "username:password" -X POST 'http://localhost:9000/api/media' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------183679989870526937212428' \
--form 'file=@/path/to/image.jpg'
```
Expand Down Expand Up @@ -86,7 +86,7 @@ Delete an uploaded media file.
##### Example Request

```shell
curl -u "username:username" -X DELETE 'http://localhost:9000/api/media/1'
curl -u "username:password" -X DELETE 'http://localhost:9000/api/media/1'
```

##### Example Response
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/content/apis/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Retrieve all templates.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/templates'
curl -u "username:password" -X GET 'http://localhost:9000/api/templates'
```

##### Example Response
Expand Down Expand Up @@ -56,7 +56,7 @@ Retrieve a specific template.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/templates/1'
curl -u "username:password" -X GET 'http://localhost:9000/api/templates/1'
```

##### Example Response
Expand Down Expand Up @@ -90,7 +90,7 @@ Retrieve the HTML preview of a template.
##### Example Request

```shell
curl -u "username:username" -X GET 'http://localhost:9000/api/templates/1/preview'
curl -u "username:password" -X GET 'http://localhost:9000/api/templates/1/preview'
```

##### Example Response
Expand Down Expand Up @@ -179,7 +179,7 @@ Set a template as the default.
##### Example Request

```shell
curl -u "username:username" -X PUT 'http://localhost:9000/api/templates/1/default'
curl -u "username:password" -X PUT 'http://localhost:9000/api/templates/1/default'
```

##### Example Response
Expand Down Expand Up @@ -213,7 +213,7 @@ Delete a template.
##### Example Request

```shell
curl -u "username:username" -X DELETE 'http://localhost:9000/api/templates/35'
curl -u "username:password" -X DELETE 'http://localhost:9000/api/templates/35'
```

##### Example Response
Expand Down
Loading