[Schema Registry] Add getSchemaByVersion

sdk/schemaregistry/schema-registry/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+## 1.1.0 (Unreleased)
+
+### Features Added
+
+- `getSchemaByVersion` is added to query schemas by their version.
+- `version` property is added to `SchemaProperties`.
+
 ## 1.1.0 (2022-05-10)
 
 ### Features Added

sdk/schemaregistry/schema-registry/README.md

@@ -118,6 +118,19 @@ if (foundSchema) {
 }
 ```
 
+### Get definition of existing schema by version
+
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { SchemaRegistryClient } = require("@azure/schema-registry");
+
+const client = new SchemaRegistryClient("<fullyQualifiedNamespace>", new DefaultAzureCredential());
+const foundSchema = await client.getSchemaByVersion({ name:"<schema name>", groupName: "group name", version });
+if (foundSchema) {
+  console.log(`Got schema definition=${foundSchema.definition}`);
+}
+```
+
 ## Troubleshooting
 
 ### Logging

sdk/schemaregistry/schema-registry/package.json

@@ -42,7 +42,7 @@
   "//metadata": {
     "constantPaths": [
       {
-        "path": "src/generated/generatedSchemaRegistryClientContext.ts",
+        "path": "src/generated/generatedSchemaRegistryClient.ts",
         "prefix": "packageDetails"
       },
       {

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

@@ -8,6 +8,10 @@ import { CommonClientOptions } from '@azure/core-client';
 import { OperationOptions } from '@azure/core-client';
 import { TokenCredential } from '@azure/core-auth';
 
+// @public
+export interface GetSchemaByVersionOptions extends OperationOptions {
+}
+
 // @public
 export interface GetSchemaOptions extends OperationOptions {
 }
@@ -40,6 +44,7 @@ export interface SchemaProperties {
     groupName: string;
     id: string;
     name: string;
+    version: number;
 }
 
 // @public
@@ -54,6 +59,7 @@ export class SchemaRegistryClient implements SchemaRegistry {
     constructor(fullyQualifiedNamespace: string, credential: TokenCredential, options?: SchemaRegistryClientOptions);
     readonly fullyQualifiedNamespace: string;
     getSchema(schemaId: string, options?: GetSchemaOptions): Promise<Schema>;
+    getSchemaByVersion(schemaVersion: SchemaVersion, options?: GetSchemaByVersionOptions): Promise<Schema>;
     getSchemaProperties(schema: SchemaDescription, options?: GetSchemaPropertiesOptions): Promise<SchemaProperties>;
     registerSchema(schema: SchemaDescription, options?: RegisterSchemaOptions): Promise<SchemaProperties>;
 }
@@ -63,6 +69,13 @@ export interface SchemaRegistryClientOptions extends CommonClientOptions {
     apiVersion?: string;
 }
 
+// @public
+export interface SchemaVersion {
+    groupName: string;
+    name: string;
+    version: number;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

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

@@ -0,0 +1,70 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+/**
+ * @summary Demonstrates the use of a SchemaRegistryClient to register and retrieve schema.
+ */
+
+import { DefaultAzureCredential } from "@azure/identity";
+import { SchemaRegistryClient, SchemaDescription } from "@azure/schema-registry";
+
+// Load the .env file if it exists
+import * as dotenv from "dotenv";
+dotenv.config();
+
+// Set these environment variables or edit the following values
+const fullyQualifiedNamespace =
+  process.env["SCHEMA_REGISTRY_ENDPOINT"] || "<fullyQualifiedNamespace>";
+const groupName = process.env["SCHEMA_REGISTRY_GROUP"] || "AzureSdkSampleGroup";
+
+// Sample Avro Schema for user with first and last names
+const schemaObject = {
+  type: "record",
+  name: "User",
+  namespace: "com.azure.schemaregistry.samples",
+  fields: [
+    {
+      name: "firstName",
+      type: "string",
+    },
+    {
+      name: "lastName",
+      type: "string",
+    },
+  ],
+};
+
+const name = `${schemaObject.namespace}-${schemaObject.name}`;
+
+// Description of the schema for registration
+const schemaDescription: SchemaDescription = {
+  name,
+  groupName,
+  format: "Avro",
+  definition: JSON.stringify(schemaObject),
+};
+
+export async function main() {
+  // Create a new client
+  const client = new SchemaRegistryClient(fullyQualifiedNamespace, new DefaultAzureCredential());
+
+  // Register a schema and get back its ID.
+  const { id, version } = await client.registerSchema(schemaDescription);
+  console.log(
+    `Registered schema with the following properties:\n- ID=${id}\n- Version: ${version}`
+  );
+
+  // Get definition of existing schema by its version
+  const foundSchema = await client.getSchemaByVersion({
+    groupName,
+    name,
+    version,
+  });
+  if (foundSchema) {
+    console.log(`Got schema definition=${foundSchema.definition}`);
+  }
+}
+
+main().catch((err) => {
+  console.error("The sample encountered an error:", err);
+});

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

@@ -15,7 +15,7 @@ dotenv.config();
 // Set these environment variables or edit the following values
 const fullyQualifiedNamespace =
   process.env["SCHEMA_REGISTRY_ENDPOINT"] || "<fullyQualifiedNamespace>";
-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 = {
@@ -34,10 +34,12 @@ const schemaObject = {
   ],
 };
 
+const name = `${schemaObject.namespace}-${schemaObject.name}`;
+
 // Description of the schema for registration
 const schemaDescription: SchemaDescription = {
-  name: `${schemaObject.namespace}-${schemaObject.name}`,
-  groupName: group,
+  name,
+  groupName,
   format: "Avro",
   definition: JSON.stringify(schemaObject),
 };
@@ -47,18 +49,13 @@ export async function main() {
   const client = new SchemaRegistryClient(fullyQualifiedNamespace, new DefaultAzureCredential());
 
   // Register a schema and get back its ID.
-  const registered = await client.registerSchema(schemaDescription);
-  console.log(`Registered schema with ID=${registered.id}`);
-
-  // Get ID for existing schema by its description.
-  // Note that this would throw if it had not been previously registered.
-  const found = await client.getSchemaProperties(schemaDescription);
-  if (found) {
-    console.log(`Got schema ID=${found.id}`);
-  }
+  const { id, version } = await client.registerSchema(schemaDescription);
+  console.log(
+    `Registered schema with the following properties:\n- ID=${id}\n- Version: ${version}`
+  );
 
   // Get definition of existing schema by its ID
-  const foundSchema = await client.getSchema(registered.id);
+  const foundSchema = await client.getSchema(id);
   if (foundSchema) {
     console.log(`Got schema definition=${foundSchema.definition}`);
   }

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

@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { SchemaProperties, Schema } from "./models";
+import { Schema, SchemaProperties } from "./models";
 
 import {
   SchemaGetByIdResponse,
-  SchemaRegisterResponse,
   SchemaQueryIdByContentResponse as SchemaQueryIdByDefinitionResponse,
+  SchemaRegisterResponse,
 } from "./generated/models";
 import { getSchemaDefinition } from "./getSchemaDefinition";
 
@@ -34,6 +34,7 @@ export async function convertSchemaResponse(response: GeneratedSchemaResponse):
       format: mapContentTypeToFormat(response.contentType!),
       groupName: response.schemaGroupName!,
       name: response.schemaName!,
+      version: response.schemaVersion!,
     },
   };
 }
@@ -54,6 +55,7 @@ export function convertSchemaIdResponse(
       format: schemaFormat,
       groupName: response.schemaGroupName!,
       name: response.schemaName!,
+      version: response.schemaVersion!,
     };
   };
 }