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

feat: add example of version of schema in adeo.yml file #1941

Merged
merged 3 commits into from
Jul 13, 2023
Merged

feat: add example of version of schema in adeo.yml file #1941

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8617192
Add example of version of schema in adeo.yml file
AnimeshKumar923 Jul 13, 2023
a3fb042
Add example of version of schema in adeo.yml file
AnimeshKumar923 Jul 13, 2023
29a05d0
Merge branch 'master' into adeo-case-second-bullet-point
derberg Jul 13, 2023
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
16 changes: 15 additions & 1 deletion config/casestudies/adeo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,22 @@ 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:
AnimeshKumar923 marked this conversation as resolved.
Show resolved Hide resolved
```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