[Schema Registry] Rename definition to schemaDefinition

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

@@ -47,7 +47,7 @@ const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
   groupName,
   format: "avro",
-  definition: schema
+  schemaDefinition: schema
 };
 
 export async function main() {

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

@@ -25,7 +25,7 @@
   "dependencies": {
     "@azure/schema-registry-avro": "next",
     "dotenv": "latest",
-    "@azure/identity": "2.0.0-beta.5",
-    "@azure/schema-registry": "1.0.0-beta.2"
+    "@azure/identity": "2.0.0-beta.6",
+    "@azure/schema-registry": "1.0.0-beta.3"
   }
 }

sdk/schemaregistry/schema-registry-avro/samples/v1/javascript/schemaRegistryAvroSample.js

@@ -15,7 +15,7 @@ dotenv.config();
 
 // Set these environment variables or edit the following values
 const endpoint = process.env["SCHEMA_REGISTRY_ENDPOINT"] || "<endpoint>";
-const group = process.env["SCHEMA_REGISTRY_GROUP"] || "AzureSdkSampleGroup";
+const groupName = process.env["SCHEMA_REGISTRY_GROUP"] || "AzureSdkSampleGroup";
 
 // Sample Avro Schema for user with first and last names
 const schemaObject = {
@@ -39,9 +39,9 @@ const schema = JSON.stringify(schemaObject);
 // Description of the schema for registration
 const schemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
-  group,
-  serializationType: "avro",
-  content: schema
+  groupName,
+  format: "avro",
+  schemaDefinition: schema
 };
 
 async function main() {
@@ -54,7 +54,7 @@ async function main() {
   await client.registerSchema(schemaDescription);
 
   // Create a new serializer backed by the client
-  const serializer = new SchemaRegistryAvroSerializer(client, group);
+  const serializer = new SchemaRegistryAvroSerializer(client, groupName);
 
   // serialize an object that matches the schema
   const value = { firstName: "Jane", lastName: "Doe" };

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

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

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

@@ -15,7 +15,7 @@ dotenv.config();
 
 // Set these environment variables or edit the following values
 const endpoint = process.env["SCHEMA_REGISTRY_ENDPOINT"] || "<endpoint>";
-const group = process.env["SCHEMA_REGISTRY_GROUP"] || "AzureSdkSampleGroup";
+const groupName = process.env["SCHEMA_REGISTRY_GROUP"] || "AzureSdkSampleGroup";
 
 // Sample Avro Schema for user with first and last names
 const schemaObject = {
@@ -45,9 +45,9 @@ const schema = JSON.stringify(schemaObject);
 // Description of the schema for registration
 const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
-  group,
-  serializationType: "avro",
-  content: schema
+  groupName,
+  format: "avro",
+  schemaDefinition: schema
 };
 
 export async function main() {
@@ -60,7 +60,7 @@ export async function main() {
   await client.registerSchema(schemaDescription);
 
   // Create a new serializer backed by the client
-  const serializer = new SchemaRegistryAvroSerializer(client, group);
+  const serializer = new SchemaRegistryAvroSerializer(client, groupName);
 
   // serialize an object that matches the schema
   const value: User = { firstName: "Jane", lastName: "Doe" };
@@ -69,7 +69,7 @@ export async function main() {
   console.log(buffer);
 
   // deserialize the result back to an object
-  const deserializedValue = await serializer.deserialize<User>(buffer);
+  const deserializedValue = (await serializer.deserialize(buffer)) as User;
   console.log("Deserialized:");
   console.log(`${deserializedValue.firstName} ${deserializedValue.lastName}`);
 }

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

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { SchemaRegistry } from "@azure/schema-registry";
+import { SchemaDescription, SchemaRegistry } from "@azure/schema-registry";
 import * as avro from "avsc";
 import { toUint8Array } from "./utils/buffer";
 
@@ -175,8 +175,8 @@ export class SchemaRegistryAvroSerializer {
       );
     }
 
-    const avroType = this.getAvroTypeForSchema(schemaResponse.definition);
-    return this.cache(schemaId, schemaResponse.definition, avroType);
+    const avroType = this.getAvroTypeForSchema(schemaResponse.schemaDefinition);
+    return this.cache(schemaId, schemaResponse.schemaDefinition, avroType);
   }
 
   private async getSchemaByContent(schema: string): Promise<CacheEntry> {
@@ -190,11 +190,11 @@ export class SchemaRegistryAvroSerializer {
       throw new Error("Schema must have a name.");
     }
 
-    const description = {
+    const description: SchemaDescription = {
       groupName: this.schemaGroup,
       name: avroType.name,
       format: "avro",
-      definition: schema
+      schemaDefinition: schema
     };
 
     let id: string;

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

@@ -33,7 +33,7 @@ describe("SchemaRegistryAvroSerializer", function() {
     const serializer = await createTestSerializer(false, registry);
     const schema = await registry.registerSchema({
       name: "_",
-      definition: "_",
+      schemaDefinition: "_",
       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.definition);
+    let result = mapByContent.get(schema.schemaDefinition);
     if (!result) {
       result = {
         id: newId(),
-        definition: schema.definition,
+        schemaDefinition: schema.schemaDefinition,
         version: 1,
         format: schema.format
       };
-      mapByContent.set(result.definition, result);
+      mapByContent.set(result.schemaDefinition, 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.definition);
+    return mapByContent.get(schema.schemaDefinition);
   }
 
   async function getSchema(id: string, _options?: GetSchemaOptions): Promise<Schema | undefined> {

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

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

sdk/schemaregistry/schema-registry/CHANGELOG.md

@@ -11,7 +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`
+- renames `content` to `schemaDefinition`, `serializationType` to `format`, and `KnownSerializationType` to `KnownSchemaFormat`
 
 ### Bugs Fixed
 

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

@@ -27,15 +27,15 @@ export interface RegisterSchemaOptions extends OperationOptions {
 
 // @public
 export interface Schema extends SchemaProperties {
-    definition: string;
+    schemaDefinition: string;
 }
 
 // @public
 export interface SchemaDescription {
-    definition: string;
     format: string;
     groupName: string;
     name: string;
+    schemaDefinition: string;
 }
 
 // @public
@@ -54,7 +54,7 @@ export interface SchemaRegistry {
 
 // @public
 export class SchemaRegistryClient implements SchemaRegistry {
-    constructor(endpoint: string, credential: TokenCredential, options?: SchemaRegistryClientOptions);
+    constructor(fullyQualifiedNamespace: string, credential: TokenCredential, options?: SchemaRegistryClientOptions);
     readonly endpoint: string;
     getSchema(id: string, options?: GetSchemaOptions): Promise<Schema>;
     getSchemaProperties(schema: SchemaDescription, options?: GetSchemaPropertiesOptions): Promise<SchemaProperties>;

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

@@ -38,7 +38,7 @@ const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
   groupName: group,
   format: "avro",
-  definition: JSON.stringify(schemaObject)
+  schemaDefinition: 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.definition}`);
+    console.log(`Got schema content=${foundSchema.schemaDefinition}`);
   }
 }
 

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

@@ -38,7 +38,7 @@ const schemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
   groupName: group,
   format: "avro",
-  definition: JSON.stringify(schemaObject)
+  schemaDefinition: JSON.stringify(schemaObject)
 };
 
 async function main() {
@@ -59,7 +59,7 @@ 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.definition}`);
+    console.log(`Got schema content=${foundSchema.schemaDefinition}`);
   }
 }
 

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

@@ -38,7 +38,7 @@ const schemaDescription: SchemaDescription = {
   name: `${schemaObject.namespace}.${schemaObject.name}`,
   groupName: group,
   format: "avro",
-  definition: JSON.stringify(schemaObject)
+  schemaDefinition: 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.definition}`);
+    console.log(`Got schema content=${foundSchema.schemaDefinition}`);
   }
 }
 

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

@@ -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, { definition: rawResponse.bodyAsText! });
+  return convertResponse(response, { schemaDefinition: rawResponse.bodyAsText! });
 }
 
 /**

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

@@ -37,15 +37,15 @@ export interface SchemaDescription {
   format: string;
 
   /** String representation of schema. */
-  definition: string;
+  schemaDefinition: string;
 }
 
 /**
  * Schema definition with its unique ID, version, and location.
  */
 export interface Schema extends SchemaProperties {
   /** String representation of schema. */
-  definition: string;
+  schemaDefinition: string;
 }
 
 /**

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

@@ -36,17 +36,17 @@ export class SchemaRegistryClient implements SchemaRegistry {
   /**
    * Creates a new client for Azure Schema Registry service.
    *
-   * @param endpoint - The Schema Registry service endpoint URL, for example
-   *                   https://mynamespace.servicebus.windows.net.
+   * @param fullyQualifiedNamespace - The Schema Registry service qualified namespace URL, for example
+   *                                  https://mynamespace.servicebus.windows.net.
    * @param credential - Credential to authenticate requests to the service.
    * @param options - Options to configure API requests to the service.
    */
   constructor(
-    endpoint: string,
+    fullyQualifiedNamespace: string,
     credential: TokenCredential,
     options: SchemaRegistryClientOptions = {}
   ) {
-    this.endpoint = endpoint;
+    this.endpoint = fullyQualifiedNamespace;
 
     const internalPipelineOptions: InternalPipelineOptions = {
       ...options,
@@ -81,7 +81,7 @@ export class SchemaRegistryClient implements SchemaRegistry {
     options?: RegisterSchemaOptions
   ): Promise<SchemaProperties> {
     return this.client.schema
-      .register(schema.groupName, schema.name, schema.format, schema.definition, options)
+      .register(schema.groupName, schema.name, schema.format, schema.schemaDefinition, options)
       .then(convertSchemaIdResponse);
   }
 
@@ -97,7 +97,13 @@ export class SchemaRegistryClient implements SchemaRegistry {
     options?: GetSchemaPropertiesOptions
   ): Promise<SchemaProperties> {
     return this.client.schema
-      .queryIdByContent(schema.groupName, schema.name, schema.format, schema.definition, options)
+      .queryIdByContent(
+        schema.groupName,
+        schema.name,
+        schema.format,
+        schema.schemaDefinition,
+        options
+      )
       .then(convertSchemaIdResponse);
   }