Skip to content

Commit

Permalink
Import config/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lghiur authored and dcs3spp committed Aug 14, 2024
1 parent bc34a9e commit 772e44f
Show file tree
Hide file tree
Showing 3 changed files with 176 additions and 144 deletions.
14 changes: 13 additions & 1 deletion tyk-docs/assets/others/dashboard-swagger.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: Tyk Dashboard API
version: 5.3.0
version: 5.3.3
description: |-
## <a name="introduction"></a> Introduction
Expand Down Expand Up @@ -60,6 +60,8 @@ tags:
description: Organisations Management
- name: System
description: System API
- name: Assets
description: Assets management
paths:
/api/portal/policies/:
get:
Expand Down Expand Up @@ -2616,6 +2618,8 @@ paths:
message: Stats not found
/api/assets:
get:
tags:
- Assets
summary: Retrieve list of assets
description: Retrieves all types of assets with optional kind filter.
parameters:
Expand Down Expand Up @@ -2657,6 +2661,8 @@ paths:
code: 500
message: something went wrong
post:
tags:
- Assets
summary: Create an asset
description: Create a new asset.
requestBody:
Expand Down Expand Up @@ -2697,6 +2703,8 @@ paths:

/api/assets/{assetID}:
get:
tags:
- Assets
summary: Retrieve an asset.
description: Retrieve an asset by ID.
parameters:
Expand Down Expand Up @@ -2737,6 +2745,8 @@ paths:
code: 500
message: "error fetching asset: 'my-custom-asset'"
put:
tags:
- Assets
summary: Update an asset by ID.
description: Update an existing asset.
parameters:
Expand Down Expand Up @@ -2816,6 +2826,8 @@ paths:
code: 500
message: something went wrong
delete:
tags:
- Assets
summary: Delete an asset by ID.
description: Remove an asset ID.
parameters:
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/shared/gateway-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ Type: `bool`<br />

Disable the capability of the Gateway to `autodiscover` the Dashboard through heartbeat messages via Redis.
The goal of zeroconf is auto-discovery, so you do not have to specify the Tyk Dashboard address in your Gateway`tyk.conf` file.
In some specific cases, for example, when the Dashboard is bound to a public domain, not accessible inside an internal network, or similar, `disable_dashboard_zeroconf` can be set to `true`, in favor of directly specifying a Tyk Dashboard address.
In some specific cases, for example, when the Dashboard is bound to a public domain, not accessible inside an internal network, or similar, `disable_dashboard_zeroconf` can be set to `true`, in favour of directly specifying a Tyk Dashboard address.

### slave_options
The `slave_options` allow you to configure the RPC slave connection required for MDCB installations.
Expand Down
Loading

0 comments on commit 772e44f

Please sign in to comment.