Rename recipe to request in collection

Also improve UI for folders a bit

CHANGELOG.md

@@ -4,8 +4,7 @@
 
 ### Breaking
 
-- Rename top-level collection field `requests` to `recipes`
-- All existing recipes must be tagged with `!recipe` in the collection file
+- All existing recipes must be tagged with `!request` in the collection file
   - This is necessary to differentiate from the new `!folder` type
 - Profile values are always treated as templates now
   - Any profile values that were previously the "raw" variant (the default) that contain template syntax (e.g. `{{user_id}}`) will now be rendered as templates. In reality this is very unlikely, so this probably isn't going to break your setup

README.md

@@ -24,8 +24,8 @@ Slumber is based around **collections**. A collection is a group of request **re
 
 ```yaml
 # slumber.yml
-recipes:
-  get: !recipe
+requests:
+  get: !request
     method: GET
     url: https://httpbin.org/get
 ```

docs/src/api/request_collection/chain.md

@@ -13,7 +13,7 @@ To use a chain in a template, reference it as `{{chains.<id>}}`.
 | `selector`     | [`JSONPath`](https://www.ietf.org/archive/id/draft-goessner-dispatch-jsonpath-00.html) | Selector to transform/narrow down results in a chained value. See [Filtering & Querying](../../user_guide/filter_query.md)             | `null`   |
 | `content_type` | [`ContentType`](./content_type.md)                                                     | Force content type. Not required for `request` and `file` chains, as long as the `Content-Type` header/file extension matches the data |          |
 
-See the [`ChainSource`](./chain_source.md) docs for more detail.
+See the [`ChainSource`](./chain_source.md) docs for detail on the different types of chainable values.
 
 ## Examples
 

docs/src/api/request_collection/index.md

@@ -77,8 +77,8 @@ base: &base
     Accept: application/json
     Content-Type: application/json
 
-recipes:
-  login: !recipe
+requests:
+  login: !request
     <<: *base
     method: POST
     url: "{{host}}/anything/login"
@@ -90,15 +90,15 @@ recipes:
 
   # Folders can be used to keep your recipes organized
   users: !folder
-    children:
-      get_user: !recipe
+    requests:
+      get_user: !request
         <<: *base
         name: Get User
         method: GET
         url: "{{host}}/anything/current-user"
         authentication: !bearer "{{chains.auth_token}}"
 
-      update_user: !recipe
+      update_user: !request
         <<: *base
         name: Update User
         method: PUT

docs/src/api/request_collection/request_recipe.md

@@ -8,7 +8,7 @@ Recipes can be organized into folders. This means your set of recipes can form a
 
 ## Recipe Fields
 
-The tag for a recipe is `!recipe` (see examples).
+The tag for a recipe is `!request` (see examples).
 
 | Field            | Type                                         | Description                       | Default                |
 | ---------------- | -------------------------------------------- | --------------------------------- | ---------------------- |
@@ -32,7 +32,7 @@ The tag for a folder is `!folder` (see examples).
 ## Examples
 
 ```yaml
-login: !recipe
+login: !request
   name: Login
   method: POST
   url: "{{host}}/anything/login"
@@ -49,14 +49,14 @@ login: !recipe
 ---
 fish: !folder
   name: Users
-  children:
-    create_fish: !recipe
+  requests:
+    create_fish: !request
       method: POST
       url: "{{host}}/fishes"
       body: >
         {"kind": "barracuda", "name": "Jimmy"}
 
-    list_fish: !recipe
+    list_fish: !request
       method: GET
       url: "{{host}}/fishes"
       query:

docs/src/getting_started.md

@@ -9,13 +9,13 @@ Once you've [installed Slumber](/artifacts), setup is easy.
 Create a file called `slumber.yml` and add the following contents:
 
 ```yaml
-recipes:
-  get: !recipe
+requests:
+  get: !request
     method: GET
     url: https://httpbin.org/get
 ```
 
-> Note: the `!recipe` tag, which tells Slumber that this is a request recipe, not a folder. This is [YAML's tag syntax](https://yaml.org/spec/1.2.2/#24-tags), which is used commonly throughout Slumber to provide explicit configuration.
+> Note: the `!request` tag, which tells Slumber that this is a request recipe, not a folder. This is [YAML's tag syntax](https://yaml.org/spec/1.2.2/#24-tags), which is used commonly throughout Slumber to provide explicit configuration.
 
 ### 2. Run Slumber
 
@@ -37,14 +37,14 @@ profiles:
     data:
       host: https://myfishes.fish
 
-recipes:
-  create_fish: !recipe
+requests:
+  create_fish: !request
     method: POST
     url: "{{host}}/fishes"
     body: >
       {"kind": "barracuda", "name": "Jimmy"}
 
-  list_fish: !recipe
+  list_fish: !request
     method: GET
     url: "{{host}}/fishes"
     query:

docs/src/user_guide/chaining_requests.md

@@ -14,8 +14,8 @@ base: &base
     Accept: application/json
     Content-Type: application/json
 
-recipes:
-  login: !recipe
+requests:
+  login: !request
     <<: *base
     method: POST
     url: "https://myfishes.fish/login"
@@ -25,7 +25,7 @@ recipes:
         "password": "password"
       }
 
-  get_user: !recipe
+  get_user: !request
     <<: *base
     method: GET
     url: "https://myfishes.fish/current-user"

docs/src/user_guide/cli.md

@@ -22,8 +22,8 @@ profiles:
     data:
       host: https://myfishes.fish
 
-recipes:
-  list_fish: !recipe
+requests:
+  list_fish: !request
     method: GET
     url: "{{host}}/fishes"
     query:

docs/src/user_guide/filter_query.md

@@ -45,8 +45,8 @@ base: &base
     Accept: application/json
     Content-Type: application/json
 
-recipes:
-  login: !recipe
+requests:
+  login: !request
     <<: *base
     method: POST
     url: "https://myfishes.fish/anything/login"
@@ -56,7 +56,7 @@ recipes:
         "password": "{{chains.password}}"
       }
 
-  get_user: !recipe
+  get_user: !request
     <<: *base
     method: GET
     url: "https://myfishes.fish/anything/current-user"

docs/src/user_guide/inheritance.md

@@ -16,8 +16,8 @@ chains:
     source: !file
       path: ./api_token.txt
 
-recipes:
-  list_fish: !recipe
+requests:
+  list_fish: !request
     method: GET
     url: "{{host}}/fishes"
     query:
@@ -26,7 +26,7 @@ recipes:
       Accept: application/json
     authentication: !bearer "{{chains.token}}"
 
-  get_fish: !recipe
+  get_fish: !request
     method: GET
     url: "{{host}}/fishes/{{fish_id}}"
     headers:
@@ -57,15 +57,15 @@ request_base: &request_base
     Accept: application/json
   authentication: !bearer "{{chains.token}}"
 
-recipes:
-  list_fish: !recipe
+requests:
+  list_fish: !request
     <<: *request_base
     method: GET
     url: "{{host}}/fishes"
     query:
       big: "true"
 
-  get_fish: !recipe
+  get_fish: !request
     <<: *request_base
     method: GET
     url: "{{host}}/fishes/{{chains.fish_id}}"
@@ -94,20 +94,20 @@ request_base: &request_base
     Accept: application/json
   authentication: !bearer "{{chains.token}}"
 
-recipes:
-  list_fish: !recipe
+requests:
+  list_fish: !request
     <<: *request_base
     method: GET
     url: "{{host}}/fishes"
     query:
       big: "true"
 
-  get_fish: !recipe
+  get_fish: !request
     <<: *request_base
     method: GET
     url: "{{host}}/fishes/{{chains.fish_id}}"
 
-  create_fish: !recipe
+  create_fish: !request
     <<: *request_base
     method: POST
     url: "{{host}}/fishes"

docs/src/user_guide/templates.md

@@ -23,8 +23,8 @@ profiles:
     data:
       host: https://myfishes.fish
 
-recipes:
-  list_fish: !recipe
+requests:
+  list_fish: !request
     method: GET
     url: "{{host}}/fishes"
     query:
@@ -65,14 +65,14 @@ chains:
     # https://jsonpath.com/
     selector: $.id
 
-recipes:
-  create_fish: !recipe
+requests:
+  create_fish: !request
     method: POST
     url: "{{host}}/fishes"
     body: >
       {"kind": "barracuda", "name": "Jimmy"}
 
-  get_fish: !recipe
+  get_fish: !request
     method: GET
     url: "{{host}}/fishes/{{chains.fish_id}}"
 ```
@@ -107,14 +107,14 @@ chains:
       recipe: create_fish
     selector: $.id
 
-recipes:
-  create_fish: !recipe
+requests:
+  create_fish: !request
     method: POST
     url: "{{host}}/fishes"
     body: >
       {"kind": "barracuda", "name": "Jimmy"}
 
-  get_fish: !recipe
+  get_fish: !request
     method: GET
     url: "{{host}}/fishes/{{fish_id}}"
 ```

slumber.yml

@@ -35,8 +35,8 @@ base: &base
     Accept: application/json
     Content-Type: application/json
 
-recipes:
-  login: !recipe
+requests:
+  login: !request
     method: POST
     url: "{{host}}/anything/login"
     query:
@@ -53,22 +53,22 @@ recipes:
 
   users: !folder
     name: Users
-    children:
-      get_users: !recipe
+    requests:
+      get_users: !request
         <<: *base
         name: Get Users
         method: GET
         url: "{{host}}/get"
         query:
           foo: bar
 
-      get_user: !recipe
+      get_user: !request
         <<: *base
         name: Get User
         method: GET
         url: "{{host}}/anything/{{user_guid}}"
 
-      modify_user: !recipe
+      modify_user: !request
         <<: *base
         name: Modify User
         method: PUT
@@ -78,14 +78,14 @@ recipes:
             "username": "new username"
           }
 
-  get_image: !recipe
+  get_image: !request
     headers:
       Accept: image/png
     name: Get Image
     method: GET
     url: "{{host}}/image"
 
-  delay: !recipe
+  delay: !request
     <<: *base
     name: Delay
     method: GET

src/collection/models.rs

@@ -23,7 +23,9 @@ pub struct Collection {
     pub profiles: IndexMap<ProfileId, Profile>,
     #[serde(default, deserialize_with = "cereal::deserialize_id_map")]
     pub chains: IndexMap<ChainId, Chain>,
-    #[serde(default)]
+    /// Internally we call these recipes, but to a user `requests` is more
+    /// intuitive
+    #[serde(default, rename = "requests")]
     pub recipes: RecipeTree,
 }
 
@@ -59,8 +61,12 @@ pub struct Folder {
     #[serde(skip)] // This will be auto-populated from the map key
     pub id: RecipeId,
     pub name: Option<String>,
-    /// RECURSION
-    #[serde(default, deserialize_with = "cereal::deserialize_id_map")]
+    /// RECURSION. Use `requests` in serde to match the root field.
+    #[serde(
+        default,
+        deserialize_with = "cereal::deserialize_id_map",
+        rename = "requests"
+    )]
     pub children: IndexMap<RecipeId, RecipeNode>,
 }