Skip to content

Commit

Permalink
updated comments
Browse files Browse the repository at this point in the history
  • Loading branch information
SamJaarsma committed Dec 7, 2023
1 parent 013d880 commit 28262e1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions proto/cmp/services/accommodation/v1alpha1/search.proto
Original file line number Diff line number Diff line change
@@ -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.
//
Expand Down Expand Up @@ -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;
Expand Down
8 changes: 5 additions & 3 deletions proto/cmp/services/accommodation/v1alpha1/unit_types.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 28262e1

Please sign in to comment.