Skip to content

Commit eec9b12

Browse files
authored
CDRIVER-5701 remove deprecated bson_as_json and bson_array_as_json (#1920)
* remove `bson_as_json` and `bson_array_as_json` * use consistent markdown format with libmongoc 2.0 NEWS
1 parent 87de663 commit eec9b12

File tree

6 files changed

+9
-121
lines changed

6 files changed

+9
-121
lines changed

src/libbson/NEWS

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
libbson 2.0.0 (Unreleased)
22
==========================
33

4-
Changes:
4+
## Changes
5+
6+
* `BSON_ERROR_BUFFER_SIZE` is reduced from `504` to `503` to reserve the final byte for internal use.
7+
* The data layout of `bson_error_t` remains otherwise unchanged: the size is still 512 bytes and the offset of the `.code`, `.domain`, and `.message` data members remain unchanged.
8+
9+
## Removals
510

6-
* `BSON_ERROR_BUFFER_SIZE` is reduced from `504` to `503` to reserve the final byte for internal use.
7-
* The data layout of `bson_error_t` remains otherwise unchanged: the size is still 512 bytes and the offset of the `.code`, `.domain`, and `.message` data members remain unchanged.
11+
* `bson_as_json` and `bson_array_as_json` are removed due to producing non-portable Legacy Extended JSON. Prefer Canonical Extended JSON or Relaxed Extended JSON for portability. To continue using Legacy Extended JSON, use `bson_as_legacy_extended_json` and `bson_array_as_legacy_extended_json`.
812

913
libbson 1.30.2
1014
==============

src/libbson/doc/bson_array_as_json.rst

Lines changed: 0 additions & 48 deletions
This file was deleted.

src/libbson/doc/bson_as_json.rst

Lines changed: 0 additions & 47 deletions
This file was deleted.

src/libbson/doc/bson_t.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,9 @@ BSON document contains duplicate keys.
195195
bson_append_utf8
196196
bson_append_value
197197
bson_array_as_canonical_extended_json
198-
bson_array_as_json
199198
bson_array_as_legacy_extended_json
200199
bson_array_as_relaxed_extended_json
201200
bson_as_canonical_extended_json
202-
bson_as_json
203201
bson_as_json_with_opts
204202
bson_as_legacy_extended_json
205203
bson_as_relaxed_extended_json

src/libbson/src/bson/bson.c

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2505,12 +2505,6 @@ bson_as_canonical_extended_json (const bson_t *bson, size_t *length)
25052505
}
25062506

25072507

2508-
char *
2509-
bson_as_json (const bson_t *bson, size_t *length)
2510-
{
2511-
return bson_as_legacy_extended_json (bson, length);
2512-
}
2513-
25142508
char *
25152509
bson_as_legacy_extended_json (const bson_t *bson, size_t *length)
25162510
{
@@ -2527,12 +2521,6 @@ bson_as_relaxed_extended_json (const bson_t *bson, size_t *length)
25272521
}
25282522

25292523

2530-
char *
2531-
bson_array_as_json (const bson_t *bson, size_t *length)
2532-
{
2533-
return bson_array_as_legacy_extended_json (bson, length);
2534-
}
2535-
25362524
char *
25372525
bson_array_as_legacy_extended_json (const bson_t *bson, size_t *length)
25382526
{

src/libbson/src/bson/bson.h

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ bson_as_canonical_extended_json (const bson_t *bson, size_t *length);
519519

520520

521521
/**
522-
* bson_as_json:
522+
* bson_as_legacy_extended_json:
523523
* @bson: A bson_t.
524524
* @length: A location for the string length, or NULL.
525525
*
@@ -531,10 +531,7 @@ bson_as_canonical_extended_json (const bson_t *bson, size_t *length);
531531
*
532532
* Returns: A newly allocated string that should be freed with bson_free().
533533
*/
534-
BSON_DEPRECATED_FOR (bson_as_legacy_extended_json)
535-
BSON_EXPORT (char *) bson_as_json (const bson_t *bson, size_t *length);
536534

537-
// `bson_as_legacy_extended_json` is a non-deprecated form of `bson_as_json`.
538535
BSON_EXPORT (char *)
539536
bson_as_legacy_extended_json (const bson_t *bson, size_t *length);
540537

@@ -561,11 +558,7 @@ BSON_EXPORT (char *)
561558
bson_as_relaxed_extended_json (const bson_t *bson, size_t *length);
562559

563560

564-
/* like bson_as_json() but for outermost arrays. */
565-
BSON_DEPRECATED_FOR (bson_array_as_legacy_extended_json)
566-
BSON_EXPORT (char *) bson_array_as_json (const bson_t *bson, size_t *length);
567-
568-
// `bson_array_as_legacy_extended_json` is a non-deprecated form of `bson_array_as_json`.
561+
/* like bson_as_legacy_extended_json() but for outermost arrays. */
569562
BSON_EXPORT (char *)
570563
bson_array_as_legacy_extended_json (const bson_t *bson, size_t *length);
571564

0 commit comments

Comments
 (0)