{"note":"OpenAPI conversion -- returning structured metadata","name":"mercure-local","description":"The Mercure protocol","version":"1.0.0","base_url":"","endpoints":6,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api The Mercure protocol\n@version 1.0.0\n@auth Bearer bearer | ApiKey mercure_access_token in cookie\n@endpoints 6\n@toc .well-known(6)\n\n@endpoint GET /.well-known/mercure\n@desc Subscribe to updates\n@optional {match: [str] # Exact topic matcher (the default matcher type). Repeatable. Case-sensitive. At least one matcher parameter is required., match_urlpattern: [str] # URL Pattern topic matcher (WHATWG URL Pattern). Repeatable., last_event_id: str # The last received event id, to retrieve missed events., Last-Event-ID: str # The last received event id, to retrieve missed events, takes precedence over the query parameter.}\n@returns(200) Event stream opened.\n@errors {400: Missing or invalid topic matcher parameter., 401: Missing or invalid access token. Carries a `WWW-Authenticate: Bearer` challenge (with `error=\"invalid_token\"` when a token was presented but failed validation) and, per RFC 9728, a `resource_metadata` parameter pointing to the protected resource metadata document.}\n\n@endpoint POST /.well-known/mercure\n@desc Publish an update\n@returns(200) The id of this update\n@errors {400: Invalid request, 401: Missing or invalid access token. Carries a `WWW-Authenticate: Bearer` challenge (with `error=\"invalid_token\"` when a token was presented but failed validation) and, per RFC 9728, a `resource_metadata` parameter pointing to the protected resource metadata document., 403: The access token is valid but does not grant the requested action on the topic. Carries a `WWW-Authenticate: Bearer` challenge with `error=\"insufficient_scope\"` (RFC 6750).}\n\n@endpoint GET /.well-known/oauth-protected-resource/.well-known/mercure\n@desc OAuth 2.0 protected resource metadata\n@returns(200) {resource: str(uri), bearer_methods_supported: [str], authorization_servers: [str], authorization_details_types_supported: [str], mercure_cookie: str, mercure_subscriptions: bool} # The protected resource metadata document\n\n@endpoint GET /.well-known/mercure/subscriptions\n@desc Active subscriptions\n@returns(200) {id: str(iri-reference), type: str, last_event_id: str, subscriptions: [map]} # The list of active subscriptions\n@errors {401: Missing or invalid access token. Carries a `WWW-Authenticate: Bearer` challenge (with `error=\"invalid_token\"` when a token was presented but failed validation) and, per RFC 9728, a `resource_metadata` parameter pointing to the protected resource metadata document., 403: The access token is valid but does not grant the requested action on the topic. Carries a `WWW-Authenticate: Bearer` challenge with `error=\"insufficient_scope\"` (RFC 6750).}\n\n@endpoint GET /.well-known/mercure/subscriptions/{match_type}/{match}\n@desc Active subscriptions for the given topic matcher\n@required {match_type: str # The matcher type (e.g. exact, urlpattern)., match: str # The percent-encoded topic matcher.}\n@returns(200) {id: str(iri-reference), type: str, last_event_id: str, subscriptions: [map]} # The list of active subscriptions\n@errors {401: Missing or invalid access token. Carries a `WWW-Authenticate: Bearer` challenge (with `error=\"invalid_token\"` when a token was presented but failed validation) and, per RFC 9728, a `resource_metadata` parameter pointing to the protected resource metadata document., 403: The access token is valid but does not grant the requested action on the topic. Carries a `WWW-Authenticate: Bearer` challenge with `error=\"insufficient_scope\"` (RFC 6750).}\n\n@endpoint GET /.well-known/mercure/subscriptions/{match_type}/{match}/{subscriber}\n@desc Active subscription for the given matcher and subscriber\n@required {match_type: str # The matcher type (e.g. exact, urlpattern)., match: str # The percent-encoded topic matcher., subscriber: str}\n@returns(200) {id: str(iri-reference), type: str, last_event_id: str, subscriptions: [map]} # The list of active subscriptions\n@errors {401: Missing or invalid access token. Carries a `WWW-Authenticate: Bearer` challenge (with `error=\"invalid_token\"` when a token was presented but failed validation) and, per RFC 9728, a `resource_metadata` parameter pointing to the protected resource metadata document., 403: The access token is valid but does not grant the requested action on the topic. Carries a `WWW-Authenticate: Bearer` challenge with `error=\"insufficient_scope\"` (RFC 6750).}\n\n@end\n"}