diff --git a/.github/workflows/build-timestamped-master.yml b/.github/workflows/build-timestamped-master.yml index a78a2a1..af411d4 100644 --- a/.github/workflows/build-timestamped-master.yml +++ b/.github/workflows/build-timestamped-master.yml @@ -3,7 +3,7 @@ name: Build on: push: branches: - - master + - main paths-ignore: - '*.md' - 'docs/**' diff --git a/.github/workflows/build-with-bal-test-graalvm.yml b/.github/workflows/build-with-bal-test-graalvm.yml index 77cdaec..0ab7657 100644 --- a/.github/workflows/build-with-bal-test-graalvm.yml +++ b/.github/workflows/build-with-bal-test-graalvm.yml @@ -6,7 +6,7 @@ on: lang_tag: description: Branch/Release Tag of the Ballerina Lang required: true - default: master + default: main lang_version: description: Ballerina Lang Version (If given ballerina lang build will be skipped) required: false @@ -19,7 +19,7 @@ on: - cron: '30 18 * * *' pull_request: branches: - - master + - main types: [ opened, synchronize, reopened, labeled, unlabeled ] concurrency: diff --git a/.github/workflows/update-spec.yml b/.github/workflows/update-spec.yml index 7815278..f9358ec 100644 --- a/.github/workflows/update-spec.yml +++ b/.github/workflows/update-spec.yml @@ -7,7 +7,7 @@ on: workflow_dispatch: push: branches: - - master + - main paths: - 'docs/spec/**' diff --git a/README.md b/README.md index 6b22ffa..372745f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # Ballerina Avro Module [![Build](https://github.com/ballerina-platform/module-ballerina-avro/actions/workflows/build-timestamped-master.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-avro/actions/workflows/build-timestamped-master.yml) -[![codecov](https://codecov.io/gh/ballerina-platform/module-ballerina-avro/branch/master/graph/badge.svg)](https://codecov.io/gh/ballerina-platform/module-ballerina-avro) +[![codecov](https://codecov.io/gh/ballerina-platform/module-ballerina-avro/branch/main/graph/badge.svg)](https://codecov.io/gh/ballerina-platform/module-ballerina-avro) [![Trivy](https://github.com/ballerina-platform/module-ballerina-avro/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-avro/actions/workflows/trivy-scan.yml) [![GraalVM Check](https://github.com/ballerina-platform/module-ballerina-avro/actions/workflows/build-with-bal-test-graalvm.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-avro/actions/workflows/build-with-bal-test-graalvm.yml) -[![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerina-avro.svg)](https://github.com/ballerina-platform/module-ballerina-avro/commits/master) +[![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerina-avro.svg)](https://github.com/ballerina-platform/module-ballerina-avro/commits/main) [![Github issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-standard-library/module/avro.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-standard-library/labels/module%2Favro) -[![codecov](https://codecov.io/gh/ballerina-platform/module-ballerina-avro/branch/master/graph/badge.svg)](https://codecov.io/gh/ballerina-platform/module-ballerina-avro) Avro is an open-source data serialization system that enables efficient binary serialization and deserialization. It allows users to define schemas for structured data, providing better representation and fast serialization/deserialization. Avro's schema evolution capabilities ensure compatibility and flexibility in evolving data systems. @@ -14,12 +13,12 @@ The Ballerina Avro module provides the capability to efficiently serialize and d ## Schema -`Schema` is will take the Avro schema in string format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize and deserilize data and the data should be in the correct format. +The `Schema` instance takes an Avro schema in `string` format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema. -A `Schema` can be defined using the string value of an Avro schema as shown below: +A `Schema` can be defined using the `string` value of an Avro schema as shown below. ```ballerina -avro:Schema schema = check new(string `{"type": "int", "name" : "intValue", "namespace": "data" }`); +avro:Schema schema = check new(string `{"type": "int", "namespace": "example.data" }`); ``` ## APIs associated with Avro diff --git a/ballerina/Module.md b/ballerina/Module.md index 6524e52..4788206 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -4,14 +4,14 @@ Avro is an open-source data serialization system that enables efficient binary s The Ballerina Avro module provides the capability to efficiently serialize and deserialize data using Avro schemas. -### Schema +## Schema -`Schema` is will take the Avro schema in string format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize and deserilize data and the data should be in the correct format. +The `Schema` instance takes an Avro schema in `string` format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema. -A `Schema` can be defined using the string value of an Avro schema as shown below: +A `Schema` can be defined using the `string` value of an Avro schema as shown below. ```ballerina -avro:Schema schema = check new(string `{"type": "int", "name" : "intValue", "namespace": "data" }`); +avro:Schema schema = check new(string `{"type": "int", "namespace": "example.data" }`); ``` ### APIs associated with Avro diff --git a/ballerina/Package.md b/ballerina/Package.md index 7b48e32..cbb2dbf 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -4,14 +4,14 @@ Avro is an open-source data serialization system that enables efficient binary s The Ballerina Avro module provides the capability to efficiently serialize and deserialize data using Avro schemas. -### Schema +## Schema -`Schema` is will take the Avro schema in string format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize and deserilize data and the data should be in the correct format. +The `Schema` instance takes an Avro schema in `string` format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema. -A `Schema` can be defined using the string value of an Avro schema as shown below: +A `Schema` can be defined using the `string` value of an Avro schema as shown below. ```ballerina -avro:Schema schema = check new(string `{"type": "int", "name" : "intValue", "namespace": "data" }`); +avro:Schema schema = check new(string `{"type": "int", "namespace": "example.data" }`); ``` ### APIs associated with Avro