@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api UUID Generation API
@base https://api.fungenerators.com
@version 1.5
@auth ApiKey X-Fungenerators-Api-Secret in header
@endpoints 3
@toc uuid(3)

@endpoint GET /uuid
@desc Generate a random UUID (v4).
@optional {limit: int(integer) # Number of UUID's to generate (defaults to 1)}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint POST /uuid
@desc Parse a UUID string and return its version and check whether it is valid.
@required {uuidstr: str(string) # UUID String to parse}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /uuid/version/{version}
@desc Generate a random UUID (v4).
@required {version: int(integer) # Version of the UUID spec to use. (0-5), Use '0' for nil (00000000-0000-0000-0000-000000000000) UUID.}
@optional {limit: int(integer) # Number of UUID's to generate (defaults to 1), type: str(string) # For v3 and v5 of UUID Spec you can supply the type (dns/url/oid/x500/nil)., text: str(string) # For v3 and v5 of UUID Spec supply the text value for the type specified dns/url/oid/x500/nil. For example specify a dns/domain string if the type is "dns"}
@returns(200) 200  response
@errors {401: 401  response}

@end
