Created action to get mercure integration info

docs/swagger/definitions/MercureInfo.json

@@ -0,0 +1,18 @@
+{
+    "type": "object",
+    "required": ["mercureHubUrl", "jwt", "jwtExpiration"],
+    "properties": {
+        "mercureHubUrl": {
+            "type": "string",
+            "description": "The public URL of the mercure hub that can be used to get real-time updates published by Shlink"
+        },
+        "jwt": {
+            "type": "string",
+            "description": "A JWT with subscribe permissions which is valid with the mercure hub"
+        },
+        "jwtExpiration": {
+            "type": "string",
+            "description": "The date (in ISO-8601 format) in which the JWT will expire"
+        }
+    }
+}

docs/swagger/paths/v2_mercure-info.json

@@ -0,0 +1,67 @@
+{
+    "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"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "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": {
+                    "application/json": {
+                        "title": "Mercure integration not configured",
+                        "type": "MERCURE_NOT_CONFIGURED",
+                        "detail": "This Shlink instance is not integrated with a mercure hub.",
+                        "status": 501
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/swagger.json

@@ -82,6 +82,10 @@
             "$ref": "paths/v1_short-urls_{shortCode}_visits.json"
         },
 
+        "/rest/v{version}/mercure-info": {
+            "$ref": "paths/v2_mercure-info.json"
+        },
+
         "/rest/health": {
             "$ref": "paths/health.json"
         },