shale 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9396e5fcba6ff4e1f1566abe356270ef9ddbd8ce9171063f011feeb36d234e7
-  data.tar.gz: 4495b40dca3e01b6ba908dfc6b7831aea3f1e2865423de59ced69db33ba633b8
+  metadata.gz: 36678c1f4afd6e0cf2d6a9a9e4b5becebf11e76404cb50dba7dc5269b5ca42cc
+  data.tar.gz: 51c6c94abafe1767c579c270e3c3cb4da2ca79a2a29a9d28ea6bfe09bc4b53fb
 SHA512:
-  metadata.gz: 404737157189f2312b4e189d095899588495c8f80cf52f9bd5935358b2ec8bedbd98b0d7676c44641383109701d62377d3086b36342950d6fd657dbbba2d06b9
-  data.tar.gz: '04818bdcac0290dfd96fbb0ebb1364350a444a9fc0533992d2cdf3bc3443e8afb4f00021346c66610400ddce12b4848c8bbed5c0bfb3835d40438c2b5acc1a6b'
+  metadata.gz: ea21dff00b6ea2663d20f9f377140250f78c29214a93f226047fe29d47680ae526652010ae268e4cf694ca1877cd8d19bfe8f0bbd767fa871fa80afaefee1c83
+  data.tar.gz: 414d45b7bcd2477bc276eee17c598efba40350e0234c32f783c73217bee65ae4260d07e8a7bcfc7f48e1f76c9af4852de1c1c109c5b807e99a945305e2de6286

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.1] - 2022-04-29
+
+### Changed
+- Rename `id` -> `$id` and add info about supported JSON Schema dialect
+
 ## [0.3.0] - 2022-04-29
 
 ### Added

data/README.md

@@ -613,16 +613,18 @@ Shale.xml_adapter = Shale::Adapter::Ox
 
 To generate JSON Schema from you Shale data model use:
 
+:warning: Shale only supports **[Draft 2020-12](https://json-schema.org/draft/2020-12/schema)** JSON Schema
+
 ```ruby
 require 'shale/schema'
 
-Shale::Schema.to_json(Person, id: 'My ID', description: 'My description', pretty: true)
+Shale::Schema.to_json(Person, id: 'http://foo.bar/schema/person', description: 'My description', pretty: true)
 
 # =>
 #
 # {
 #   "$schema": "https://json-schema.org/draft/2020-12/schema",
-#   "id": "My ID",
+#   "$id": "http://foo.bar/schema/person",
 #   "description": "My description",
 #   "$ref": "#/$defs/Person",
 #   "$defs": {
@@ -685,7 +687,7 @@ Shale::Schema::JSON.register_json_type(MyEmailType, MyEmailJSONType)
 
 ### Generating XML Schema
 
-To generate XML Schema from you Shale data model use:
+To generate XML Schema from your Shale data model use:
 
 ```ruby
 require 'shale/schema'

data/lib/shale/schema/json/schema.rb

@@ -35,7 +35,7 @@ module Shale
         def as_json
           schema = {
             '$schema' => DIALECT,
-            'id' => @id,
+            '$id' => @id,
             'description' => @description,
           }
 

data/lib/shale/version.rb

@@ -2,5 +2,5 @@
 
 module Shale
   # @api private
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shale
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies: []
 description: Ruby object mapper and serializer for XML, JSON and YAML.
 email: