[Schema Registry] Apply Archboard requested renames (#17720)

* [Schema Registry] Apply Archboard requested renames

* edit

* more renamings

sdk/schemaregistry/schema-registry-avro/samples-dev/schemaRegistryAvroSample.ts

@@ -46,8 +46,8 @@ const schema = JSON.stringify(schemaObject);
 const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
   groupName,
-  serializationType: "avro",
-  content: schema
+  format: "avro",
+  definition: schema
 };
 
 export async function main() {

sdk/schemaregistry/schema-registry-avro/src/schemaRegistryAvroSerializer.ts

@@ -169,14 +169,14 @@ export class SchemaRegistryAvroSerializer {
       throw new Error(`Schema with ID '${schemaId}' not found.`);
     }
 
-    if (!schemaResponse.serializationType.match(/^avro$/i)) {
+    if (!schemaResponse.format.match(/^avro$/i)) {
       throw new Error(
-        `Schema with ID '${schemaResponse.id}' has serialization type '${schemaResponse.serializationType}', not 'avro'.`
+        `Schema with ID '${schemaResponse.id}' has format '${schemaResponse.format}', not 'avro'.`
       );
     }
 
-    const avroType = this.getAvroTypeForSchema(schemaResponse.content);
-    return this.cache(schemaId, schemaResponse.content, avroType);
+    const avroType = this.getAvroTypeForSchema(schemaResponse.definition);
+    return this.cache(schemaId, schemaResponse.definition, avroType);
   }
 
   private async getSchemaByContent(schema: string): Promise<CacheEntry> {
@@ -193,8 +193,8 @@ export class SchemaRegistryAvroSerializer {
     const description = {
       groupName: this.schemaGroup,
       name: avroType.name,
-      serializationType: "avro",
-      content: schema
+      format: "avro",
+      definition: schema
     };
 
     let id: string;

sdk/schemaregistry/schema-registry-avro/test/schemaRegistryAvroSerializer.spec.ts

@@ -28,13 +28,13 @@ describe("SchemaRegistryAvroSerializer", function() {
     await assert.isRejected(serializer.serialize({}, schema), /name/);
   });
 
-  it("rejects a schema with different serialization type", async () => {
+  it("rejects a schema with different format", async () => {
     const registry = createTestRegistry(true); // true means never live, we can't register non-avro schema in live service
     const serializer = await createTestSerializer(false, registry);
     const schema = await registry.registerSchema({
       name: "_",
-      content: "_",
-      serializationType: "NotAvro",
+      definition: "_",
+      format: "NotAvro",
       groupName: testGroup
     });
 

sdk/schemaregistry/schema-registry-avro/test/utils/mockedRegistryClient.ts

@@ -35,15 +35,15 @@ export function createTestRegistry(neverLive = false): SchemaRegistry {
     schema: SchemaDescription,
     _options?: RegisterSchemaOptions
   ): Promise<SchemaProperties> {
-    let result = mapByContent.get(schema.content);
+    let result = mapByContent.get(schema.definition);
     if (!result) {
       result = {
         id: newId(),
-        content: schema.content,
+        definition: schema.definition,
         version: 1,
-        serializationType: schema.serializationType
+        format: schema.format
       };
-      mapByContent.set(result.content, result);
+      mapByContent.set(result.definition, result);
       mapById.set(result.id, result);
     }
     return result;
@@ -62,7 +62,7 @@ export function createTestRegistry(neverLive = false): SchemaRegistry {
     schema: SchemaDescription,
     _options?: GetSchemaPropertiesOptions
   ): Promise<SchemaProperties | undefined> {
-    return mapByContent.get(schema.content);
+    return mapByContent.get(schema.definition);
   }
 
   async function getSchema(id: string, _options?: GetSchemaOptions): Promise<Schema | undefined> {

sdk/schemaregistry/schema-registry-avro/test/utils/mockedSerializer.ts

@@ -20,8 +20,8 @@ export async function registerTestSchema(registry: SchemaRegistry): Promise<stri
   const schema = await registry.registerSchema({
     name: `${testSchemaObject.namespace}.${testSchemaObject.name}`,
     groupName: testGroup,
-    content: testSchema,
-    serializationType: "avro"
+    definition: testSchema,
+    format: "avro"
   });
   return schema.id;
 }

sdk/schemaregistry/schema-registry/CHANGELOG.md

@@ -11,6 +11,7 @@
 - renames `getSchemaById` to `getSchema`
 - renames `GetSchemaByIdOptions` to `GetSchemaOptions`
 - `getSchema` and `getSchemaProperties` no longer return `undefined` if the schema was not registered
+- renames `content` to `definition`, `serializationType` to `format`, and `KnownSerializationType` to `KnownSchemaFormat`
 
 ### Bugs Fixed
 

sdk/schemaregistry/schema-registry/review/schema-registry.api.md

@@ -17,7 +17,7 @@ export interface GetSchemaPropertiesOptions extends OperationOptions {
 }
 
 // @public
-export const enum KnownSerializationType {
+export const enum KnownSchemaFormat {
     Avro = "avro"
 }
 
@@ -27,21 +27,21 @@ export interface RegisterSchemaOptions extends OperationOptions {
 
 // @public
 export interface Schema extends SchemaProperties {
-    content: string;
+    definition: string;
 }
 
 // @public
 export interface SchemaDescription {
-    content: string;
+    definition: string;
+    format: string;
     groupName: string;
     name: string;
-    serializationType: string;
 }
 
 // @public
 export interface SchemaProperties {
+    format: string;
     id: string;
-    serializationType: string;
     version: number;
 }
 

sdk/schemaregistry/schema-registry/samples-dev/schemaRegistrySample.ts

@@ -37,8 +37,8 @@ const schemaObject = {
 const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
   groupName: group,
-  serializationType: "avro",
-  content: JSON.stringify(schemaObject)
+  format: "avro",
+  definition: JSON.stringify(schemaObject)
 };
 
 export async function main() {
@@ -59,7 +59,7 @@ export async function main() {
   // Get content of existing schema by its ID
   const foundSchema = await client.getSchema(registered.id);
   if (foundSchema) {
-    console.log(`Got schema content=${foundSchema.content}`);
+    console.log(`Got schema content=${foundSchema.definition}`);
   }
 }
 

sdk/schemaregistry/schema-registry/samples/v1/javascript/package.json

@@ -25,6 +25,6 @@
   "dependencies": {
     "@azure/schema-registry": "next",
     "dotenv": "latest",
-    "@azure/identity": "2.0.0-beta.4"
+    "@azure/identity": "2.0.0-beta.6"
   }
 }

sdk/schemaregistry/schema-registry/samples/v1/javascript/schemaRegistrySample.js

@@ -36,9 +36,9 @@ const schemaObject = {
 // Description of the schema for registration
 const schemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
-  group,
-  serializationType: "avro",
-  content: JSON.stringify(schemaObject)
+  groupName: group,
+  format: "avro",
+  definition: JSON.stringify(schemaObject)
 };
 
 async function main() {
@@ -51,15 +51,15 @@ async function main() {
 
   // Get ID for existing schema by its description.
   // Note that this would throw if it had not been previously registered.
-  const found = await client.getSchemaId(schemaDescription);
+  const found = await client.getSchemaProperties(schemaDescription);
   if (found) {
     console.log(`Got schema ID=${found.id}`);
   }
 
   // Get content of existing schema by its ID
   const foundSchema = await client.getSchema(registered.id);
   if (foundSchema) {
-    console.log(`Got schema content=${foundSchema.content}`);
+    console.log(`Got schema content=${foundSchema.definition}`);
   }
 }
 

sdk/schemaregistry/schema-registry/samples/v1/typescript/package.json

@@ -29,7 +29,7 @@
   "dependencies": {
     "@azure/schema-registry": "next",
     "dotenv": "latest",
-    "@azure/identity": "2.0.0-beta.5"
+    "@azure/identity": "2.0.0-beta.6"
   },
   "devDependencies": {
     "typescript": "~4.2.0",

sdk/schemaregistry/schema-registry/samples/v1/typescript/src/schemaRegistrySample.ts

@@ -36,9 +36,9 @@ const schemaObject = {
 // Description of the schema for registration
 const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
-  group,
-  serializationType: "avro",
-  content: JSON.stringify(schemaObject)
+  groupName: group,
+  format: "avro",
+  definition: JSON.stringify(schemaObject)
 };
 
 export async function main() {
@@ -59,7 +59,7 @@ export async function main() {
   // Get content of existing schema by its ID
   const foundSchema = await client.getSchema(registered.id);
   if (foundSchema) {
-    console.log(`Got schema content=${foundSchema.content}`);
+    console.log(`Got schema content=${foundSchema.definition}`);
   }
 }
 

sdk/schemaregistry/schema-registry/src/conversions.ts

@@ -6,19 +6,19 @@ import { SchemaProperties, Schema } from "./models";
 import {
   SchemaGetByIdResponse,
   SchemaRegisterResponse,
-  SchemaQueryIdByContentResponse
+  SchemaQueryIdByContentResponse as SchemaQueryIdByDefinitionResponse
 } from "./generated/models";
 import { FullOperationResponse } from "@azure/core-client";
 
 /**
- * Union of generated client's responses that return schema content.
+ * Union of generated client's responses that return schema definition.
  */
 type GeneratedSchemaResponse = SchemaGetByIdResponse;
 
 /**
  * Union of generated client's responses that return schema ID.
  */
-type GeneratedSchemaIdResponse = SchemaRegisterResponse | SchemaQueryIdByContentResponse;
+type GeneratedSchemaIdResponse = SchemaRegisterResponse | SchemaQueryIdByDefinitionResponse;
 
 /**
  * Union of all generated client's responses.
@@ -37,7 +37,7 @@ export function convertSchemaResponse(
   // https://github.com/Azure/azure-sdk-for-js/issues/11649
   // Although response.body is typed as string, it is a parsed JSON object,
   // so we use _response.bodyAsText instead as a workaround.
-  return convertResponse(response, { content: rawResponse.bodyAsText! });
+  return convertResponse(response, { definition: rawResponse.bodyAsText! });
 }
 
 /**
@@ -60,7 +60,7 @@ function convertResponse<T>(
     // is not modeled by the generated client.
     id: response.schemaId!,
     version: response.schemaVersion!,
-    serializationType: response.serializationType!,
+    format: response.serializationType!,
     ...additionalProperties
   };
 }

sdk/schemaregistry/schema-registry/src/index.ts

@@ -3,4 +3,4 @@
 
 export * from "./models";
 export { SchemaRegistryClient } from "./schemaRegistryClient";
-export { KnownSerializationType } from "./generated";
+export { KnownSerializationType as KnownSchemaFormat } from "./generated";

sdk/schemaregistry/schema-registry/src/models.ts

@@ -14,7 +14,7 @@ export interface SchemaProperties {
    * Serialization type of schema.
    * Currently only 'avro' is supported, but this is subject to change.
    */
-  serializationType: string;
+  format: string;
 
   /** Automatically incremented version number of the schema. */
   version: number;
@@ -31,21 +31,21 @@ export interface SchemaDescription {
   name: string;
 
   /**
-   * Serialization type of schema. Must match serialization type of group.
-   * Currently only 'avro' is supported, but this is subject to change.
+   * The format of schema and it must match the serialization type of the schema's group.
+   * Please refer to {@link KnownSerializationType} for possible values.
    */
-  serializationType: string;
+  format: string;
 
   /** String representation of schema. */
-  content: string;
+  definition: string;
 }
 
 /**
  * Schema definition with its unique ID, version, and location.
  */
 export interface Schema extends SchemaProperties {
   /** String representation of schema. */
-  content: string;
+  definition: string;
 }
 
 /**
@@ -92,7 +92,7 @@ export interface SchemaRegistry {
 
   /**
    * Gets the ID of an existing schema with matching name, group, type, and
-   * content.
+   * definition.
    *
    * @param schema - Schema to match.
    * @returns Matched schema's ID or undefined if no matching schema was found.

sdk/schemaregistry/schema-registry/src/schemaRegistryClient.ts

@@ -73,7 +73,7 @@ export class SchemaRegistryClient implements SchemaRegistry {
 
   private addToCache(schema: SchemaDescription, id: SchemaProperties): void {
     this.schemaToIdMap.set(schema, id);
-    this.idToSchemaMap.set(id.id, { ...id, content: schema.content });
+    this.idToSchemaMap.set(id.id, { ...id, definition: schema.definition });
   }
 
   /**
@@ -91,15 +91,15 @@ export class SchemaRegistryClient implements SchemaRegistry {
     options?: RegisterSchemaOptions
   ): Promise<SchemaProperties> {
     const id = await this.client.schema
-      .register(schema.groupName, schema.name, schema.serializationType, schema.content, options)
+      .register(schema.groupName, schema.name, schema.format, schema.definition, options)
       .then(convertSchemaIdResponse);
     this.addToCache(schema, id);
     return id;
   }
 
   /**
    * Gets the ID of an existing schema with matching name, group, type, and
-   * content.
+   * definition.
    *
    * @param schema - Schema to match.
    * @returns Matched schema's ID or undefined if no matching schema was found.
@@ -113,13 +113,7 @@ export class SchemaRegistryClient implements SchemaRegistry {
       return cached;
     }
     const id = await this.client.schema
-      .queryIdByContent(
-        schema.groupName,
-        schema.name,
-        schema.serializationType,
-        schema.content,
-        options
-      )
+      .queryIdByContent(schema.groupName, schema.name, schema.format, schema.definition, options)
       .then(convertSchemaIdResponse);
     this.addToCache(schema, id);
     return id;