Skip to content

Commit 2832d59

Browse files
committed
Remove "canonicalReference" (i.e. "containerKey") from the .api.json file format; bump ApiJsonSchemaVersion to 1002
1 parent beb5881 commit 2832d59

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

apps/api-extractor-model/src/items/ApiItem.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ export interface IApiItemOptions {
4444

4545
export interface IApiItemJson {
4646
kind: ApiItemKind;
47-
containerKey: string;
4847
}
4948

5049
/**
@@ -85,7 +84,6 @@ export class ApiItem {
8584
/** @virtual */
8685
public serializeInto(jsonObject: Partial<IApiItemJson>): void {
8786
jsonObject.kind = this.kind;
88-
jsonObject.containerKey = this.containerKey;
8987
}
9088

9189
/**

apps/api-extractor-model/src/model/DeserializerContext.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ export enum ApiJsonSchemaVersion {
1212
*/
1313
V_1001 = 1001,
1414

15+
/**
16+
* Remove "canonicalReference" field. This field was for diagnostic purposes only and was never deserialized.
17+
*/
18+
V_1002 = 1002,
19+
1520
/**
1621
* The current latest .api.json schema version.
1722
*
1823
* IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`
1924
* should be updated.
2025
*/
21-
LATEST = V_1001,
26+
LATEST = V_1002,
2227

2328
/**
2429
* The oldest .api.json schema version that is still supported for backwards compatibility.

0 commit comments

Comments
 (0)