nohead 0.11.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/README.md +3 -2
- data/lib/nohead/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 48bb4125ccf55f25a35f920dc98d764c5f44b517bac4978458fe3da4a263ca30
|
|
4
|
+
data.tar.gz: df78296708d60ca5dcf3153fe86cbe640b19d3645c2d1da4966516c4b9a539b6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 50b404d76a782fad6c2253de16b586e59c7c351c963ded57801835d3bd4e9b0888198996d56799eaec6aafe9494e5349b13f2ed2e60bd5dae6cff23c6fcc100a
|
|
7
|
+
data.tar.gz: ef84b5d912e07cbfb64e04ba23828263944c2b391daf27ce6079ad62192000a839c7fe0baeb459bf54cfb12d8e33088eceb422f6839ed28e69b30249e8c55fb1
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,21 @@ Changes to the `nohead` gem that you can notice. Versions follow
|
|
|
5
5
|
releases; a change that could break your code is a major one. Each release's
|
|
6
6
|
section is its GitHub release's notes.
|
|
7
7
|
|
|
8
|
+
## 0.13.0
|
|
9
|
+
|
|
10
|
+
No changes in this SDK: the SDKs keep one version, and this release adds
|
|
11
|
+
Astro support and image-loader fixes to the TypeScript SDK.
|
|
12
|
+
|
|
13
|
+
## 0.12.0
|
|
14
|
+
|
|
15
|
+
- `webhooks.create` and `webhooks.update` take `published_only:`, and every
|
|
16
|
+
webhook has `"published_only"`: a published-only webhook sends only the events that change
|
|
17
|
+
what a published-only API key reads (a record published, unpublished or
|
|
18
|
+
edited while live, schema changes, changes to assets that published records
|
|
19
|
+
use), and skips drafts, schedules and edits to unpublished records.
|
|
20
|
+
- Audit events have `note`: the change note (`Nohead-Change-Note`) a record
|
|
21
|
+
or schema change was made with, or `null`.
|
|
22
|
+
|
|
8
23
|
## 0.11.0
|
|
9
24
|
|
|
10
25
|
- `records.diff` takes `rich_text:`, and the client's `rich_text:` now applies
|
data/README.md
CHANGED
|
@@ -12,6 +12,8 @@ nohead.records.list("posts", filter: { published_at: { exists: true } }).each do
|
|
|
12
12
|
end
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
The key is a project API key: create one under **API keys** in the [web app](https://app.nohead.io), with the **Read records** scope for this example, and set it as `NOHEAD_API_KEY` in your app's environment (or pass it as `api_key:`, under [Configuration](#configuration)). The SDK doesn't read the key that `nohead login` saves for the CLI: give your app a key of its own.
|
|
16
|
+
|
|
15
17
|
> **Status:** 0.x until the Nohead API launches.
|
|
16
18
|
|
|
17
19
|
## Contents
|
|
@@ -57,7 +59,6 @@ nohead = Nohead::Client.new(
|
|
|
57
59
|
| Option | Default | |
|
|
58
60
|
|---|---|---|
|
|
59
61
|
| `api_key:` | `NOHEAD_API_KEY` | A project API key (`nohead_sk_...`, or `nohead_pk_...` when published-only). Required. |
|
|
60
|
-
| `base_url:` | `https://api.nohead.io` | For a proxy, or a mock server in tests. |
|
|
61
62
|
| `project_id:` | the key's project | Looked up once with `GET /v1/me` when omitted. |
|
|
62
63
|
| `max_retries:` | `2` | See [retries](#retries-and-idempotency). |
|
|
63
64
|
| `timeout:` | `60` | The longest wait in seconds without progress, per attempt: connecting, waiting for the response, and between reads and writes of a body. A response that keeps arriving doesn't time out. |
|
|
@@ -66,7 +67,7 @@ nohead = Nohead::Client.new(
|
|
|
66
67
|
| `on_retry:` | | Called before each retry's wait. See [retries](#retries-and-idempotency). |
|
|
67
68
|
| `rich_text:` | `"document"` | How rich text fields read: see [rich text](#rich-text). |
|
|
68
69
|
|
|
69
|
-
An empty string is the same as leaving an option out (`api_key: ""` reads `NOHEAD_API_KEY
|
|
70
|
+
An empty string is the same as leaving an option out (`api_key: ""` reads `NOHEAD_API_KEY`).
|
|
70
71
|
|
|
71
72
|
`with_options` gives a copy of the client with other settings (`timeout:`, `max_retries:`, `headers:`, added to the client's, `on_retry:` and `rich_text:`), sharing its project lookup:
|
|
72
73
|
|
data/lib/nohead/version.rb
CHANGED