Skip to content

Commit

Permalink
docs(admin-api) add name or id in supported routes
Browse files Browse the repository at this point in the history
targets: delete by id
api specific plugins: delete/patch by plugin name

From #407
  • Loading branch information
Tieske authored and thibaultcha committed Apr 28, 2017
1 parent 8f3acb1 commit 7ee12ef
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions app/docs/0.10.x/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -938,12 +938,12 @@ HTTP 200 OK

#### Endpoint

<div class="endpoint patch">/apis/{api name or id}/plugins/{id}</div>
<div class="endpoint patch">/apis/{api name or id}/plugins/{plugin name or id}</div>

Attributes | Description
---:| ---
`api name or id`<br>**required** | The unique identifier **or** the name of the API for which to update the plugin configuration
`id`<br>**required** | The unique identifier of the plugin configuration to update on this API
`plugin name or id`<br>**required** | The unique identifier **or** the name of the plugin configuration to update on this API

#### Request Body

Expand Down Expand Up @@ -1002,12 +1002,12 @@ See POST and PATCH responses.

#### Endpoint

<div class="endpoint delete">/apis/{api name or id}/plugins/{id}</div>
<div class="endpoint delete">/apis/{api name or id}/plugins/{plugin name or id}</div>

Attributes | Description
---:| ---
`api name or id`<br>**required** | The unique identifier **or** the name of the API for which to delete the plugin configuration
`id`<br>**required** | The unique identifier of the plugin configuration to delete on this API
`plugin name or id`<br>**required** | The unique identifier **or** the name of the plugin configuration to delete on this API

#### Response

Expand Down Expand Up @@ -1863,12 +1863,12 @@ a new entry for the given target definition with a `weight` of 0.

#### Endpoint

<div class="endpoint delete">/upstreams/{name or id}/targets/{target}</div>
<div class="endpoint delete">/upstreams/{upstream name or id}/targets/{target or id}</div>

Attributes | Description
---:| ---
`name or id`<br>**required** | The unique identifier **or** the name of the upstream for which to delete the target.
`target`<br>**required** | The host/port combination element of the target to remove.
`upstream name or id`<br>**required** | The unique identifier **or** the name of the upstream for which to delete the target.
`target or id`<br>**required** | The host/port combination element of the target to remove, or the `id` of an existing target entry.

#### Response

Expand Down

0 comments on commit 7ee12ef

Please sign in to comment.