From 28262e15ae4dcf000591c2a06f91e87c1af4345b Mon Sep 17 00:00:00 2001 From: Sam Jaarsma Date: Thu, 7 Dec 2023 10:09:33 +0100 Subject: [PATCH] updated comments --- proto/cmp/services/accommodation/v1alpha1/search.proto | 6 +++--- .../cmp/services/accommodation/v1alpha1/unit_types.proto | 8 +++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/proto/cmp/services/accommodation/v1alpha1/search.proto b/proto/cmp/services/accommodation/v1alpha1/search.proto index aa9af8de..fbd6e8de 100644 --- a/proto/cmp/services/accommodation/v1alpha1/search.proto +++ b/proto/cmp/services/accommodation/v1alpha1/search.proto @@ -1,6 +1,6 @@ syntax = "proto3"; -// ## This is the package level description for Accommodation +// ## Accommodation // // The Accommodation Message Type is used for both hotels and holiday homes, often called short term rentals. // @@ -32,10 +32,10 @@ message AccommodationSearchRequest { // Message Header. Contains api version, message info string and end-user wallet address cmp.types.v1alpha1.Header header = 1; - // An identifier for external sessions, aiding in tracking and continuity across sessions. + // An identifier for external sessions, aiding in tracking and continuity across messages. string external_session_id = 2; - //FIXME: Should we also need to have `freetext` field here? + //FIXME: Should we also need to have `freetext` field here? Yes, we need the freetext and audio fields here // Search parameters. Example: inclusion of OnRequest options and inclusion of only the cheapest or all options. cmp.types.v1alpha1.SearchParameters search_parameters = 3; diff --git a/proto/cmp/services/accommodation/v1alpha1/unit_types.proto b/proto/cmp/services/accommodation/v1alpha1/unit_types.proto index c9160477..cc862fb0 100644 --- a/proto/cmp/services/accommodation/v1alpha1/unit_types.proto +++ b/proto/cmp/services/accommodation/v1alpha1/unit_types.proto @@ -81,12 +81,14 @@ message Unit { // Various provider and product specific filters can be provided here in // agreed name/value pairs - // FIXME: Should this be in SearchParameters instead of Unit or in both? Do we - // need per Unit filters? (We have this also in `SearchParameters` now) + // FIXME: Should this be in SearchParameters valid for the request and all units + // instead of Unit or in both? Do we need per Unit filters? + // We have this also in `SearchParameters` now. repeated cmp.types.v1alpha1.Filter filters = 19; // Cancel Policies - // FIXME: Should this be a list? Initial json definition had a single element. + // This is a list so that various policies can be expressed + // Ex. 10-5 days before arrival x€, 4-1 days before arrival y€ and 0 days before arrival z€ repeated cmp.types.v1alpha1.CancelPolicy cancel_policies = 20; // Free-text field to provide more detials for better offer personalization.