You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/cloud/guides/configs.md
+26-30Lines changed: 26 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,29 +18,27 @@ All endpoints use your universe ID, which you can find on the [Creator Dashboard
18
18
19
19
For the full endpoint reference, request and response schemas, and error codes, see the [Cloud API reference](/cloud/reference).
20
20
21
-
## Repositories and namespaces
21
+
## Repositories
22
22
23
-
Many requests to the configs endpoints require a **repository** in the path and a**namespace** in the request body. For example, this request adds a draft config:
23
+
Requests to the configs endpoints use a **repository** in the path and an**entries** object in the request body. For example, this request adds a draft config:
24
24
25
25
```json
26
-
PUT /creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/<REPOSITORY>
- Repositories differ by product. They separate configs by system.
37
-
-Namespaces are groupings within a product. They organize keys or mark them as being for some particular purpose.
34
+
-**Repositories** differ by product and separate configs by system.
35
+
-**Entries** are the config key-value pairs. You send and receive a single flat object of keys and values.
38
36
39
-
This guide covers in-experience configs, so all requests use `UniverseConfiguration` for repository and `UniverseConfigurations` for namespace. Repositories and namespaces will eventually expand to cover additional products and use cases.
37
+
This guide covers in-experience configs, so all requests use `InExperienceConfig` for repository. Repositories will eventually expand to cover additional products and use cases.
@@ -49,7 +47,7 @@ Before going live, config changes are staged as drafts. You can either set the e
49
47
-**Starting from scratch or replacing everything** — Use the overwrite endpoint so that the payload is the full desired state. Any key you omit is treated as removed.
50
48
-**Changing only some keys** — Use the partial update endpoint so only the keys you send are updated; everything else stays as-is.
51
49
52
-
This sample code sets `bossHealth` to `100`in the `UniverseConfigurations` namespace and uses the overwrite endpoint:
50
+
This sample code sets `bossHealth` to `100` and uses the overwrite endpoint:
The response includes the `draftHash` value. You need this hash in order to publish. If you prefer to only tweak a few keys in your draft, use the PATCH method on the `/draft` endpoint and only send the namespaces and keys you want to change.
90
+
The response includes the `draftHash` value. You need this hash in order to publish. If you prefer to only tweak a few keys in your draft, use the PATCH method on the `/draft` endpoint and only send the entries (keys) you want to change.
Requests that exceed these limits will fail. For type-specific value limits (e.g. string vs JSON) in your experience, see [Limits](../../production/configs.md#limits) in the experience configs guide.
0 commit comments