feat: refactor dictionary cache page to new style #1144
Conversation
| - **Cache error**: | ||
| - See [response objects](./response-objects.md) for specific information. |
There was a problem hiding this comment.
For the errors, maybe you can link directly to the error response object section directly instead of "see _ for specific information"?
| - **Cache error**: | |
| - See [response objects](./response-objects.md) for specific information. | |
| - **Cache error**: | |
| - [Error response object](./response-objects#error) for specific information. |
| #### Returns | ||
| ---------------- | ||
| One of the following: | ||
| - **Success**: |
There was a problem hiding this comment.
nit: I think responses with no corresponding methods don't need the extra : at the end
| - **Success**: | |
| - **Success** |
|
|
||
| #### Returns | ||
| ---------------- | ||
| The response object for DictionaryFetch returns three possible options, a cache hit, miss, or an error.: |
There was a problem hiding this comment.
nit: some weird punctuation
| The response object for DictionaryFetch returns three possible options, a cache hit, miss, or an error.: | |
| The response object for DictionaryFetch returns three possible options, a cache hit, miss, or an error: |
| Get one or more fields from a dictionary in the cache. | ||
| #### Returns | ||
| ---------------- | ||
| The response object for DictionaryFetch returns three possible options, a cache hit, miss, or an error.: |
There was a problem hiding this comment.
I think I like "One of the following:" better for the short description under the "Returns" headers.
Currently seeing some mixed usage of that and "the response object for _ returns _"
| - **Cache miss**: | ||
| - `fieldString()`: String | ||
| - `fieldBytes()`: Bytes |
There was a problem hiding this comment.
I don't think a miss returns anything?
| - **Cache hit**: | ||
| These return the field and its value from the dictionary. | ||
| - `fieldString()`: String | ||
| - `fieldBytes()`: Bytes | ||
| - `valueString()`: String | ||
| - `valueBytes()`: Bytes |
There was a problem hiding this comment.
might be nice to have short descriptions for each possible accessor in addition to return type
|
|
||
| <div class='col col--8'> | ||
|
|
||
| <SdkExampleTabs snippetId={'API_DictionaryLength'} /> |
There was a problem hiding this comment.
side note: apparently JS sdk is missing a DictionaryLength example
PR Description:
This commit refactors the dictionary page in cache api references to new style of documentation matching the one in leaderboards.
Issue
Addresses a part of https://github.com/momentohq/dev-eco-issue-tracker/issues/957