DOCSP-47071: Extended JSON #268
Conversation
✅ Deploy Preview for docs-php-library ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| ) | ||
|
|
||
| Additional Information |
There was a problem hiding this comment.
This link to extended JSON is mentioned under Extended JSON formats, maybe make the main header here just API Documentation?
| Extended JSON Formats | ||
| --------------------- | ||
|
|
||
| MongoDB Extended JSON features two string formats to represent BSON data. | ||
| Each format conforms to the `JSON RFC <https://www.rfc-editor.org/rfc/rfc8259>`__ | ||
| and meets specific use cases. | ||
|
|
||
| The following table describes each Extended JSON format: | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :stub-columns: 1 | ||
| :widths: 10 40 | ||
|
|
||
| * - Name | ||
| - Description | ||
|
|
||
| * - **Canonical** or **Extended** | ||
| - | A string format that avoids loss of BSON type information during data conversions. | ||
| | This format prioritizes type preservation at the loss of human-readability and | ||
| interoperability with older formats. |
There was a problem hiding this comment.
FYA, I went and made a sharedinclude for a lot of this boilerplate – see the C# Extended JSON page for an example.
There was a problem hiding this comment.
Since the shell extended json format doesn't apply here, I won't use the sharedinclude
| Extended JSON Examples | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example shows a document containing an ObjectId, date, and long |
There was a problem hiding this comment.
Outside the scope of this issue, but looks like how we format ObjectId isn't consistent in the PHP docs (do we monospace it or not?). Just a callout, don't need to take action on this.
There was a problem hiding this comment.
looks like we mostly monospace it throughout the repos so I'll update!
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47071
Staging Links
Self-Review Checklist