fix(invocation): also update docs and examples
This commit is contained in:
@@ -34,7 +34,7 @@ func ExampleNew() {
|
|||||||
invocation.WithMeta("env", "development"),
|
invocation.WithMeta("env", "development"),
|
||||||
invocation.WithMeta("tags", meta["tags"]),
|
invocation.WithMeta("tags", meta["tags"]),
|
||||||
invocation.WithExpirationIn(time.Minute),
|
invocation.WithExpirationIn(time.Minute),
|
||||||
invocation.WithoutInvokedAt())
|
invocation.WithoutIssuedAt())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Println("failed to create invocation:", err.Error())
|
fmt.Println("failed to create invocation:", err.Error())
|
||||||
|
|
||||||
|
|||||||
@@ -66,9 +66,9 @@ type Token struct {
|
|||||||
// WithNonce or WithEmptyNonce options to specify provide your own nonce
|
// WithNonce or WithEmptyNonce options to specify provide your own nonce
|
||||||
// or to leave the nonce empty respectively.
|
// or to leave the nonce empty respectively.
|
||||||
//
|
//
|
||||||
// If no invokedAt is provided, the current time is used. Use the
|
// If no IssuedAt is provided, the current time is used. Use the
|
||||||
// WithInvokedAt or WithInvokedAtIn Options to specify a different time
|
// IssuedAt or WithIssuedAtIn Options to specify a different time
|
||||||
// or the WithoutInvokedAt Option to clear the Token's invokedAt field.
|
// or the WithoutIssuedAt Option to clear the Token's IssuedAt field.
|
||||||
//
|
//
|
||||||
// With the exception of the WithMeta option, all others will overwrite
|
// With the exception of the WithMeta option, all others will overwrite
|
||||||
// the previous contents of their target field.
|
// the previous contents of their target field.
|
||||||
@@ -315,7 +315,7 @@ func tokenFromModel(m tokenPayloadModel) (*Token, error) {
|
|||||||
|
|
||||||
tkn.issuedAt, err = parse.OptionalTimestamp(m.Iat)
|
tkn.issuedAt, err = parse.OptionalTimestamp(m.Iat)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("parse invokedAt: %w", err)
|
return nil, fmt.Errorf("parse IssuedAt: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
tkn.cause = m.Cause
|
tkn.cause = m.Cause
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ func TestSealUnsealRoundtrip(t *testing.T) {
|
|||||||
invocation.WithMeta("env", "development"),
|
invocation.WithMeta("env", "development"),
|
||||||
invocation.WithMeta("tags", meta["tags"]),
|
invocation.WithMeta("tags", meta["tags"]),
|
||||||
invocation.WithExpirationIn(time.Minute),
|
invocation.WithExpirationIn(time.Minute),
|
||||||
invocation.WithoutInvokedAt(),
|
invocation.WithoutIssuedAt(),
|
||||||
)
|
)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
|||||||
@@ -123,12 +123,12 @@ func WithExpirationIn(after time.Duration) Option {
|
|||||||
return WithExpiration(time.Now().Add(after))
|
return WithExpiration(time.Now().Add(after))
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithInvokedAt sets the Token's invokedAt field to the provided
|
// WithIssuedAt sets the Token's IssuedAt field to the provided
|
||||||
// time.Time.
|
// time.Time.
|
||||||
//
|
//
|
||||||
// If this Option is not provided, the invocation Token's iat field will
|
// If this Option is not provided, the invocation Token's iat field will
|
||||||
// be set to the value of time.Now(). If you want to create an invocation
|
// be set to the value of time.Now(). If you want to create an invocation
|
||||||
// Token without this field being set, use the WithoutInvokedAt Option.
|
// Token without this field being set, use the WithoutIssuedAt Option.
|
||||||
func WithIssuedAt(iat time.Time) Option {
|
func WithIssuedAt(iat time.Time) Option {
|
||||||
return func(t *Token) error {
|
return func(t *Token) error {
|
||||||
t.issuedAt = &iat
|
t.issuedAt = &iat
|
||||||
@@ -137,13 +137,13 @@ func WithIssuedAt(iat time.Time) Option {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithInvokedAtIn sets the Token's invokedAt field to Now() plus the
|
// WithIssuedAtIn sets the Token's IssuedAt field to Now() plus the
|
||||||
// given duration.
|
// given duration.
|
||||||
func WithInvokedAtIn(after time.Duration) Option {
|
func WithIssuedAtIn(after time.Duration) Option {
|
||||||
return WithInvokedAt(time.Now().Add(after))
|
return WithIssuedAt(time.Now().Add(after))
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithoutInvokedAt clears the Token's invokedAt field.
|
// WithoutIssuedAt clears the Token's IssuedAt field.
|
||||||
func WithoutIssuedAt() Option {
|
func WithoutIssuedAt() Option {
|
||||||
return func(t *Token) error {
|
return func(t *Token) error {
|
||||||
t.issuedAt = nil
|
t.issuedAt = nil
|
||||||
|
|||||||
Reference in New Issue
Block a user