Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare Release for Schema Registry #24676

Merged
merged 3 commits into from
Oct 8, 2021
Merged

Prepare Release for Schema Registry #24676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d61aca2
Add changelog messages and readme.
conniey Oct 8, 2021
0e18286
Running prepare-release azure-data-schemaregistry.
conniey Oct 8, 2021
7f81525
Running prepare-release azure-data-schemaregistry-apacheavro.
conniey Oct 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion sdk/schemaregistry/azure-data-schemaregistry-apacheavro/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# Release History

## 1.0.0-beta.6 (Unreleased)
## 1.0.0-beta.6 (2021-10-08)

### Breaking Changes

- Renamed package from `azure-data-schemaregistry-avro` to `azure-data-schemaregistry-apacheavro`.
- Renamed serializer to `SchemaRegistryApacheAvroSerializer`.
- Renamed builder to `SchemaRegistryApacheAvroSerializerBuilder`.

### Other Changes

#### Dependency Updates

- Update `azure-data-schemaregistry` dependency to `1.0.0-beta.6`.
- Update `azure-core-serializer-avro-apache` dependency to `1.0.0-beta.15`.

## 1.0.0-beta.5 (2021-08-17)

Expand Down
2 changes: 1 addition & 1 deletion sdk/schemaregistry/azure-data-schemaregistry-apacheavro/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ and deserialization.
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-data-schemaregistry-apacheavro</artifactId>
<version>1.0.0-beta.5</version>
<version>1.0.0-beta.6</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand Down
21 changes: 20 additions & 1 deletion sdk/schemaregistry/azure-data-schemaregistry/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
# Release History

## 1.0.0-beta.6 (Unreleased)
## 1.0.0-beta.6 (2021-10-08)

### Features added

- Added `SchemaRegistrySchema`.
- Added `SchemaRegistryVersion`.
- Added back `Response<T>` overloads for `getSchema`, `getSchemaProperties`.

### Breaking changes

- Removed client-side caching.
- Changed `getSchemaId` to `getSchemaProperties`.
- Moved `SchemaProperties.getSchema()` to `SchemaRegistrySchema.getSchemaDefinition()`.
- Changed `getSchema()` to return `String` instead of `byte[]`.
- Changed `SerializationType` to `SchemaFormat`.

### Other Changes

#### Dependency Updates

- Update `azure-core-serializer-avro-apache` dependency to `1.0.0-beta.13`.

## 1.0.0-beta.5 (2021-08-17)

Expand Down
16 changes: 8 additions & 8 deletions sdk/schemaregistry/azure-data-schemaregistry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Azure Schema Registry client library for Java

Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning,
and management. The registry is leveraged by serializers to reduce payload size while describing payload structure with
Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning,
and management. The registry is leveraged by serializers to reduce payload size while describing payload structure with
schema identifiers rather than full schemas.

[Source code][source_code] | Package (Maven) | [API reference documentation][api_reference_doc] | [Product Documentation][product_documentation] | [Samples][sample_readme]
Expand All @@ -21,15 +21,15 @@ schema identifiers rather than full schemas.
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-data-schemaregistry</artifactId>
<version>1.0.0-beta.3</version>
<version>1.0.0-beta.6</version>
</dependency>
```
[//]: # ({x-version-update-end})

### Authenticate the client
In order to interact with the Azure Schema Registry service, you'll need to create an instance of the
`SchemaRegistryClient` class through the `SchemaRegistryClientBuilder`. You will need an **endpoint** and an
**API key** to instantiate a client object.
`SchemaRegistryClient` class through the `SchemaRegistryClientBuilder`. You will need an **endpoint** and an
**API key** to instantiate a client object.

#### Create SchemaRegistryClient with Azure Active Directory Credential

Expand All @@ -42,7 +42,7 @@ To use the [DefaultAzureCredential][DefaultAzureCredential] provider shown below
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.1.2</version>
<version>1.3.7</version>
</dependency>
```

Expand Down Expand Up @@ -84,8 +84,8 @@ A schema has 6 components:
- Schema Content: The string representation of the schema.
- Schema Version: The version assigned to the schema in the Schema Registry instance.

These components play different roles. Some are used as input into the operations and some are outputs. Currently,
[SchemaProperties][schema_properties] only exposes those properties that are potential outputs that are used in
These components play different roles. Some are used as input into the operations and some are outputs. Currently,
[SchemaProperties][schema_properties] only exposes those properties that are potential outputs that are used in
SchemaRegistry operations. Those exposed properties are `Content` and `Id`.

## Examples
Expand Down