Description of TaskBookingLabel

Signed-off-by: Aaron Chong <[email protected]>
open-rmf · May 6, 2024 · 24ddad5 · 24ddad5
1 parent 3f9a874
commit 24ddad5
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/packages/api-client/lib/openapi/api.ts b/packages/api-client/lib/openapi/api.ts
@@ -2377,7 +2377,7 @@ export interface Task {
   description_schema?: object;
 }
 /**
- *
+ * This label is to be populated by any frontend during a task dispatch, by being added to TaskRequest.labels, which in turn populates TaskState.booking.labels, and can be used to display relevant information needed for any frontends.
  * @export
  * @interface TaskBookingLabel
  */
@@ -2390,7 +2390,7 @@ export interface TaskBookingLabel {
   description: TaskBookingLabelDescription;
 }
 /**
- *
+ * This description holds several fields that could be useful for frontend dashboards when dispatching a task, to then be identified or rendered accordingly back on the same frontend.
  * @export
  * @interface TaskBookingLabelDescription
  */

diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts
@@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models';
 
 export const version = {
   rmfModels: rmfModelVer,
-  rmfServer: '6e3c9301f2d3c5f44ae8f08aad9d00d8ba60749d',
+  rmfServer: '3f9a874f93b41160098ebccd780c237e07589011',
   openapiGenerator: '6.2.1',
 };
diff --git a/packages/api-client/schema/index.ts b/packages/api-client/schema/index.ts
@@ -3633,6 +3633,8 @@ export default {
         required: ['description'],
         type: 'object',
         properties: { description: { $ref: '#/components/schemas/TaskBookingLabelDescription' } },
+        description:
+          'This label is to be populated by any frontend during a task dispatch, by\nbeing added to TaskRequest.labels, which in turn populates\nTaskState.booking.labels, and can be used to display relevant information\nneeded for any frontends.',
       },
       TaskBookingLabelDescription: {
         title: 'TaskBookingLabelDescription',
@@ -3644,6 +3646,8 @@ export default {
           destination: { title: 'Destination', type: 'string' },
           cart_id: { title: 'Cart Id', type: 'string' },
         },
+        description:
+          'This description holds several fields that could be useful for frontend\ndashboards when dispatching a task, to then be identified or rendered\naccordingly back on the same frontend.',
       },
       TaskCancelResponse: {
         title: 'TaskCancelResponse',

diff --git a/packages/api-server/api_server/models/task_booking_label.py b/packages/api-server/api_server/models/task_booking_label.py
@@ -8,6 +8,12 @@
 
 
 class TaskBookingLabelDescription(BaseModel):
+    """
+    This description holds several fields that could be useful for frontend
+    dashboards when dispatching a task, to then be identified or rendered
+    accordingly back on the same frontend.
+    """
+
     task_name: Optional[str]
     unix_millis_warn_time: Optional[int]
     pickup: Optional[str]
@@ -23,6 +29,13 @@ def from_json_string(json_str: str) -> Optional["TaskBookingLabelDescription"]:
 
 
 class TaskBookingLabel(BaseModel):
+    """
+    This label is to be populated by any frontend during a task dispatch, by
+    being added to TaskRequest.labels, which in turn populates
+    TaskState.booking.labels, and can be used to display relevant information
+    needed for any frontends.
+    """
+
     description: TaskBookingLabelDescription
 
     @staticmethod