Skip to content

Commit 386e2b8

Browse files
committed
chore: Release 0.2.1
1 parent a5dc33e commit 386e2b8

File tree

8 files changed

+572
-178
lines changed

8 files changed

+572
-178
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Stencil clients allows application to interact with stencil server to eserialize
7070
- [Java](clients/java)
7171
- [Go](clients/go)
7272
- [Javascript](clients/js)
73+
- [Clojure](clients/clojure)
7374
- Ruby - Coming soon
7475
- Python - Coming soon
7576

clients/clojure/project.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
(defproject io.odpf/stencil-clj "0.2.0-SNAPSHOT"
1+
(defproject io.odpf/stencil-clj "0.2.1"
22
:description "Stencil client for clojure"
33
:url "https://github.com/odpf/stencil"
44
:license {:name "Apache 2.0"

clients/java/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
1616
#### Gradle
1717

1818
```groovy
19-
implementation group: 'io.odpf', name: 'stencil', version: '0.2.0'
19+
implementation group: 'io.odpf', name: 'stencil', version: '0.2.1'
2020
```
2121

2222
#### Maven

clients/js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@odpf/stencil",
3-
"version": "0.2.0",
3+
"version": "0.2.1",
44
"description": "Stencil js client package provides a store to lookup protobuf descriptors and options to keep the protobuf descriptors upto date.",
55
"main": "main.js",
66
"scripts": {

docs/docs/clients/clojure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A Clojure library designed to easily encode and decode protobuf messages by usin
66

77
Add the below dependency to your `project.clj` file:
88
```clj
9-
[io.odpf/stencil-clj "0.2.0-SNAPSHOT"]
9+
[io.odpf/stencil-clj "0.2.1"]
1010
```
1111

1212
## Usage

docs/docs/clients/java.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
1616
#### Gradle
1717

1818
```groovy
19-
implementation group: 'io.odpf', name: 'stencil', version: '0.1.6'
19+
implementation group: 'io.odpf', name: 'stencil', version: '0.2.1'
2020
```
2121

2222
#### Maven
@@ -25,7 +25,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
2525
<dependency>
2626
<groupId>io.odpf</groupId>
2727
<artifactId>stencil</artifactId>
28-
<version>0.1.6</version>
28+
<version>0.2.1</version>
2929
</dependency>
3030
```
3131

docs/docs/reference/api.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# API
2-
## Version: 0.2.0
2+
## Version: 0.2.1
33

44
### /v1beta1/namespaces
55

@@ -115,45 +115,48 @@ List schemas under the namespace
115115
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
116116

117117
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}
118-
#### POST
119118

119+
#### GET
120120
##### Summary
121121

122-
Create schema
122+
Get latest schema
123+
124+
##### Description
125+
126+
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'
123127

124128
##### Parameters
125129

126130
| Name | Located in | Description | Required | Schema |
127131
| ---- | ---------- | ----------- | -------- | ---- |
128132
| namespaceId | path | | Yes | string |
129133
| schemaId | path | | Yes | string |
130-
| X-Format | headers | Can be used to override schema format defined at namespace level | No | [SchemaFormat](#schemaformat) |
131-
| X-Compatibility | headers | Can be used to override schema compatibility defined at namespace level | No | [SchemaCompatibility](#schemacompatibility) |
132-
| body | body | schema data | Yes | valid fileDescriptorSet data/avro/json schemas |
133134

134135
##### Responses
136+
135137
| Code | Description | Schema |
136138
| ---- | ----------- | ------ |
137-
| 200 | A successful response. | [v1beta1CreateSchemaResponse](#v1beta1CreateSchemaResponse) |
139+
| 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`. | |
138140
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
139141

140-
#### GET
141-
142+
#### POST
142143
##### Summary
143144

144-
Get latest schema
145+
Create schema under the namespace
145146

146147
##### Parameters
147148

148149
| Name | Located in | Description | Required | Schema |
149150
| ---- | ---------- | ----------- | -------- | ---- |
150151
| namespaceId | path | | Yes | string |
151152
| schemaId | path | | Yes | string |
153+
| body | body | Request payload should be equivalent to `curl` `--data-binary` option | Yes | binary |
152154

153155
##### Responses
156+
154157
| Code | Description | Schema |
155158
| ---- | ----------- | ------ |
156-
| 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 |
159+
| 200 | A successful response. | [v1beta1CreateSchemaResponse](#v1beta1createschemaresponse) |
157160
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
158161

159162
#### DELETE
@@ -195,33 +198,39 @@ Update only schema metadata
195198
| 200 | A successful response. | [v1beta1UpdateSchemaMetadataResponse](#v1beta1updateschemametadataresponse) |
196199
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
197200

198-
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/meta
201+
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/check
199202

200-
#### GET
203+
#### POST
201204
##### Summary
202205

203-
Create schema under the namespace. Returns version number, unique ID and location
206+
Check schema compatibility
207+
208+
##### Description
209+
210+
Checks comptibility with existing latest schema
204211

205212
##### Parameters
206213

207214
| Name | Located in | Description | Required | Schema |
208215
| ---- | ---------- | ----------- | -------- | ---- |
209216
| namespaceId | path | | Yes | string |
210217
| schemaId | path | | Yes | string |
218+
| body | body | | Yes | binary |
219+
| X-Compatibility | header | | No | string |
211220

212221
##### Responses
213222

214223
| Code | Description | Schema |
215224
| ---- | ----------- | ------ |
216-
| 200 | A successful response. | [v1beta1GetSchemaMetadataResponse](#v1beta1getschemametadataresponse) |
225+
| 200 | A successful response. | [v1beta1CreateSchemaResponse](#v1beta1createschemaresponse) |
217226
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
218227

219-
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions
228+
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/meta
220229

221230
#### GET
222231
##### Summary
223232

224-
List all version numbers for schema
233+
Create schema under the namespace. Returns version number, unique ID and location
225234

226235
##### Parameters
227236

@@ -234,31 +243,32 @@ List all version numbers for schema
234243

235244
| Code | Description | Schema |
236245
| ---- | ----------- | ------ |
237-
| 200 | A successful response. | [v1beta1ListVersionsResponse](#v1beta1listversionsresponse) |
246+
| 200 | A successful response. | [v1beta1GetSchemaMetadataResponse](#v1beta1getschemametadataresponse) |
238247
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
239248

240-
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions/{versionId}
249+
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions
241250

242251
#### GET
243-
244252
##### Summary
245253

246-
Get schema for specified version
254+
List all version numbers for schema
247255

248256
##### Parameters
249257

250258
| Name | Located in | Description | Required | Schema |
251259
| ---- | ---------- | ----------- | -------- | ---- |
252260
| namespaceId | path | | Yes | string |
253261
| schemaId | path | | Yes | string |
254-
| versionId | path | | Yes | integer |
255262

256263
##### Responses
264+
257265
| Code | Description | Schema |
258266
| ---- | ----------- | ------ |
259-
| 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 |
267+
| 200 | A successful response. | [v1beta1ListVersionsResponse](#v1beta1listversionsresponse) |
260268
| default | An unexpected error response. | [rpcStatus](#rpcstatus) |
261269

270+
### /v1beta1/namespaces/{namespaceId}/schemas/{schemaId}/versions/{versionId}
271+
262272
#### DELETE
263273
##### Summary
264274

@@ -311,27 +321,11 @@ Global Search API
311321
| ---- | ---- | ----------- | -------- |
312322
| SchemaCompatibility | string | | |
313323

314-
Enumarated values for Schema compatibility
315-
316-
| Values |
317-
| ---- |
318-
| COMPATIBILITY_BACKWARD |
319-
| COMPATIBILITY_FORWARD |
320-
| COMPATIBILITY_FULL |
321-
322324
#### SchemaFormat
323325

324326
| Name | Type | Description | Required |
325327
| ---- | ---- | ----------- | -------- |
326328
| SchemaFormat | string | | |
327-
328-
Enumarated schema format values
329-
330-
| Values |
331-
| ---- |
332-
| FORMAT_PROTOBUF |
333-
| FORMAT_AVRO |
334-
| FORMAT_JSON |
335329

336330
#### protobufAny
337331

@@ -348,6 +342,12 @@ Enumarated schema format values
348342
| message | string | | No |
349343
| details | [ [protobufAny](#protobufany) ] | | No |
350344

345+
#### v1beta1CheckCompatibilityResponse
346+
347+
| Name | Type | Description | Required |
348+
| ---- | ---- | ----------- | -------- |
349+
| v1beta1CheckCompatibilityResponse | object | | |
350+
351351
#### v1beta1CreateNamespaceRequest
352352

353353
| Name | Type | Description | Required |
@@ -453,6 +453,7 @@ Enumarated schema format values
453453
| versionId | integer | | No |
454454
| fields | [ string ] | | No |
455455
| types | [ string ] | | No |
456+
| path | string | | No |
456457

457458
#### v1beta1SearchMeta
458459

0 commit comments

Comments
 (0)