Skip to content
This repository has been archived by the owner on Apr 29, 2020. It is now read-only.

Commit

Permalink
Added a time format
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Feb 18, 2016
1 parent b26beca commit f1d026b
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -1828,22 +1828,13 @@ Publish an object to IPNS.
#### Bugs

- The `lifetime` option does not appear to work as documented. See https://github.com/ipfs/go-ipfs/issues/2312.
- ttl format is not specified.

+ Parameters
+ arg (string, required) - IPFS path of the object to be published. Default: your own identity public key.
+ resolve (boolean, optional) - Resolve given path before publishing
+ Default: `true`
+ lifetime (enum[string], optional) - Time duration that the record will be valid for. This accepts durations such as '300s', '1.5h' or '2h45m'.
+ Members
+ Default: `24hrs`
+ ns
+ us - Or 'µs'.
+ ms
+ s
+ m
+ h
+ ttl (string, optional) - Time duration this record should be cached for. Caution: experimental.
+ lifetime (time, optional) - Time duration that the record will be valid for. Default: 24h.
+ ttl (time, optional) - Time duration this record should be cached for. Caution: experimental.

+ Request Without Arguments

Expand Down Expand Up @@ -2806,6 +2797,20 @@ The IPFS error object
+ `0`
+ `1`

## Time (string)

The time format used in some commands.

+ (enum[string]) - The time format.

This comment has been minimized.

Copy link
@dignifiedquire

dignifiedquire Feb 19, 2016

Collaborator

Is enum the right type, isn't this valid as well 25h2m?

This comment has been minimized.

Copy link
@RichardLitt

RichardLitt Feb 19, 2016

Author Contributor

This comment has been minimized.

Copy link
@hackergrrl

hackergrrl Feb 19, 2016

@dignifiedquire is right: I would classify Time as a string.

+ Default: `24h`
+ Members
+ `ns`
+ `us` - Or `µs`.
+ `ms`
+ `s`
+ `m`
+ `h`

## ndjson (object)

Newline delimited JSON
Expand Down

0 comments on commit f1d026b

Please sign in to comment.