@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Shorten.REST API Documentation
@base https://api.shorten.rest
@version 1.0.0
@auth ApiKey x-api-key in header
@endpoints 6
@toc aliases(5), clicks(1)

@group aliases
@endpoint GET /aliases
@required {aliasName: any}
@optional {domainName: any}
@returns(200)

@endpoint POST /aliases
@required {alias: map}
@optional {domainName: any, aliasName: any}
@returns(200)

@endpoint PUT /aliases
@required {aliasName: any, alias: map}
@optional {domainName: any}
@returns(200)

@endpoint DELETE /aliases
@required {aliasName: any}
@optional {domainName: any}
@returns(200)

@endpoint GET /aliases/all
@optional {domainName: any, continueFrom: any, limit: any}
@returns(200)

@endgroup

@group clicks
@endpoint GET /clicks
@optional {continueFrom: any, limit: any}
@returns(200)

@endgroup

@end
