{"note":"OpenAPI conversion -- returning structured metadata","name":"shorten-rest","description":"Shorten.REST API Documentation","version":"1.0.0","base_url":"https://api.shorten.rest","endpoints":6,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Shorten.REST API Documentation\n@base https://api.shorten.rest\n@version 1.0.0\n@auth ApiKey x-api-key in header\n@endpoints 6\n@toc aliases(5), clicks(1)\n\n@group aliases\n@endpoint GET /aliases\n@desc Get alias\n@required {aliasName: any # alias value (without `/` at the beginning)}\n@optional {domainName: any # domain which alias belongs to (string without `http/https` or `/`)}\n@returns(200) Alias model or **null**\n\n@endpoint POST /aliases\n@desc Create alias\n@required {alias: map # alias properties}\n@optional {domainName: any # domain which alias will belong to (string without `http/https` or `/`), aliasName: any # alias (without `/` at the beginning)}\n@returns(200) Response contains aliasName, domainName and full generated short link\n\n@endpoint PUT /aliases\n@desc Update alias\n@required {aliasName: any # alias (without `/` at the beginning), alias: map # alias properties you wish to be updated}\n@optional {domainName: any # domain which alias belongs to (string without `http/https` or `/`)}\n@returns(200) Empty response\n\n@endpoint DELETE /aliases\n@desc Delete alias\n@required {aliasName: any # alias (without `/` at the beginning)}\n@optional {domainName: any # domain which alias belongs to (string without `http/https` or `/`)}\n@returns(200) Empty response\n\n@endpoint GET /aliases/all\n@desc Get aliases by domain\n@optional {domainName: any # The domain name to get the aliases for (string without `http/https` or `/`), continueFrom: any # An ID returned by a previous query to continue aliases retrieval (see lastId in response), limit: any # Number of results to return per request}\n@returns(200) returns Array of aliases with lastId\n\n@endgroup\n\n@group clicks\n@endpoint GET /clicks\n@desc Get clicks\n@optional {continueFrom: any # An ID returned by a previous query to continue clicks retrieval (see lastId in response), limit: any # Number of results to return per request}\n@returns(200) returns Array of Click models, also returns lastId\n\n@endgroup\n\n@end\n"}