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

[DX-1437] Update api-def-common.md #5089

Merged
merged 1 commit into from
Jul 16, 2024
Merged

[DX-1437] Update api-def-common.md #5089

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
2 changes: 1 addition & 1 deletion tyk-docs/content/shared/api-def-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

* `name`: Human readable name of the API. It is used for identification purposes but does not act as an index.

* `slug`: The URL segment that will map to this API, e.g. if set to widgets then the full API URL will be `https://your-organisation.cloud.tyk.io/widgets`.
* `slug`: The URL segment that will map to this API, e.g. if set to widgets then the full API URL will be `https://your-organization.cloud.tyk.io/widgets`.

* `api_id`: The identifier for the API This should be unique, but can actually be any kind of string. For single-instance setups this can probably be set to `1`. It is recommended to make this a UUID. The `api_id` is used when querying the Tyk REST API for configuration details.

Expand Down
Loading