Skip to content

Commit

Permalink
chore: update api reference
Browse files Browse the repository at this point in the history
  • Loading branch information
@stfsy
stfsy committed Jan 30, 2023
1 parent 2d47f63 commit 7cac8fa
Show file tree
Hide file tree
Showing 7 changed files with 741 additions and 19 deletions.
23 changes: 22 additions & 1 deletion docs/api-reference/organizations/create-an-api-client.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ curl -X POST http://api.discue.io/v1/api_clients \
-H 'Accept: application/json' \
-H 'X-API-KEY: API_KEY' \
-d '{
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
}'
```
Expand All @@ -55,6 +56,7 @@ curl -X POST http://api.discue.io/v1/api_clients \

```javascript
const body = {
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
}

Expand Down Expand Up @@ -123,6 +125,7 @@ func main() {

```json
{
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
}
```
Expand All @@ -133,9 +136,27 @@ func main() {
|pretty|query|boolean| ❌ |Return the response pretty printed|
|body|body|[ApiClient](#schemaapiclient)| ❌ |none|
|» name|body|string| ❌ |none|
|» id|body|[ResourceId](#resourceid)| ❌ |none|

## Responses

::: tip 200 Response
:::

```json
{
"api_client": {
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
},
"_links": {
"self": {
"href": "https://api.discue.io/api_clients/5bc2be68-7498-4853-aa64-4be0ca62934e"
}
}
}
```

::: tip 400 Response
:::

Expand Down Expand Up @@ -288,7 +309,7 @@ func main() {

|Status|Meaning|Description|Schema|
|---|---|---|---|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|None|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ok|[CreateApiClientResponse](#createapiclientresponse)|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|402|[Payment Required](https://tools.ietf.org/html/rfc7231#section-6.5.2)|Payment Required|Inline|
Expand Down
328 changes: 328 additions & 0 deletions docs/api-reference/organizations/update-an-api-client.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,328 @@
---
title: discue scheduling and queueing API v0.1.0
language_tabs:
- shell: curl
- javascript: JavaScript
- python: Python
- go: Go
toc_footers: []
includes: []
api:
method: put
path: /api_clients/{api_client_id}
name: Update an api client

---

# Update an api client

<p class="text-lg">
<span class="font-medium">PUT</span> /api_clients/{api_client_id}
</p>

**Update an api client**.

<Badge type="get" text="Info" vertical="middle"/> In this context an api client and an organization can be used synonymously.

::: tip Authentication
**The target organization for this request will be determined by the supplied access token.**

As a prerequisite you need to **[create an account](https://www.discue.io/registration/create-account)** and follow
the onboarding process to also **create an organizatio**n and **an API key**.

See also: [Authentication](/getting-started/#prerequisites).
:::

## Examples
<CodeGroup><CodeGroupItem title="shell">

```shell
curl -X PUT http://api.discue.io/v1/api_clients/{api_client_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: API_KEY' \
-d '{
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
}'
```

</CodeGroupItem>

<CodeGroupItem title="javascript">

```javascript
const body = {
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
}

const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-API-KEY':'API_KEY'
}

const response = await fetch('http://api.discue.io/v1/api_clients/{api_client_id}', {
method: 'PUT', body, headers
})

const body = await response.json()
```

</CodeGroupItem>

<CodeGroupItem title="python">

```python
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-API-KEY': 'API_KEY'
}

r = requests.put('http://api.discue.io/v1/api_clients/{api_client_id}', headers = headers)
```

</CodeGroupItem>

<CodeGroupItem title="go">

```go
package main

import (
"bytes"
"net/http"
)

func main() {

headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-API-KEY": []string{"API_KEY"},
}

data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "http://api.discue.io/v1/api_clients/{api_client_id}", data)
req.Header = headers

client := &http.Client{}
resp, err := client.Do(req)
}
```

</CodeGroupItem>

</CodeGroup>

## Body

```json
{
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
}
```

## Parameters
|Name|In|Type|Required|Description|
|---|---|---|---|---|
|api_client_id|path|string(uuid)|✔|none|
|pretty|query|boolean| ❌ |Return the response pretty printed|
|body|body|[ApiClient](#schemaapiclient)| ❌ |none|
|» name|body|string| ❌ |none|
|» id|body|[ResourceId](#resourceid)| ❌ |none|

## Responses

::: tip 200 Response
:::

```json
{
"api_client": {
"id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
"name": "example.com/dev"
},
"_links": {
"self": {
"href": "https://api.discue.io/api_clients/5bc2be68-7498-4853-aa64-4be0ca62934e"
}
}
}
```

::: tip 400 Response
:::

```json
{
"title": "Bad Request",
"status": 400
}
```

::: tip 401 Response
:::

```json
{
"title": "Unauthorized",
"status": 401
}
```

::: tip 402 Response
:::

```json
{
"title": "Payment Required",
"status": 402
}
```

::: tip 403 Response
:::

```json
{
"title": "Forbidden",
"status": 403
}
```

::: tip 404 Response
:::

```json
{
"title": "Not Found",
"status": 404
}
```

::: tip 405 Response
:::

```json
{
"title": "Method Not Allowed",
"status": 405
}
```

::: tip 406 Response
:::

```json
{
"title": "Not Acceptable",
"status": 406
}
```

::: tip 409 Response
:::

```json
{
"title": "Conflict",
"status": 409
}
```

::: tip 415 Response
:::

```json
{
"title": "Unsupported Media Type",
"status": 415
}
```

::: tip 422 Response
:::

```json
{
"title": "Unprocessable Entity",
"status": 422
}
```

::: tip 423 Response
:::

```json
{
"title": "Locked",
"status": 423
}
```

::: tip 429 Response
:::

```json
{
"title": "Too Many Requests",
"status": 429
}
```

::: tip 500 Response
:::

```json
{
"title": "Internal Server Error",
"status": 500
}
```

::: tip 501 Response
:::

```json
{
"title": "Not Implemented",
"status": 501
}
```

::: tip 503 Response
:::

```json
{
"title": "Service Unavailable",
"status": 503
}
```

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ok|[CreateApiClientResponse](#createapiclientresponse)|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|402|[Payment Required](https://tools.ietf.org/html/rfc7231#section-6.5.2)|Payment Required|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|Inline|
|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|Inline|
|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|Inline|
|415|[Unsupported Media Type](https://tools.ietf.org/html/rfc7231#section-6.5.13)|Unsupported Media Type|Inline|
|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|Unprocessable Entity|Inline|
|423|[Locked](https://tools.ietf.org/html/rfc2518#section-10.4)|Locked|Inline|
|429|[Too Many Requests](https://tools.ietf.org/html/rfc6585#section-4)|Too Many Requests|Inline|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|Inline|
|501|[Not Implemented](https://tools.ietf.org/html/rfc7231#section-6.6.2)|Not Implemented|Inline|
|503|[Service Unavailable](https://tools.ietf.org/html/rfc7231#section-6.6.4)|Service Unavailable|Inline|

---

Loading

0 comments on commit 7cac8fa

Please sign in to comment.