typesense-website icon indicating copy to clipboard operation
typesense-website copied to clipboard

Please add more detail about "expires_at" parameter

Open davidshen84 opened this issue 3 years ago • 0 comments

Description

The description of the expires_at parameter for the Creating an API KEY is not very clear. The parameter is optional on the interface level but is actually required. Because all keys have an expires_at property attached and if the parameter is not provided when creating an API key, a default timestamp is provided. This behaviour is not mentioned in the document.

Steps to reproduce

Create a new API key without providing the expires_at parameter.

Expected Behavior

The default expires_at value in the response should be documented.

Actual Behavior

A default expires_at value is added for the key

Metadata

Typsense Version: 0.23

OS: Ubuntu

davidshen84 avatar Jul 08 '22 05:07 davidshen84