bullet_train 1.6.27 → 1.6.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7f75d618a203db638f1b185fc7492385b18cfda6d01f656b1c59aa1aae78999
-  data.tar.gz: fdc1355c85f6568be40be51086028acb2178fd9e2a1172ce3b38166a7f5da745
+  metadata.gz: 8070b9c7e2d2851a2fd7588f50c26e49ae1fde8262df2f4ffca38e0ec35f3a9a
+  data.tar.gz: bf06f2eda17f176caa8e7819b7e06f269677e9e5847186e6474dd9c21f4f3e69
 SHA512:
-  metadata.gz: 885d86ec9a7e38ce915c3a8dffc6ad095ac36b4a5be60c50c9889a7662a0486f2cb46be9082622504f877493d6d81ff72d096e3a29f2661928caf1f3feec723c
-  data.tar.gz: ae9061eff605c70db0d8b910a8cfdf9741267d4ad4291ae7143aee830303aacf3b3a7d8d6919d0b581a848257470dfb47284593bda257dbccb6fdb3523f057a8
+  metadata.gz: 9548a1c62492d692a55226f58a845d6b9db714b99f0e28816ee6c4a7e1a05d549f90f50a329552bffd843ed5ab1e02eaa709706e715ad67cec4fc1b804324de8
+  data.tar.gz: 0abc2bb7474f9191ebf5a93cb5920003bd615abab104dade8c6a615dd3b1704a0019678aeb516e14bbc9cfa4ea0a1a53a11533d98e1fe4e12ac39644ecbcc521

data/config/locales/en/addresses.en.yml

@@ -7,23 +7,33 @@ en:
         _: &address_one Address
         label: *address_one
         heading: *address_one
+        api_title: *address_one
+        api_description: *address_one
       address_two:
         _: &address_two Address cont.
         label: *address_two
         heading: *address_two
+        api_title: *address_two
+        api_description: *address_two
       city:
         _: &city City
         label: *city
         heading: *city
+        api_title: *city
+        api_description: *city
       region_id: &region
         _: &region_id State / Province / Region
         label: *region_id
         heading: *region_id
+        api_title: *region_id
+        api_description: *region_id
       region: *region
       region_name:
         _: &region_name Region name
         label: *region_name
         heading: *region_name
+        api_title: *region_name
+        api_description: *region_name
       admin_divisions:
         states: State
         provinces_territories: Province or Territory
@@ -40,12 +50,18 @@ en:
         _: &country_id Country
         label: *country_id
         heading: *country_id
+        api_title: *country_id
+        api_description: *country_id
       country: *country
       postal_code:
         _: &postal_code Postal code
         label: *postal_code
         heading: *postal_code
+        api_title: *postal_code
+        api_description: *postal_code
       zip_code:
         _: &zip_code Zip code
         label: *zip_code
         heading: *zip_code
+        api_title: *zip_code
+        api_description: *zip_code

data/config/locales/en/invitations.en.yml

@@ -17,34 +17,50 @@ en:
         _: &id Invitation ID
         label: *id
         heading: *id
+        api_title: *id
+        api_description: *id
       email:
         _: &email Email Address
         label: *email
         heading: *email
+        api_title: *email
+        api_description: *email
       uuid:
         name: &uuid Invitation UUID
         label: *uuid
         heading: *uuid
+        api_title: *uuid
+        api_description: *uuid
       from_membership_id:
         name: &from_membership_id Who sent ID
         label: *from_membership_id
         heading: *from_membership_id
+        api_title: *from_membership_id
+        api_description: *from_membership_id
       team_id:
         name: &team_id Team ID
         label: *team_id
         heading: *team_id
+        api_title: *team_id
+        api_description: *team_id
       roles: &role_ids
         name: &roles Special Privileges
         label: *roles
         heading: *roles
+        api_title: *roles
+        api_description: *roles
       role_ids: *role_ids
       # 🚅 super scaffolding will insert new fields above this line.
       created_at:
         name: &created_at Sent
         heading: *created_at
+        api_title: *created_at
+        api_description: *created_at
       updated_at:
         name: &updated_at Updated
         heading: *updated_at
+        api_title: *updated_at
+        api_description: *updated_at
     index:
       section: "Invitations for %{team_name}"
       header: Team Member Invitations

data/config/locales/en/memberships.en.yml

@@ -26,50 +26,78 @@ en:
         _: &id Membership ID
         label: *id
         heading: *id
+        api_title: *id
+        api_description: *id
       user_id:
         name: &user_id User ID
         heading: *user_id
+        api_title: *user_id
+        api_description: *user_id
       team_id:
         name: &team_id Team ID
         heading: *team_id
+        api_title: *team_id
+        api_description: *team_id
       invitation_id:
         name: &invitation_id Invitation ID
         heading: *invitation_id
+        api_title: *invitation_id
+        api_description: *invitation_id
       name:
         name: &name Full Name
         heading: *name
+        api_title: *name
+        api_description: *name
       user_first_name:
         name: &user_first_name First Name
         label: *user_first_name
         heading: *user_first_name
+        api_title: *user_first_name
+        api_description: *user_first_name
       user_last_name:
         name: &user_last_name Last Name
         label: *user_last_name
         heading: *user_last_name
+        api_title: *user_last_name
+        api_description: *user_last_name
       user_profile_photo_id:
         name: &user_profile_photo_id Profile Photo
         label: *user_profile_photo_id
         heading: *user_profile_photo_id
+        api_title: *user_profile_photo_id
+        api_description: *user_profile_photo_id
       user_profile_photo:
         name: &user_profile_photo Profile Photo
         label: *user_profile_photo
-        heading: *user_profile_photo_id
+        heading: *user_profile_photo
+        api_title: *user_profile_photo
+        api_description: *user_profile_photo
       user_email:
         name: &user_email User Email
         heading: *user_email
+        api_title: *user_email
+        api_description: *user_email
       added_by_id:
         name: &added_by_id Added by User ID
         heading: *added_by_id
+        api_title: *added_by_id
+        api_description: *added_by_id
       platform_agent_of_id:
         name: &platform_agent_of_id Platform Agent of ID
         heading: *platform_agent_of_id
+        api_title: *platform_agent_of_id
+        api_description: *platform_agent_of_id
       platform_agent:
         name: &platform_agent Platform Agent
         heading: *platform_agent
+        api_title: *platform_agent
+        api_description: *platform_agent
       role_ids:
         name: &roles Special Privileges
         label: *roles
         heading: *roles
+        api_title: *roles
+        api_description: *roles
         options:
           default:
             label: Viewer
@@ -84,9 +112,13 @@ en:
       created_at:
         _: &created_at Created At
         heading: *created_at
+        api_title: *created_at
+        api_description: *created_at
       updated_at:
         _: &updated_at Updated At
         heading: *updated_at
+        api_title: *updated_at
+        api_description: *updated_at
     index:
       section: "%{team_name} Team Members"
       contexts:

data/config/locales/en/teams.en.yml

@@ -53,25 +53,37 @@ en:
         _: &id Team ID
         label: *id
         heading: *id
+        api_title: *id
+        api_description: *id
       name:
         _: &name Team Name
         label: *name
         heading: Team
+        api_title: *name
+        api_description: *name
       time_zone:
         _: &time_zone Primary Time Zone
         label: "Primary Time Zone"
         heading: *time_zone
+        api_title: *time_zone
+        api_description: *time_zone
       locale:
         _: &locale Language
         label: "Primary Language"
         heading: *locale
+        api_title: *locale
+        api_description: *locale
       # 🚅 super scaffolding will insert new fields above this line.
       created_at:
         _: &created_at Signed Up At
         heading: *created_at
+        api_title: *created_at
+        api_description: *created_at
       updated_at:
         _: &updated_at Updated At
         heading: *updated_at
+        api_title: *updated_at
+        api_description: *updated_at
     _: &self
       name:
         label: Your Team Name

data/config/locales/en/users.en.yml

@@ -38,32 +38,46 @@ en:
         _: &id Team ID
         label: *id
         heading: *id
+        api_title: *id
+        api_description: *id
       name:
         heading: Name
       first_name:
         _: &first_name First Name
         label: *first_name
         heading: *first_name
+        api_title: *first_name
+        api_description: *first_name
       last_name:
         _: &last_name Last Name
         label: *last_name
         heading: *last_name
+        api_title: *last_name
+        api_description: *last_name
       email:
         _: &email Email Address
         label: *email
         heading: *email
+        api_title: *email
+        api_description: *email
       time_zone:
         _: &time_zone Your Time Zone
         label: *time_zone
         heading: *time_zone
+        api_title: *time_zone
+        api_description: *time_zone
       profile_photo_id:
         _: &profile_photo_id Profile Photo
         label: *profile_photo_id
         heading: *profile_photo_id
+        api_title: *profile_photo_id
+        api_description: *profile_photo_id
       profile_photo:
         _: &profile_photo Profile Photo
         label: *profile_photo
         heading: *profile_photo
+        api_title: *profile_photo
+        api_description: *profile_photo
       current_password:
         label: Current Password
       password:
@@ -76,18 +90,26 @@ en:
         _: &otp_attempt Your Verification Code
         label: *otp_attempt
         heading: *otp_attempt
+        api_title: *otp_attempt
+        api_description: *otp_attempt
       locale:
         _: &locale Language
         label: *locale
         heading: *locale
+        api_title: *locale
+        api_description: *locale
         help: By default the interface language will adjust based on each team's language setting, but you can set a global personal preference for your account here.
       # 🚅 super scaffolding will insert new fields above this line.
       created_at:
         _: &created_at Signed Up At
         heading: *created_at
+        api_title: *created_at
+        api_description: *created_at
       updated_at:
         _: &updated_at Updated At
         heading: *updated_at
+        api_title: *updated_at
+        api_description: *updated_at
     # this is how we define customizations to fields for a specific namespace.
     _: &self
       email:

data/docs/field-partials.md

@@ -96,15 +96,19 @@ text_field_value:
   name: &text_field_value Text Field Value
   label: *text_field_value
   heading: *text_field_value
+  api_title: *text_field_value
+  api_description: *text_field_value
 ```
 
-This might look redundant at first glance, as you can see that by default the same label ("Text Field Value") is being used for both the form field label (`label`) and the heading (`heading`) of the show view and table view. It's also used when the field is referred to in a validation error message. However, having these three values defined separately gives us the flexibility of defining much more user-friendly labels in the context of a form field. In my own applications, I'll frequently configure these form field labels to be much more verbose questions (in an attempt to improve the UX), but still use the shorter label as a column header on the table view and the show view:
+This might look redundant at first glance, as you can see that by default the same label ("Text Field Value") is being used for both the form field label (`label`) and the heading (`heading`) of the show view and table view, and in API `api_title` and `api_descriptions` are used for documentation purposes. It's also used when the field is referred to in a validation error message. However, having these three values defined separately gives us the flexibility of defining much more user-friendly labels in the context of a form field. In my own applications, I'll frequently configure these form field labels to be much more verbose questions (in an attempt to improve the UX), but still use the shorter label as a column header on the table view and the show view:
 
 ```yaml
 text_field_value:
   name: &text_field_value Text Field Value
   label: "What should the value of this text field be?"
   heading: *text_field_value
+  api_title: *text_field_value
+  api_description: *text_field_value
 ```
 
 You can also configure some placeholder text (displayed in the field when in an empty state) or some inline help text (to be presented to users under the form field) like so:
@@ -114,6 +118,8 @@ text_field_value:
   name: &text_field_value Text Field Value
   label: "What should the value of this text field be?"
   heading: *text_field_value
+  api_title: *text_field_value
+  api_description: *text_field_value
   placeholder: "Type your response here"
   help: "The value can be anything you want it to be!"
 ```

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.6.27"
+  VERSION = "1.6.28"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.6.27
+  version: 1.6.28
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard