From 013d8802813dc6dac54faaba0bb0903d4a39d9fc Mon Sep 17 00:00:00 2001 From: Ekrem Seren Date: Thu, 7 Dec 2023 04:15:30 +0300 Subject: [PATCH] [DIAGRAMS] add diagrams to every proto file --- .../cmp/services/accommodation/v1alpha1/property_types.proto | 2 ++ proto/cmp/services/accommodation/v1alpha1/search.proto | 2 ++ .../services/accommodation/v1alpha1/search_option_types.proto | 2 ++ proto/cmp/services/accommodation/v1alpha1/unit_types.proto | 2 ++ proto/cmp/services/activity/v1alpha1/search.proto | 2 ++ .../cmp/services/activity/v1alpha1/search_option_types.proto | 2 ++ proto/cmp/services/network/v1alpha1/fee.proto | 2 ++ .../cmp/services/partner/v1alpha1/partner_configuration.proto | 2 ++ proto/cmp/services/ping/v1alpha1/ping.proto | 2 ++ proto/cmp/services/transport/v1alpha1/search.proto | 2 ++ .../cmp/services/transport/v1alpha1/search_option_types.proto | 2 ++ proto/cmp/services/transport/v1alpha1/source_types.proto | 2 ++ proto/cmp/services/transport/v1alpha1/trip_types.proto | 2 ++ proto/cmp/types/v1alpha1/asset.proto | 2 ++ proto/cmp/types/v1alpha1/cancel_policy.proto | 2 ++ proto/cmp/types/v1alpha1/common.proto | 2 ++ proto/cmp/types/v1alpha1/country.proto | 2 ++ proto/cmp/types/v1alpha1/currency.proto | 2 ++ proto/cmp/types/v1alpha1/date.proto | 2 ++ proto/cmp/types/v1alpha1/datetime_range.proto | 2 ++ proto/cmp/types/v1alpha1/distance.proto | 4 +++- proto/cmp/types/v1alpha1/filter.proto | 2 ++ proto/cmp/types/v1alpha1/fulfillment.proto | 2 ++ proto/cmp/types/v1alpha1/language.proto | 2 ++ proto/cmp/types/v1alpha1/location.proto | 2 ++ proto/cmp/types/v1alpha1/mealplan.proto | 2 ++ proto/cmp/types/v1alpha1/partner.proto | 2 ++ proto/cmp/types/v1alpha1/price.proto | 2 ++ proto/cmp/types/v1alpha1/rate.proto | 2 ++ proto/cmp/types/v1alpha1/search.proto | 2 ++ proto/cmp/types/v1alpha1/service_fact.proto | 2 ++ proto/cmp/types/v1alpha1/sorting.proto | 2 ++ proto/cmp/types/v1alpha1/time.proto | 2 ++ proto/cmp/types/v1alpha1/token.proto | 2 ++ proto/cmp/types/v1alpha1/travel_period.proto | 2 ++ proto/cmp/types/v1alpha1/traveller.proto | 2 ++ proto/cmp/types/v1alpha1/uuid.proto | 2 ++ proto/cmp/types/v1alpha1/wallet.proto | 2 ++ 38 files changed, 77 insertions(+), 1 deletion(-) diff --git a/proto/cmp/services/accommodation/v1alpha1/property_types.proto b/proto/cmp/services/accommodation/v1alpha1/property_types.proto index c979c5c6..4bbd4f9d 100644 --- a/proto/cmp/services/accommodation/v1alpha1/property_types.proto +++ b/proto/cmp/services/accommodation/v1alpha1/property_types.proto @@ -9,6 +9,8 @@ import "cmp/types/v1alpha1/price.proto"; // ### Property Info message type // // Represents basic property info +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/property_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/property_types.proto.dot.svg) message PropertyInfo { // Name of the property string property_name = 1; diff --git a/proto/cmp/services/accommodation/v1alpha1/search.proto b/proto/cmp/services/accommodation/v1alpha1/search.proto index 3953f403..aa9af8de 100644 --- a/proto/cmp/services/accommodation/v1alpha1/search.proto +++ b/proto/cmp/services/accommodation/v1alpha1/search.proto @@ -26,6 +26,8 @@ import "cmp/types/v1alpha1/search.proto"; // // Developers leveraging this message type should ensure proper validation and handling, especially considering fields // that are still under review, like `speech_request`. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/search.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/search.proto.dot.svg) message AccommodationSearchRequest { // Message Header. Contains api version, message info string and end-user wallet address cmp.types.v1alpha1.Header header = 1; diff --git a/proto/cmp/services/accommodation/v1alpha1/search_option_types.proto b/proto/cmp/services/accommodation/v1alpha1/search_option_types.proto index 36e6a8c5..8de5260b 100644 --- a/proto/cmp/services/accommodation/v1alpha1/search_option_types.proto +++ b/proto/cmp/services/accommodation/v1alpha1/search_option_types.proto @@ -11,6 +11,8 @@ import "cmp/types/v1alpha1/rate.proto"; // // This type represents a search result and is used in the // `AccommodationSearchResponse` message. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/search_option_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/search_option_types.proto.dot.svg) message AccommodationSearchOption { // Option ID for the search option. This is an increasing number starting at 0 and // increasing by 1 for every search result. diff --git a/proto/cmp/services/accommodation/v1alpha1/unit_types.proto b/proto/cmp/services/accommodation/v1alpha1/unit_types.proto index 3f8915de..c9160477 100644 --- a/proto/cmp/services/accommodation/v1alpha1/unit_types.proto +++ b/proto/cmp/services/accommodation/v1alpha1/unit_types.proto @@ -18,6 +18,8 @@ import "cmp/types/v1alpha1/traveller.proto"; // multi-room requests Ex: one request for 2 rooms for 4 adults, 2 in each room. // A unit can also be a different property in a multi-property request for holiday homes. // Ex: 1 house for 4 persons and another house for 6 persons. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/unit_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/accommodation/v1alpha1/unit_types.proto.dot.svg) message Unit { // Unit Type // Ex: `UnitType.UNIT_TYPE_ROOM` diff --git a/proto/cmp/services/activity/v1alpha1/search.proto b/proto/cmp/services/activity/v1alpha1/search.proto index 9391db57..52f5d75c 100644 --- a/proto/cmp/services/activity/v1alpha1/search.proto +++ b/proto/cmp/services/activity/v1alpha1/search.proto @@ -20,6 +20,8 @@ import "cmp/types/v1alpha1/traveller.proto"; // ### Activity Search Request // // Search request for Activities +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/activity/v1alpha1/search.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/activity/v1alpha1/search.proto.dot.svg) message ActivitySearchRequest { // Message Header. Contains api version, message info string and end-user wallet address cmp.types.v1alpha1.Header header = 1; diff --git a/proto/cmp/services/activity/v1alpha1/search_option_types.proto b/proto/cmp/services/activity/v1alpha1/search_option_types.proto index 19c6df63..40174a28 100644 --- a/proto/cmp/services/activity/v1alpha1/search_option_types.proto +++ b/proto/cmp/services/activity/v1alpha1/search_option_types.proto @@ -11,6 +11,8 @@ import "google/protobuf/timestamp.proto"; // // This type represents a search result and is used in the // `ActivitySearchResponse` message. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/activity/v1alpha1/search_option_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/activity/v1alpha1/search_option_types.proto.dot.svg) message ActivitySearchOption { // Option ID for the search option. This is an increasing number starting at 0 and // increasing by 1 for every search result. diff --git a/proto/cmp/services/network/v1alpha1/fee.proto b/proto/cmp/services/network/v1alpha1/fee.proto index dd9cfc0a..ac8e3eac 100644 --- a/proto/cmp/services/network/v1alpha1/fee.proto +++ b/proto/cmp/services/network/v1alpha1/fee.proto @@ -4,6 +4,8 @@ package cmp.services.network.v1alpha1; import "cmp/types/v1alpha1/asset.proto"; +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/network/v1alpha1/fee.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/network/v1alpha1/fee.proto.dot.svg) message NetworkFee { // Network fee, unit is nCAM // 1 CAM == 1 000 000 000 nCAM diff --git a/proto/cmp/services/partner/v1alpha1/partner_configuration.proto b/proto/cmp/services/partner/v1alpha1/partner_configuration.proto index b1f5dd2f..7070b5cc 100644 --- a/proto/cmp/services/partner/v1alpha1/partner_configuration.proto +++ b/proto/cmp/services/partner/v1alpha1/partner_configuration.proto @@ -4,6 +4,8 @@ package cmp.services.partner.v1alpha1; import "cmp/types/v1alpha1/partner.proto"; +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/partner/v1alpha1/partner_configuration.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/partner/v1alpha1/partner_configuration.proto.dot.svg) message PartnerConfiguration { // List of partners from the on-chain Partner Configuration repeated cmp.types.v1alpha1.Partner partners = 1; diff --git a/proto/cmp/services/ping/v1alpha1/ping.proto b/proto/cmp/services/ping/v1alpha1/ping.proto index 92b3f487..cb4bcd41 100644 --- a/proto/cmp/services/ping/v1alpha1/ping.proto +++ b/proto/cmp/services/ping/v1alpha1/ping.proto @@ -9,6 +9,8 @@ import "google/protobuf/timestamp.proto"; // The ping message is designed to test the availability of a provider service // and to test the network latency as in the gRPC metadata information the // DateTime is stored of each hop. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/ping/v1alpha1/ping.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/ping/v1alpha1/ping.proto.dot.svg) message PingRequest { // Message Header // Contains api version, message info string and end user wallet address diff --git a/proto/cmp/services/transport/v1alpha1/search.proto b/proto/cmp/services/transport/v1alpha1/search.proto index 9d17edab..3454ec55 100644 --- a/proto/cmp/services/transport/v1alpha1/search.proto +++ b/proto/cmp/services/transport/v1alpha1/search.proto @@ -17,6 +17,8 @@ import "cmp/types/v1alpha1/search.proto"; import "cmp/types/v1alpha1/traveller.proto"; // ### Transport Search Request +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/search.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/search.proto.dot.svg) message TransportSearchRequest { // Message Header. Contains api version, message info string and end-user wallet address cmp.types.v1alpha1.Header header = 1; diff --git a/proto/cmp/services/transport/v1alpha1/search_option_types.proto b/proto/cmp/services/transport/v1alpha1/search_option_types.proto index 9a75c59c..83d7bafe 100644 --- a/proto/cmp/services/transport/v1alpha1/search_option_types.proto +++ b/proto/cmp/services/transport/v1alpha1/search_option_types.proto @@ -12,6 +12,8 @@ import "cmp/types/v1alpha1/service_fact.proto"; import "cmp/types/v1alpha1/traveller.proto"; // Transport search result +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/search_option_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/search_option_types.proto.dot.svg) message TransportSearchOption { // Unique option ID for this search int32 option_id = 1; diff --git a/proto/cmp/services/transport/v1alpha1/source_types.proto b/proto/cmp/services/transport/v1alpha1/source_types.proto index fb10dcff..239764f0 100644 --- a/proto/cmp/services/transport/v1alpha1/source_types.proto +++ b/proto/cmp/services/transport/v1alpha1/source_types.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.services.transport.v1alpha1; // ### Content Source Type message type +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/source_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/source_types.proto.dot.svg) enum ContentSourceType { CONTENT_SOURCE_TYPE_UNSPECIFIED = 0; CONTENT_SOURCE_TYPE_GDS = 1; diff --git a/proto/cmp/services/transport/v1alpha1/trip_types.proto b/proto/cmp/services/transport/v1alpha1/trip_types.proto index 6cab6955..4c5d5efa 100644 --- a/proto/cmp/services/transport/v1alpha1/trip_types.proto +++ b/proto/cmp/services/transport/v1alpha1/trip_types.proto @@ -10,6 +10,8 @@ import "google/protobuf/timestamp.proto"; // ### Trip message type // This message type represents a one way trip, either travelling or returning. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/trip_types.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/services/transport/v1alpha1/trip_types.proto.dot.svg) message Trip { // Departure min time google.protobuf.Timestamp departure_min_time = 1; diff --git a/proto/cmp/types/v1alpha1/asset.proto b/proto/cmp/types/v1alpha1/asset.proto index 1fcee950..c2e892ed 100644 --- a/proto/cmp/types/v1alpha1/asset.proto +++ b/proto/cmp/types/v1alpha1/asset.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // An on-chain asset on the Camino Network +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/asset.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/asset.proto.dot.svg) message Asset { string asset_id = 1; string name = 2; diff --git a/proto/cmp/types/v1alpha1/cancel_policy.proto b/proto/cmp/types/v1alpha1/cancel_policy.proto index df590b4b..53912933 100644 --- a/proto/cmp/types/v1alpha1/cancel_policy.proto +++ b/proto/cmp/types/v1alpha1/cancel_policy.proto @@ -10,6 +10,8 @@ import "google/protobuf/timestamp.proto"; // - a simple boolean for refundable or non-refundable options // - a "free cancellation upto" DateTime // - complete cancellation policies with from/to DateTime stamps +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/cancel_policy.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/cancel_policy.proto.dot.svg) message CancelPolicy { // Cancellation policy refundable or not bool refundable = 1; diff --git a/proto/cmp/types/v1alpha1/common.proto b/proto/cmp/types/v1alpha1/common.proto index 0cb007dd..89bb63a8 100644 --- a/proto/cmp/types/v1alpha1/common.proto +++ b/proto/cmp/types/v1alpha1/common.proto @@ -6,6 +6,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // ### CM Message Header +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/common.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/common.proto.dot.svg) message Header { // Protocol Version Version version = 1; diff --git a/proto/cmp/types/v1alpha1/country.proto b/proto/cmp/types/v1alpha1/country.proto index ee638c8c..895a5738 100644 --- a/proto/cmp/types/v1alpha1/country.proto +++ b/proto/cmp/types/v1alpha1/country.proto @@ -6,6 +6,8 @@ package cmp.types.v1alpha1; // // Country options according to ISO 3166-1, with the 31 most popular countries // first, using fewer bytes in the code thus reducing message size. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/country.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/country.proto.dot.svg) enum Country { COUNTRY_UNSPECIFIED = 0; diff --git a/proto/cmp/types/v1alpha1/currency.proto b/proto/cmp/types/v1alpha1/currency.proto index 54129ddc..63b14d66 100644 --- a/proto/cmp/types/v1alpha1/currency.proto +++ b/proto/cmp/types/v1alpha1/currency.proto @@ -6,6 +6,8 @@ package cmp.types.v1alpha1; // // First 20 currencies are the most traded currencies in the world. // This is done to optimize the size of the protobuf message size. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/currency.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/currency.proto.dot.svg) enum Currency { CURRENCY_UNSPECIFIED = 0; // Placeholder or unspecified currency diff --git a/proto/cmp/types/v1alpha1/date.proto b/proto/cmp/types/v1alpha1/date.proto index 7826f20d..7f71393d 100644 --- a/proto/cmp/types/v1alpha1/date.proto +++ b/proto/cmp/types/v1alpha1/date.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // Date Message +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/date.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/date.proto.dot.svg) message Date { int32 year = 1; int32 month = 2; diff --git a/proto/cmp/types/v1alpha1/datetime_range.proto b/proto/cmp/types/v1alpha1/datetime_range.proto index 17d362b5..999a83d4 100644 --- a/proto/cmp/types/v1alpha1/datetime_range.proto +++ b/proto/cmp/types/v1alpha1/datetime_range.proto @@ -5,6 +5,8 @@ package cmp.types.v1alpha1; import "google/protobuf/timestamp.proto"; // Date Message +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/datetime_range.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/datetime_range.proto.dot.svg) message DateTimeRange { google.protobuf.Timestamp start_datetime = 1; google.protobuf.Timestamp end_datetime = 2; diff --git a/proto/cmp/types/v1alpha1/distance.proto b/proto/cmp/types/v1alpha1/distance.proto index dce98c7d..641c761b 100644 --- a/proto/cmp/types/v1alpha1/distance.proto +++ b/proto/cmp/types/v1alpha1/distance.proto @@ -2,7 +2,9 @@ syntax = "proto3"; package cmp.types.v1alpha1; -// Distance unit and value pair +// ### Distance unit and value pair +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/distance.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/distance.proto.dot.svg) message Distance { int32 value = 1; DistanceUnit distance_unit = 2; diff --git a/proto/cmp/types/v1alpha1/filter.proto b/proto/cmp/types/v1alpha1/filter.proto index 83365c2f..b371f491 100644 --- a/proto/cmp/types/v1alpha1/filter.proto +++ b/proto/cmp/types/v1alpha1/filter.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // Upfront filtering of possible search options in the search response +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/filter.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/filter.proto.dot.svg) message Filter { // Filter code agreed between provider and distributor // FIXME: Should filters be standardized per vertical? diff --git a/proto/cmp/types/v1alpha1/fulfillment.proto b/proto/cmp/types/v1alpha1/fulfillment.proto index 932b6ff1..e1600e72 100644 --- a/proto/cmp/types/v1alpha1/fulfillment.proto +++ b/proto/cmp/types/v1alpha1/fulfillment.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // ### Fulfillment message type +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/fulfillment.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/fulfillment.proto.dot.svg) message Fulfillment { // Link type // Ex: "LG" or "TC" diff --git a/proto/cmp/types/v1alpha1/language.proto b/proto/cmp/types/v1alpha1/language.proto index 5df32f2e..340a4307 100644 --- a/proto/cmp/types/v1alpha1/language.proto +++ b/proto/cmp/types/v1alpha1/language.proto @@ -7,6 +7,8 @@ package cmp.types.v1alpha1; // Language options according to ISO 639-1, with the 26 most popular languages first. // This is done to use the smaller values more frequently and thus consume less bytes // for this field. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/language.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/language.proto.dot.svg) enum Language { LANGUAGE_UNSPECIFIED = 0; LANGUAGE_AR = 1; // Arabic diff --git a/proto/cmp/types/v1alpha1/location.proto b/proto/cmp/types/v1alpha1/location.proto index 3ee57a86..8a1fd931 100644 --- a/proto/cmp/types/v1alpha1/location.proto +++ b/proto/cmp/types/v1alpha1/location.proto @@ -8,6 +8,8 @@ import "cmp/types/v1alpha1/distance.proto"; // ### Coordinate // // Represents a geographic location +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/location.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/location.proto.dot.svg) message Coordinate { // The latitude in degrees. It must be in the range [-90.0, +90.0]. double latitude = 1; diff --git a/proto/cmp/types/v1alpha1/mealplan.proto b/proto/cmp/types/v1alpha1/mealplan.proto index cdac78d2..bfad518d 100644 --- a/proto/cmp/types/v1alpha1/mealplan.proto +++ b/proto/cmp/types/v1alpha1/mealplan.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // Meal Plan message type +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/mealplan.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/mealplan.proto.dot.svg) message MealPlan { // Meal Plan Code // Ex: `MealPlan.MEAL_PLAN_AI` for "All Inclusive" meal plan. diff --git a/proto/cmp/types/v1alpha1/partner.proto b/proto/cmp/types/v1alpha1/partner.proto index b2d3c9ca..5b15b7a8 100644 --- a/proto/cmp/types/v1alpha1/partner.proto +++ b/proto/cmp/types/v1alpha1/partner.proto @@ -6,6 +6,8 @@ import "cmp/types/v1alpha1/token.proto"; import "cmp/types/v1alpha1/wallet.proto"; // ### Partner message type +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/partner.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/partner.proto.dot.svg) message Partner { // Short name of the partner. Ex: Chain4Travel string short_name = 1; diff --git a/proto/cmp/types/v1alpha1/price.proto b/proto/cmp/types/v1alpha1/price.proto index 68e13922..19358b17 100644 --- a/proto/cmp/types/v1alpha1/price.proto +++ b/proto/cmp/types/v1alpha1/price.proto @@ -11,6 +11,8 @@ import "cmp/types/v1alpha1/currency.proto"; // // Breakdown is a recursively inhereted object of PriceDetail. This way complex // pricing structures can be represented. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/price.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/price.proto.dot.svg) message PriceDetail { // Principle price element Price price = 1; diff --git a/proto/cmp/types/v1alpha1/rate.proto b/proto/cmp/types/v1alpha1/rate.proto index 244e507d..8ca90225 100644 --- a/proto/cmp/types/v1alpha1/rate.proto +++ b/proto/cmp/types/v1alpha1/rate.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // Rate Rule +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/rate.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/rate.proto.dot.svg) message RateRule { RateRuleType rate_type = 1; string rate_description = 2; diff --git a/proto/cmp/types/v1alpha1/search.proto b/proto/cmp/types/v1alpha1/search.proto index 8d946898..5b2349a9 100644 --- a/proto/cmp/types/v1alpha1/search.proto +++ b/proto/cmp/types/v1alpha1/search.proto @@ -10,6 +10,8 @@ import "cmp/types/v1alpha1/sorting.proto"; import "cmp/types/v1alpha1/uuid.proto"; // Search parameters for the search requests +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/search.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/search.proto.dot.svg) message SearchParameters { // Requested currency in which prices have to be supplied in the response according to ISO 4217 Currency codes Currency currency = 1; diff --git a/proto/cmp/types/v1alpha1/service_fact.proto b/proto/cmp/types/v1alpha1/service_fact.proto index d398855e..3767f8b2 100644 --- a/proto/cmp/types/v1alpha1/service_fact.proto +++ b/proto/cmp/types/v1alpha1/service_fact.proto @@ -30,6 +30,8 @@ import "cmp/types/v1alpha1/price.proto"; // "description" : "Wireless internet access (WIFI)" // }, // ``` +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/service_fact.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/service_fact.proto.dot.svg) message ServiceFact { string description = 1; Price price = 2; diff --git a/proto/cmp/types/v1alpha1/sorting.proto b/proto/cmp/types/v1alpha1/sorting.proto index 8d8dcec0..04b3bccf 100644 --- a/proto/cmp/types/v1alpha1/sorting.proto +++ b/proto/cmp/types/v1alpha1/sorting.proto @@ -4,6 +4,8 @@ package cmp.types.v1alpha1; // Sorting type and order: this is being used in requests to specify the sorting // required in the response. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/sorting.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/sorting.proto.dot.svg) message Sorting { SortingType sorting_type = 1; SortingOrder sorting_order = 2; diff --git a/proto/cmp/types/v1alpha1/time.proto b/proto/cmp/types/v1alpha1/time.proto index 1a308411..7a9db7a1 100644 --- a/proto/cmp/types/v1alpha1/time.proto +++ b/proto/cmp/types/v1alpha1/time.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // Time Message +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/time.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/time.proto.dot.svg) message Time { int32 hours = 1; int32 minutes = 2; diff --git a/proto/cmp/types/v1alpha1/token.proto b/proto/cmp/types/v1alpha1/token.proto index a462c013..46b46992 100644 --- a/proto/cmp/types/v1alpha1/token.proto +++ b/proto/cmp/types/v1alpha1/token.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // ERC20 Token Reference +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/token.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/token.proto.dot.svg) message ERC20Token { string contract_address = 1; string name = 2; diff --git a/proto/cmp/types/v1alpha1/travel_period.proto b/proto/cmp/types/v1alpha1/travel_period.proto index df88ecb3..0b256645 100644 --- a/proto/cmp/types/v1alpha1/travel_period.proto +++ b/proto/cmp/types/v1alpha1/travel_period.proto @@ -5,6 +5,8 @@ package cmp.types.v1alpha1; import "cmp/types/v1alpha1/date.proto"; // Travel Period +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/travel_period.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/travel_period.proto.dot.svg) message TravelPeriod { cmp.types.v1alpha1.Date start_date = 1; cmp.types.v1alpha1.Date end_date = 2; diff --git a/proto/cmp/types/v1alpha1/traveller.proto b/proto/cmp/types/v1alpha1/traveller.proto index 9c95cc7a..3caf72d9 100644 --- a/proto/cmp/types/v1alpha1/traveller.proto +++ b/proto/cmp/types/v1alpha1/traveller.proto @@ -6,6 +6,8 @@ import "cmp/types/v1alpha1/country.proto"; import "cmp/types/v1alpha1/date.proto"; // Traveller +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/traveller.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/traveller.proto.dot.svg) message Traveller { // Guest number, the lowest number is the lead-pax int32 guest_number = 1; diff --git a/proto/cmp/types/v1alpha1/uuid.proto b/proto/cmp/types/v1alpha1/uuid.proto index bed6ea09..fb49126a 100644 --- a/proto/cmp/types/v1alpha1/uuid.proto +++ b/proto/cmp/types/v1alpha1/uuid.proto @@ -4,6 +4,8 @@ package cmp.types.v1alpha1; // ### UUID message type // This must be a UUID according to RFC 4122 standard. +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/uuid.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/uuid.proto.dot.svg) message UUID { string value = 1; } diff --git a/proto/cmp/types/v1alpha1/wallet.proto b/proto/cmp/types/v1alpha1/wallet.proto index 09f45b41..22eafad0 100644 --- a/proto/cmp/types/v1alpha1/wallet.proto +++ b/proto/cmp/types/v1alpha1/wallet.proto @@ -3,6 +3,8 @@ syntax = "proto3"; package cmp.types.v1alpha1; // Address and public key for a wallet +// ![Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/wallet.proto.dot.xs.svg) +// [Open Message Diagram](https://storage.googleapis.com/docs-cmp-files/diagrams/proto/cmp/types/v1alpha1/wallet.proto.dot.svg) message WalletAddress { // Wallet address // Example: