nohead 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4381c6ca769b33734069a6b117b59f03d1ebfa3b283698f2f20047b527bf376f
-  data.tar.gz: 9b6dbcf5e1cc441cc10356a2d4b18ae0ae7485faeb4bba79a474ce045aa0150e
+  metadata.gz: 747275a28bad0e0410f52109f1bac03d8d703fedccafe3110f21ae904421d511
+  data.tar.gz: 696d827a38b169e1a047b38a40d9263417cff3f111cec74d825a77236072a62c
 SHA512:
-  metadata.gz: c3491a32b9f27da5dc3ca67b2dbed3952508130cc04ee129954c8ecc4684e4e7fa36806e5914f34bba73ac2da4c43162ffd025891f03f77ad3d6151faa55d1fe
-  data.tar.gz: 5da0e9d7a4869ae460a70737dd34a4e4b9a20fa61d3524a2f5bd0a1e8fa67de2f61886e0e1f003a0b575b0e20006f5529933dc49433e2d2d3d68189ce4913947
+  metadata.gz: e82adbab22c4ea949feccc1c347926b5c2a6795f087b02a8915255f4c7a49f56b53e088ae4b8579374c3db27a59c8bf12c428970d28f83124f047f120c08c7bb
+  data.tar.gz: 6c0c8b4dfc63a7eb8d89cc76030e7cf9797ba28541bd677b1da117b7975039d5b3742677230057ff29c4826ac7abf47acd1e3cfba3b38bb84809c4fa4cf233da

data/CHANGELOG.md

@@ -5,6 +5,20 @@ Changes to the `nohead` gem that you can notice. Versions follow
 releases; a change that could break your code is a major one. Each release's
 section is its GitHub release's notes.
 
+## 0.4.0
+
+- **Breaking:** a field's `api_key` is its `key` (in fields, their aliases,
+  `fields.create(..., key:)` and `fields.update(..., key:)`), as the
+  editor's "Field key" says. API keys keep their name.
+- **Breaking:** `collections.schema_changes.get(schema_change)` takes the
+  schema change's ID alone (`GET /v1/schema-changes/{id}`).
+- **Breaking:** `fields.update` no longer takes `type` or `multiple`; they
+  rewrite record values, so they are `fields.migrate`. The API refuses a
+  body key an operation doesn't take with `400` (`unknown_parameter`,
+  naming it), so a misspelt keyword no longer passes unnoticed.
+- The contract types each field's `configuration` by field type; the API
+  reference lists each type's options.
+
 ## 0.3.0
 
 - **Upgrade required:** 0.1 and 0.2 no longer work with the current API,

data/README.md

@@ -229,8 +229,8 @@ Search needs `search_enabled` collections and the `search:read` scope. It pages
 
 ```ruby
 nohead.collections.create(name: "Posts", slug: "posts",
-                          fields: [{ name: "Title", api_key: "title", type: "text", required: true }])
-nohead.fields.create("posts", name: "Summary", api_key: "summary", type: "long_text")
+                          fields: [{ name: "Title", key: "title", type: "text", required: true }])
+nohead.fields.create("posts", name: "Summary", key: "summary", type: "long_text")
 
 # Changes that rewrite records go through a migration; preview first
 preview = nohead.fields.migrate("fld_...", type: "long_text", dry_run: true)

data/lib/nohead/client.rb

@@ -148,6 +148,10 @@ module Nohead
 
     def build_url(template, values)
       values = values.transform_keys(&:to_s)
+      # A value the template doesn't take is a method out of step with its operation.
+      unknown = values.keys - template.scan(/\{(\w+)\}/).flatten
+      raise ArgumentError, "#{unknown.join(', ')} is not a path parameter of #{template}" if unknown.any?
+
       values["project_id"] ||= project_id if template.include?("{project_id}")
       path = template.gsub(/\{(\w+)\}/) do
         value = values[Regexp.last_match(1)]

data/lib/nohead/operations.rb

@@ -68,7 +68,7 @@ module Nohead
     "records_unschedule" => ["DELETE", "/v1/records/{record_id}/schedule"],
     "records_update" => ["PATCH", "/v1/records/{record_id}"],
     "scheduled_changes_list" => ["GET", "/v1/collections/{collection_id}/scheduled-changes"],
-    "schema_changes_get" => ["GET", "/v1/collections/{collection_id}/schema-changes/{schema_change_id}"],
+    "schema_changes_get" => ["GET", "/v1/schema-changes/{schema_change_id}"],
     "schema_changes_list" => ["GET", "/v1/collections/{collection_id}/schema-changes"],
     "search_index_get" => ["GET", "/v1/collections/{collection_id}/search-index"],
     "search_index_rebuild" => ["POST", "/v1/collections/{collection_id}/search-index/rebuild"],

data/lib/nohead/resources/schema.rb

@@ -60,9 +60,8 @@ module Nohead
                                                 query: { limit: limit, cursor: cursor })
       end
 
-      def get(collection, schema_change)
-        @client.request("schema_changes_get",
-                        path: { collection_id: collection, schema_change_id: schema_change })
+      def get(schema_change)
+        @client.request("schema_changes_get", path: { schema_change_id: schema_change })
       end
     end
 

data/lib/nohead/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nohead
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nohead
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nohead