restlet2repo: saving modified files

jgabriels · jgabriels · commit 7d9d6b162bab · 2026-01-14T14:09:42.000-06:00
diff --git a/spec/definitions/profile_object_patch.yaml b/spec/definitions/profile_object_patch.yaml
@@ -1,23 +1,12 @@
-example:
-  address: 11 Wall Street
-  carrier_onboard_url: www.carrier.com/onboard
-  carrier_terms_url: www.carrier.com/terms
-  city: New York
-  company: NY Stock Exchange
-  contact_extension: 111
-  contact_name: J.P. Morgan
-  contact_number: 8885559999
-  dispatch_extension: 1234
-  dispatch_number: 4445556666
-  dot_number: '12345678'
-  email: test@directfreight.com
-  fax_number: 1112223333
-  mc_number: '12345678'
-  mobile_carrier: Sprint
-  mobile_number: 4445556666
-  state: NY
-  web_page: www.directfreight.com
-  zip: '12345'
+example: >-
+  { "address": "11 Wall Street", "city": "New York", "company": "NY Stock
+  Exchange", "contact_extension": 111, "contact_name": "J.P. Morgan",
+  "contact_number": 8885559999, "dispatch_extension": 1234, "dispatch_number":
+  4445556666, "dot_number": "12345678", "email": "test@directfreight.com",
+  "fax_number": 1112223333, "mc_number": "12345678", "mobile_carrier": "Sprint",
+  "mobile_number":4445556666, "state": "NY", "web_page":
+  "www.directfreight.com", "carrier_onboard_url": "www.carrier.com/onboard",
+  "carrier_terms_url": "www.carrier.com/terms", "zip": "12345" }
 properties:
   address:
     type: string
diff --git a/spec/definitions/stop_item.yaml b/spec/definitions/stop_item.yaml
@@ -5,5 +5,8 @@ properties:
     type: string
   summary:
     description: Summary of this field.
-    example: '411 Locust Chillicothe, MO 64601 on 03-02-2023'
+    example: |
+      411 Locust
+      Chillicothe, MO 64601
+      on 03-02-2023
     type: string
diff --git a/spec/definitions/truck_info_object.yaml b/spec/definitions/truck_info_object.yaml
@@ -1,11 +1,13 @@
-example:
-  deadhead_per_mile: 1.29
-  driver_per_mile: 0.72
-  fuel_capacity: 200
-  ins_permits_per_mile: 0.13
-  maint_per_mile: 0.17
-  miles_per_gal: 6.5
-  truck_ownership_per_mile: 0.27
+example: |
+  {
+  "miles_per_gal": 6.50,
+  "maint_per_mile": 0.17,
+  "driver_per_mile": 0.72,
+  "truck_ownership_per_mile": 0.27,
+  "ins_permits_per_mile": 0.13,
+  "fuel_capacity": 200.00,
+  "deadhead_per_mile": 1.29      
+  }
 properties:
   deadhead_per_mile:
     type: number
diff --git a/spec/paths/optins.yaml b/spec/paths/optins.yaml
@@ -6,6 +6,7 @@ delete:
     - enum:
         - email
         - text
+        - voice
         - push
       in: query
       name: notification_medium
@@ -36,6 +37,7 @@ get:
       enum:
         - email
         - text
+        - voice
         - push
       in: query
       name: notification_medium
@@ -82,6 +84,9 @@ get:
   tags:
     - optins
 patch:
+  description: >-
+    Used to verify an optin code, or update which channels the user is
+    subscribed to. Email is not yet enabled.
   parameters:
     - in: header
       name: end-user-token
@@ -92,19 +97,28 @@ patch:
       required: true
       schema:
         properties:
+          code:
+            description: >-
+              This code is generated on a POST, and will arrive via the same
+              medium it was designated for.
+            type: string
+          notification_channel:
+            description: >-
+              Specify which channels to subscribe to update. You can also send
+              in an empty string to opt out of everything.
+            enum:
+              - all
+              - alerts
+              - search_data
+            type: string
           notification_medium:
             enum:
               - email
               - text
-            type: string
-          verification_code:
-            description: >-
-              This code is generated on a POST, and will arrive via the same
-              medium it was designated for.
+              - voice
             type: string
         required:
           - notification_medium
-          - verification_code
         type: object
   responses:
     '204':
@@ -114,10 +128,10 @@ patch:
     - optins
 post:
   description: >-
-    Currently only Push notifications are implemented. With them a post creates
-    and approves the optin. Later on when text/email is ported post will create
-    the optin with the status of 'no response' meaning they haven't replied with
-    the propper code, or clicked an authorization link.
+    Text, voice, push and manual are implemented. With push a post creates and
+    approves the optin. With the others, a code is sent to the refecenced
+    contact, and can be verified via the PATCH operation. Email has not yet been
+    enabled.
   parameters:
     - in: header
       name: end-user-token
@@ -131,22 +145,25 @@ post:
           notification_channel:
             default: all
             description: >-
-              Currently defaults to all, and is ignored. When we start using it
-              it will be for opting people out or in one list like alerts, or
-              messages, but not others.
+              Everything but email has been implemented. Push is 1 step
+              verification. Everyone but push and manual uses PATCH to verify
+              the code.
             type: string
           notification_medium:
             description: We currently only accept push
             enum:
               - email
               - text
+              - voice
+              - manual
               - push
             type: string
           tokens:
             description: >-
               This is how you can add multiple push notifications at once, or
-              for systems that have multiple tokens required.
-            example: '"tokens": { "ios": "12345678", "android": "5432344" } '
+              for systems that have multiple tokens required. For other
+              notification mediums use "contact_number": "1234567890" instead of
+              ios or android.
             properties:
               $SERVICE_OR_KEY_NAME:
                 description: >-
