Skip to content

Commit

Permalink
mention limitation on get and set wihtout attaching to topic first
Browse files Browse the repository at this point in the history
  • Loading branch information
or-else committed May 2, 2020
1 parent a246a06 commit 79a9f9d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -860,7 +860,7 @@ The unique message ID should be formed as `<topic_name>:<seqId>` whenever possib

#### `{get}`

Query topic for metadata, such as description or a list of subscribers, or query message history.
Query topic for metadata, such as description or a list of subscribers, or query message history. The requester must be [subscribed and attached](#sub) to the topic to receive the full response. Some limited `desc` and `sub` information is available without being attached.

```js
get: {
Expand Down Expand Up @@ -915,6 +915,8 @@ get: {
Query topic description. Server responds with a `{meta}` message containing requested data. See `{meta}` for details.
If `ims` is specified and data has not been updated, the message will skip `public` and `private` fields.

Limited information is available without [attaching](#sub) to topic first.

See [Public and Private Fields](#public-and-private-fields) for `private` and `public` format considerations.

* `{get what="sub"}`
Expand All @@ -923,6 +925,8 @@ Get a list of subscribers. Server responds with a `{meta}` message containing a
For `me` topic the request returns a list of user's subscriptions. If `ims` is specified and data has not been updated,
responds with a `{ctrl}` "not modified" message.

Only user's own subscription is returned without [attaching](#sub) to topic first.

* `{get what="tags"}`

Query indexed tags. Server responds with a `{meta}` message containing an array of string tags. See `{meta}` and `fnd` topic for details.
Expand All @@ -943,7 +947,7 @@ Query [credentials](#credentail-validation). Server responds with a `{meta}` mes

#### `{set}`

Update topic metadata, delete messages or topic.
Update topic metadata, delete messages or topic. The requester is generally expected to be [subscribed and attached](#sub) to the topic. Only `desc.private` and requester's `sub.mode` can be updated without attaching first.

```js
set: {
Expand Down

0 comments on commit 79a9f9d

Please sign in to comment.