From 596e217f453b99cc82a620973f56c9915c9c60a2 Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Thu, 19 Dec 2024 23:25:44 +0000 Subject: [PATCH 1/8] feat: Add ReportMetadta to MeasurementSpec --- .../api/v2alpha/measurement_spec.proto | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index c175221c..43978a00 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -144,4 +144,29 @@ message MeasurementSpec { (google.api.resource_reference).type = "halo.wfanet.org/ModelLine", (google.api.field_behavior) = IMMUTABLE ]; + + // Provides the report and metric for which this Measurement was created + message ReportMetadata { + // The Report + string report = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { type: "halo.wfanet.org/Report" } + ]; + // The Metric + string metric = 2 [ + (google.api.field_behavior) = REQUIRED, + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { type: "halo.wfanet.org/Metric" } + ]; + } + // Provides additional information about the artifacts upstream of this + // Measurement. + // + // When present the report_metadata can be used by EDPs to group Measurements + // into logical units to help optimize fulfilment processes. + ReportMetadata report_metadata = 1 [ + (google.api.field_behavior) = OPTIONAL, + (google.api.field_behavior) = IMMUTABLE + ]; } From 5f4146dc4957256cf799db4211b25657058fb822 Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Thu, 19 Dec 2024 23:29:38 +0000 Subject: [PATCH 2/8] update comment --- .../proto/wfa/measurement/api/v2alpha/measurement_spec.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index 43978a00..3c427fac 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -160,8 +160,8 @@ message MeasurementSpec { (google.api.resource_reference) = { type: "halo.wfanet.org/Metric" } ]; } - // Provides additional information about the artifacts upstream of this - // Measurement. + // Provides additional information about the Reporting artifacts upstream of + // this Measurement. // // When present the report_metadata can be used by EDPs to group Measurements // into logical units to help optimize fulfilment processes. From 65c21ee62711e4db9e2cce34e499ee53b59890eb Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Thu, 19 Dec 2024 23:39:52 +0000 Subject: [PATCH 3/8] update tag typo --- .../proto/wfa/measurement/api/v2alpha/measurement_spec.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index 3c427fac..aef92a52 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -165,7 +165,7 @@ message MeasurementSpec { // // When present the report_metadata can be used by EDPs to group Measurements // into logical units to help optimize fulfilment processes. - ReportMetadata report_metadata = 1 [ + ReportMetadata report_metadata = 10 [ (google.api.field_behavior) = OPTIONAL, (google.api.field_behavior) = IMMUTABLE ]; From c85f73cfd6c9441d547c2fc64f7a2ca71de93c8d Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Thu, 19 Dec 2024 23:48:36 +0000 Subject: [PATCH 4/8] update tag --- .../proto/wfa/measurement/api/v2alpha/measurement_spec.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index aef92a52..0ee58b53 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -165,7 +165,7 @@ message MeasurementSpec { // // When present the report_metadata can be used by EDPs to group Measurements // into logical units to help optimize fulfilment processes. - ReportMetadata report_metadata = 10 [ + ReportMetadata report_metadata = 11 [ (google.api.field_behavior) = OPTIONAL, (google.api.field_behavior) = IMMUTABLE ]; From 78065d7b1332eec878f8fe8e3d9b0a920e0320aa Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Fri, 20 Dec 2024 16:21:23 +0000 Subject: [PATCH 5/8] udpates from review --- .../measurement/api/v2alpha/measurement_spec.proto | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index 0ee58b53..2ceb461a 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -145,27 +145,26 @@ message MeasurementSpec { (google.api.field_behavior) = IMMUTABLE ]; - // Provides the report and metric for which this Measurement was created - message ReportMetadata { - // The Report + // Metadata provided by the Reporting System. + message ReportingMetadata { + // The resource name of containing Report string report = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { type: "halo.wfanet.org/Report" } ]; - // The Metric + // The resource name of the containing Metric string metric = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { type: "halo.wfanet.org/Metric" } ]; } - // Provides additional information about the Reporting artifacts upstream of - // this Measurement. + // Metadata provided by the Reporting System. // // When present the report_metadata can be used by EDPs to group Measurements // into logical units to help optimize fulfilment processes. - ReportMetadata report_metadata = 11 [ + ReportingMetadata reporting_metadata = 11 [ (google.api.field_behavior) = OPTIONAL, (google.api.field_behavior) = IMMUTABLE ]; From 738472e40f631eba0a3722161b994cc872886b0d Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Fri, 20 Dec 2024 16:23:12 +0000 Subject: [PATCH 6/8] more --- .../wfa/measurement/api/v2alpha/measurement_spec.proto | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index 2ceb461a..12e73934 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -145,15 +145,16 @@ message MeasurementSpec { (google.api.field_behavior) = IMMUTABLE ]; - // Metadata provided by the Reporting System. + // Metadata provided by the Reporting System that describes how the + // Measurement is being used. message ReportingMetadata { - // The resource name of containing Report + // The resource name of containing `Report` string report = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { type: "halo.wfanet.org/Report" } ]; - // The resource name of the containing Metric + // The resource name of the containing `Metric` string metric = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, From 5b0560b60ccd3ea2f8f956a7229504ee9cc98fca Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Fri, 20 Dec 2024 16:25:03 +0000 Subject: [PATCH 7/8] more grammar --- .../proto/wfa/measurement/api/v2alpha/measurement_spec.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index 12e73934..07fb8ea2 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -148,13 +148,13 @@ message MeasurementSpec { // Metadata provided by the Reporting System that describes how the // Measurement is being used. message ReportingMetadata { - // The resource name of containing `Report` + // Resource name of the containing `Report` string report = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { type: "halo.wfanet.org/Report" } ]; - // The resource name of the containing `Metric` + // Resource name of the containing `Metric` string metric = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, From fbb24a9552c5a01b261cd9b72051099c6ec5a5bd Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Fri, 20 Dec 2024 21:28:19 +0000 Subject: [PATCH 8/8] update resource ref --- .../wfa/measurement/api/v2alpha/measurement_spec.proto | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto index 07fb8ea2..82b57a00 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto @@ -152,13 +152,17 @@ message MeasurementSpec { string report = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { type: "halo.wfanet.org/Report" } + (google.api.resource_reference) = { + type: "reporting.halo-cmm.org/Report" + } ]; // Resource name of the containing `Metric` string metric = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { type: "halo.wfanet.org/Metric" } + (google.api.resource_reference) = { + type: "reporting.halo-cmm.org/Metric" + } ]; } // Metadata provided by the Reporting System.