mirror of
https://github.com/shlinkio/shlink.git
synced 2024-12-24 16:10:38 -06:00
76 lines
3.0 KiB
JSON
76 lines
3.0 KiB
JSON
{
|
|
"get": {
|
|
"operationId": "mercureInfo",
|
|
"tags": [
|
|
"Integrations"
|
|
],
|
|
"summary": "Get mercure integration info",
|
|
"description": "Returns information to consume updates published by Shlink on a mercure hub. https://mercure.rocks/",
|
|
"parameters": [
|
|
{
|
|
"$ref": "../parameters/version.json"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"ApiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The mercure integration info",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "../definitions/MercureInfo.json"
|
|
},
|
|
"example": {
|
|
"mercureHubUrl": "https://example.com/.well-known/mercure",
|
|
"jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJTaGxpbmsiLCJpYXQiOjE1ODY2ODY3MzIsImV4cCI6MTU4Njk0NTkzMiwibWVyY3VyZSI6eyJzdWJzY3JpYmUiOltdfX0.P-519lgU7dFz0bbNlRG1CXyqugGbaHon4kw6fu4QBdQ",
|
|
"jwtExpiration": "2020-04-15T12:18:52+02:00"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"501": {
|
|
"description": "This Shlink instance is not integrated with a mercure hub",
|
|
"content": {
|
|
"application/problem+json": {
|
|
"schema": {
|
|
"$ref": "../definitions/Error.json"
|
|
},
|
|
"examples": {
|
|
"API v3 and newer": {
|
|
"value": {
|
|
"title": "Mercure integration not configured",
|
|
"type": "https://shlink.io/api/error/mercure-not-configured",
|
|
"detail": "This Shlink instance is not integrated with a mercure hub.",
|
|
"status": 501
|
|
}
|
|
},
|
|
"Previous to API v3": {
|
|
"value": {
|
|
"title": "Mercure integration not configured",
|
|
"type": "MERCURE_NOT_CONFIGURED",
|
|
"detail": "This Shlink instance is not integrated with a mercure hub.",
|
|
"status": 501
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Unexpected error.",
|
|
"content": {
|
|
"application/problem+json": {
|
|
"schema": {
|
|
"$ref": "../definitions/Error.json"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|