Document multi-part ids #119
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@kylebernhardy just wanted to verify that this is what you were looking for. |
jcohen-hdb
reviewed
Sep 24, 2024
docs/developers/real-time.md
Outdated
| @@ -56,6 +56,8 @@ HarperDB supports QoS 0 and 1 for publishing and subscribing. | |||
|
|
|||
| HarperDB supports multi-level topics, both for subscribing and publishing. HarperDB also supports multi-level wildcards, so you can subscribe to /`my-resource/#` to receive notifications for `my-resource/some-id` as well as `my-resource/nested/id`, or you can subscribe to `my-resource/nested/#` and receive the latter, but not the former, topic messages. HarperDB currently only supports trailing multi-level wildcards (no single-level wildcards with '\*'). | |||
|
|
|||
| When using nested topics, these are translated to multipart ids. The primary key/id for `my-resource/nested/id` would be `["nested","id]` in the database. This allows for a simple and effective way to manage nested topics and subscriptions. See the [Resource API](../technical-details/reference/resource.md) for more information about how define resources and interact with them and reference by primary keys. | |||
There was a problem hiding this comment.
["nested","id] looks like it's missing a quote at the end.
docs/developers/rest.md
Outdated
| PUT /Product/electronics/123 | ||
| Content-Type: application/json | ||
|
|
||
| { "id": ["electronics", "123"], name": "An electronic product" } |
There was a problem hiding this comment.
name": is missing an opening quote
Co-authored-by: Ethan Arrowood <[email protected]>
Co-authored-by: Ethan Arrowood <[email protected]>
Ethan-Arrowood
approved these changes
Sep 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.