chore: Release 0.2.1 (#129)

raystack · Apr 22, 2022 · 3a5c619 · 3a5c619
1 parent a5dc33e
commit 3a5c619
Show file tree

Hide file tree

Showing 8 changed files with 572 additions and 178 deletions.
diff --git a/README.md b/README.md
@@ -70,6 +70,7 @@ Stencil clients allows application to interact with stencil server to eserialize
 - [Java](clients/java)
 - [Go](clients/go)
 - [Javascript](clients/js)
+- [Clojure](clients/clojure)
 - Ruby - Coming soon
 - Python - Coming soon
 

diff --git a/clients/clojure/project.clj b/clients/clojure/project.clj
@@ -1,4 +1,4 @@
-(defproject io.odpf/stencil-clj "0.2.0-SNAPSHOT"
+(defproject io.odpf/stencil-clj "0.2.1"
   :description "Stencil client for clojure"
   :url "https://github.com/odpf/stencil"
   :license {:name "Apache 2.0"

diff --git a/clients/java/README.md b/clients/java/README.md
@@ -16,7 +16,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
 #### Gradle
 
 ```groovy
-  implementation group: 'io.odpf', name: 'stencil', version: '0.2.0'
+  implementation group: 'io.odpf', name: 'stencil', version: '0.2.1'
 ```
 
 #### Maven

diff --git a/clients/js/package.json b/clients/js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@odpf/stencil",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Stencil js client package provides a store to lookup protobuf descriptors and options to keep the protobuf descriptors upto date.",
   "main": "main.js",
   "scripts": {

diff --git a/docs/docs/clients/clojure.md b/docs/docs/clients/clojure.md
@@ -6,7 +6,7 @@ A Clojure library designed to easily encode and decode protobuf messages by usin
 
 Add the below dependency to your `project.clj` file:
 ```clj
-           [io.odpf/stencil-clj "0.2.0-SNAPSHOT"]
+           [io.odpf/stencil-clj "0.2.1"]
 ```
 
 ## Usage

diff --git a/docs/docs/clients/java.md b/docs/docs/clients/java.md
@@ -16,7 +16,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
 #### Gradle
 
 ```groovy
-  implementation group: 'io.odpf', name: 'stencil', version: '0.1.6'
+  implementation group: 'io.odpf', name: 'stencil', version: '0.2.1'
 ```
 
 #### Maven
@@ -25,7 +25,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
 <dependency>
   <groupId>io.odpf</groupId>
   <artifactId>stencil</artifactId>
-  <version>0.1.6</version>
+  <version>0.2.1</version>
 </dependency>
 ```
 

diff --git a/docs/docs/reference/api.md b/docs/docs/reference/api.md
@@ -1,5 +1,5 @@
 # API
-## Version: 0.2.0
+## Version: 0.2.1
 
 ### /v1beta1/namespaces
 
@@ -115,45 +115,48 @@ List schemas under the namespace
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
 ### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}
-#### POST
 
+#### GET
 ##### Summary
 
-Create schema
+Get latest schema
+
+##### Description
+
+Returns latest schema in it's own data type. For protobuf response type would be 'application/octet-stream'. Avro, json schema response type would be 'application/json'
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ---- |
 | namespaceId | path |  | Yes | string |
 | schemaId | path |  | Yes | string |
-| X-Format | headers | Can be used to override schema format defined at namespace level | No | [SchemaFormat](#schemaformat) |
-| X-Compatibility | headers | Can be used to override schema compatibility defined at namespace level | No | [SchemaCompatibility](#schemacompatibility) |
-| body | body | schema data | Yes | valid fileDescriptorSet data/avro/json schemas |
 
 ##### Responses
+
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v1beta1CreateSchemaResponse](#v1beta1CreateSchemaResponse) |
+| 200 | A successful schema response. Based on schema format, response will return different content types. For avro and json schemas response type is `application/json`. For protobuf response type is `application/octet-stream`. |  |
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
-#### GET
-
+#### POST
 ##### Summary
 
-Get latest schema
+Create schema under the namespace
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ---- |
 | namespaceId | path |  | Yes | string |
 | schemaId | path |  | Yes | string |
+| body | body | Request payload should be equivalent to `curl` `--data-binary` option | Yes | binary |
 
 ##### Responses
+
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. Based on schema format, response will return different content types. For avro and json schemas response type is `application/json`. For protobuf response type is `application/octet-stream` | json or byte data |
+| 200 | A successful response. | [v1beta1CreateSchemaResponse](#v1beta1createschemaresponse) |
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
 #### DELETE
@@ -195,33 +198,39 @@ Update only schema metadata
 | 200 | A successful response. | [v1beta1UpdateSchemaMetadataResponse](#v1beta1updateschemametadataresponse) |
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
-### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/meta
+### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/check
 
-#### GET
+#### POST
 ##### Summary
 
-Create schema under the namespace. Returns version number, unique ID and location
+Check schema compatibility
+
+##### Description
+
+Checks comptibility with existing latest schema
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ---- |
 | namespaceId | path |  | Yes | string |
 | schemaId | path |  | Yes | string |
+| body | body |  | Yes | binary |
+| X-Compatibility | header |  | No | string |
 
 ##### Responses
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v1beta1GetSchemaMetadataResponse](#v1beta1getschemametadataresponse) |
+| 200 | A successful response. | [v1beta1CreateSchemaResponse](#v1beta1createschemaresponse) |
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
-### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions
+### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/meta
 
 #### GET
 ##### Summary
 
-List all version numbers for schema
+Create schema under the namespace. Returns version number, unique ID and location
 
 ##### Parameters
 
@@ -234,31 +243,32 @@ List all version numbers for schema
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v1beta1ListVersionsResponse](#v1beta1listversionsresponse) |
+| 200 | A successful response. | [v1beta1GetSchemaMetadataResponse](#v1beta1getschemametadataresponse) |
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
-### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions/{versionId}
+### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions
 
 #### GET
-
 ##### Summary
 
-Get schema for specified version
+List all version numbers for schema
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ---- |
 | namespaceId | path |  | Yes | string |
 | schemaId | path |  | Yes | string |
-| versionId | path |  | Yes | integer |
 
 ##### Responses
+
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. Based on schema format, response will return different content types. For avro and json schemas response type is `application/json`. For protobuf response type is `application/octet-stream` | json or byte data |
+| 200 | A successful response. | [v1beta1ListVersionsResponse](#v1beta1listversionsresponse) |
 | default | An unexpected error response. | [rpcStatus](#rpcstatus) |
 
+### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions/{versionId}
+
 #### DELETE
 ##### Summary
 
@@ -311,27 +321,11 @@ Global Search API
 | ---- | ---- | ----------- | -------- |
 | SchemaCompatibility | string |  |  |
 
-Enumarated values for Schema compatibility
-
-| Values |
-| ---- |
-| COMPATIBILITY_BACKWARD |
-| COMPATIBILITY_FORWARD |
-| COMPATIBILITY_FULL |
-
 #### SchemaFormat
 
 | Name | Type | Description | Required |
 | ---- | ---- | ----------- | -------- |
 | SchemaFormat | string |  |  |
-
-Enumarated schema format values
-
-| Values |
-| ---- |
-| FORMAT_PROTOBUF |
-| FORMAT_AVRO |
-| FORMAT_JSON |
 
 #### protobufAny
 
@@ -348,6 +342,12 @@ Enumarated schema format values
 | message | string |  | No |
 | details | [ [protobufAny](#protobufany) ] |  | No |
 
+#### v1beta1CheckCompatibilityResponse
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| v1beta1CheckCompatibilityResponse | object |  |  |
+
 #### v1beta1CreateNamespaceRequest
 
 | Name | Type | Description | Required |
@@ -453,6 +453,7 @@ Enumarated schema format values
 | versionId | integer |  | No |
 | fields | [ string ] |  | No |
 | types | [ string ] |  | No |
+| path | string |  | No |
 
 #### v1beta1SearchMeta