mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
3.8 KiB
3.8 KiB
| title |
|---|
| /api/admin/addons |
In order to access the admin API endpoints you need to identify yourself. Unless you're using the
noneauthentication method, you'll need to create an ADMIN token and add an Authorization header using the token.
List addons and providers
GET https://unleash.host.com/api/admin/addons
Returns a list of configured addons and available addon providers.
Example response:
{
"addons": [
{
"id": 30,
"provider": "webhook",
"enabled": true,
"description": "post updates to slack",
"parameters": {
"url": "http://localhost:4242/webhook"
},
"events": ["feature-created", "feature-updated"]
},
{
"id": 33,
"provider": "slack",
"enabled": true,
"description": "default",
"parameters": {
"defaultChannel": "integration-demo-instance",
"url": "https://hooks.slack.com/someurl"
},
"events": ["feature-created", "feature-updated"]
}
],
"providers": [
{
"name": "webhook",
"displayName": "Webhook",
"description": "Webhooks are a simple way to post messages from Unleash to third party services. Unleash make use of normal HTTP POST with a payload you may define yourself.",
"parameters": [
{
"name": "url",
"displayName": "Webhook URL",
"type": "url",
"required": true
},
{
"name": "bodyTemplate",
"displayName": "Body template",
"description": "You may format the body using a mustache template. If you don't specify anything, the format will be similar to the /api/admin/events format",
"type": "textfield",
"required": false
}
],
"events": [
"feature-created",
"feature-updated",
"feature-archived",
"feature-revived"
]
},
{
"name": "slack",
"displayName": "Slack",
"description": "Integrates Unleash with Slack.",
"parameters": [
{
"name": "url",
"displayName": "Slack webhook URL",
"type": "url",
"required": true
},
{
"name": "defaultChannel",
"displayName": "Default channel",
"description": "Default channel to post updates to if not specified in the slack-tag",
"type": "text",
"required": true
}
],
"events": [
"feature-created",
"feature-updated",
"feature-archived",
"feature-revived"
],
"tags": [
{
"name": "slack",
"description": "Slack tag used by the slack-addon to specify the slack channel.",
"icon": "S"
}
]
}
]
}
Create a new addon configuration
POST https://unleash.host.com/api/addons
Creates an addon configuration for an addon provider.
Body
{
"provider": "webhook",
"description": "Optional description",
"enabled": true,
"parameters": {
"url": "http://localhost:4242/webhook"
},
"events": ["feature-created", "feature-updated"]
}
Notes
providermust be a valid addon provider
Update new addon configuration
POST https://unleash.host.com/api/addons/:id
Updates an addon configuration.
Body
{
"provider": "webhook",
"description": "Optional updated description",
"enabled": true,
"parameters": {
"url": "http://localhost:4242/webhook"
},
"events": ["feature-created", "feature-updated"]
}
Notes
providercan not be changed.
Delete an addon configuration
DELETE https://unleash.host.com/api/admin/addons/:id
Deletes the addon with id=id.