Reintroduce the new "canonicalReference" to the .api.json file format

octogonz · octogonz · commit b108208079b1 · 2019-07-20T01:39:33.000-07:00
diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts
@@ -46,6 +46,7 @@ export interface IApiItemOptions {
 
 export interface IApiItemJson {
   kind: ApiItemKind;
+  canonicalReference: string;
 }
 
 // PRIVATE - Allows ApiItemContainerMixin to assign the parent.
@@ -85,6 +86,7 @@ export class ApiItem {
   /** @virtual */
   public serializeInto(jsonObject: Partial<IApiItemJson>): void {
     jsonObject.kind = this.kind;
+    jsonObject.canonicalReference = this.canonicalReference.toString();
   }
 
   /**
diff --git a/apps/api-extractor-model/src/model/DeserializerContext.ts b/apps/api-extractor-model/src/model/DeserializerContext.ts
@@ -13,7 +13,10 @@ export enum ApiJsonSchemaVersion {
   V_1001 = 1001,
 
   /**
-   * Remove "canonicalReference" field.  This field was for diagnostic purposes only and was never deserialized.
+   * Change the "canonicalReference" field to use the experimental new TSDoc declaration reference notation.
+   *
+   * This is not a breaking change because this field is never deserialized; it is provided for informational
+   * purposes only.
    */
   V_1002 = 1002,
 

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ export interface IApiItemOptions {`
`46`	`46`
`47`	`47`	`export interface IApiItemJson {`
`48`	`48`	`kind: ApiItemKind;`
	`49`	`+ canonicalReference: string;`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`// PRIVATE - Allows ApiItemContainerMixin to assign the parent.`
`@@ -85,6 +86,7 @@ export class ApiItem {`
`85`	`86`	`/** @virtual */`
`86`	`87`	`public serializeInto(jsonObject: Partial<IApiItemJson>): void {`
`87`	`88`	`jsonObject.kind = this.kind;`
	`89`	`+ jsonObject.canonicalReference = this.canonicalReference.toString();`
`88`	`90`	`}`
`89`	`91`
`90`	`92`	`/**`