Skip to content

Commit

Permalink
Client library does not need to apply defaults
Browse files Browse the repository at this point in the history
When versioning is implemented, it will ensure that the REST API provides consistent defaults
  • Loading branch information
mattheworiordan committed Nov 20, 2015
1 parent cfcd285 commit ab8307b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions content/client-lib-development-guide/features.textile
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ h3(#rest-auth). Auth
** @(RSA15a)@ Any @clientId@ provided in @ClientOptions@ must match any non wildcard (@'*'@) @clientId@ value in @TokenDetails@ or @connectionDetails@ of the @CONNECTED@ @ProtocolMessage@, where applicable
** @(RSA15b)@ If the @clientId@ from @TokenDetails@ or @connectionDetails@ contains only a wildcard string @'*'@, then the client is permitted to be either unauthenticated (i.e. anonymous without a @clientId@) or authenticated by providing a @clientId@ when communicating with Ably
** @(RSA15c)@ Following an auth request which uses a @TokenDetails@ or @TokenRequest@ object that contains an incompatible @clientId@, the library should in the case of Realtime change the connection state to @FAILED@ and emit an error, and in the case of REST raise an exception
* @(RSA5)@ TTL for new tokens is specified in milliseconds (default is 1 hour, see "TK2a":#TK2a)
* @(RSA6)@ The @capability@ for new tokens is JSON stringified (defaults to allow all @{"*":["*"]}@, see "TK2b":#TK2b)
* @(RSA5)@ TTL for new tokens is specified in milliseconds (REST API default is 1 hour, see "TK2a":#TK2a)
* @(RSA6)@ The @capability@ for new tokens is JSON stringified (REST API default is allow all @{"*":["*"]}@, see "TK2b":#TK2b)
* @(RSA7)@ @clientId@ and authenticated clients:
** @(RSA7a)@ If a @clientId@ is provided in the @ClientOptions@, or is present in the current authentication token, then the client is considered to be authenticated (it has a @clientId@ that is implicit in all operations). Note that an authentication token @clientId@ wildcard value of @'*'@ is the exception where the client is not necessarily authenticated and any @clientId@ is permitted. The following applies to authenticated clients:
*** @(RSA7a1)@ All operations (such as message publishing or presence) will have an implicit @clientId@. The Ably service automatically updates the @clientId@ attribute (when empty) for all @Message@ and @PresenceMessage@ messages received from that authenticated client, and any messages then published from the Ably service, will have the @clientId@ attribute populated. It is therefore expected that Ably client libraries do not explicitly set the @clientId@ field on messages published when @clientId@ is implicit in the connection or authentication scheme
Expand Down Expand Up @@ -648,8 +648,8 @@ h4. ClientOptions
h4(#token-params). TokenParams
* @(TK1)@ A class providing parameters of a token request. These params are used when invoking @Auth#authorise@, @Auth#requestToken@ and @Auth#createTokenRequest@
* @(TK2)@ The attributes of @TokenParams@ consist of:
* @(TK2a)@ @ttl@ long - Requested time to live for the token in milliseconds. The default set by the client library is 60 minutes
* @(TK2b)@ @capability@ string - Capability requirements JSON stringified for the token. The default set by the client library allows all operations with the string value @{"*":["*"]}@
* @(TK2a)@ @ttl@ long - Requested time to live for the token in milliseconds. When omitted, the REST API default of 60 minutes is applied by Ably
* @(TK2b)@ @capability@ string - Capability requirements JSON stringified for the token. When omitted, the REST API default to allow all operations is applied by Ably, with the string value @{"*":["*"]}@
* @(TK2c)@ @clientId@ string - A @clientId@ string to associate with this token. If @clientId@ is @null@ or omitted, then the token is prohibited from assuming a @clientId@ in any operations, however if @clientId@ is a wildcard string @'*'@, then the token is permitted to assume any @clientId@. Any other string value for @clientId@ implies that the @clientId@ is both enforced and assumed for all operations for this token
* @(TK2d)@ @timestamp@ long - The timestamp (in milliseconds since the epoch) of this request. Timestamps, in conjunction with the @nonce@, are used to prevent requests from being replayed

Expand Down

0 comments on commit ab8307b

Please sign in to comment.