Skip to content

Commit

Permalink
Add example of version of schema in adeo.yml file
Browse files Browse the repository at this point in the history
Changes made:
	- This PR fixes the second bullet point of #1615.
  • Loading branch information
AnimeshKumar923 committed Jul 13, 2023
1 parent a686e2e commit 8617192
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions config/casestudies/adeo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,21 @@ schemas:
description: Avro 1.9
storage: Git repository where source code is. During release they are published to Confluent Schema Registry.
registry: Confluent Schema Registry.
versioning: Versioning is based on git tags. The schema version pushed to Confluent Schema Registry matches the git tag version of the product. Every schema has a `version` information that matches with product tag version.
validation: Based on validation using Confluent Schema Registry.
versioning: |
Versioning is based on git tags. The schema version pushed to Confluent Schema Registry
matches the git tag version of the product. Every schema has a `version` information
that matches with product tag version.
Example Avro schema with version information:
```json
{
"namespace": "com.adeo.casestudy.costingrequest",
"type": "record",
"name": "CostingRequestPayload",
"version": "1.1.0",
"fields": [ ... ]
}
```
asyncapi:
usecase: |
Document the API of the product, so its users know how it works and how to use it. AsyncAPI was selected as the standard that allows you to generate documentation from a machine-readable document that describes the API.
Expand Down

0 comments on commit 8617192

Please sign in to comment.