Skip to content

Commit 91c4f73

Browse files
Update generate_schema_docs & parser descriptions (#1065)
* Use ndt5 v2 type in generate schema docs * Remove parser fields from Scamper1Row * Add parser descriptions for Filename and GitCommit to toplevel.yaml
1 parent 075a4de commit 91c4f73

File tree

4 files changed

+7
-16
lines changed

4 files changed

+7
-16
lines changed

cmd/generate_schema_docs/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ func main() {
152152
generators := []schemaGenerator{
153153
&schema.AnnotationRow{},
154154
&schema.HopAnnotation1Row{},
155-
&schema.NDT5ResultRow{},
155+
&schema.NDT5ResultRowV2{},
156156
&schema.NDT7ResultRow{},
157157
&schema.TCPRow{},
158158
&schema.PTTest{},

cmd/generate_schema_docs/main_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func Test_main(t *testing.T) {
3535
main() // no crash == working
3636

3737
files := [4]string{
38-
"schema_ndt5resultrow.md",
38+
"schema_ndt5resultrowv2.md",
3939
"schema_pcaprow.md",
4040
"schema_hopannotation1row.md",
4141
"schema_scamper1row.md",

schema/descriptions/Scamper1Row.yaml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
11
raw.Tracelb.Nodes.HopID:
22
Description: Daily unique identifier to join traceroute datasets with Hop Annotations.
3-
# Descriptions of the following fields are provided in toplevel.yaml.
4-
#id:
5-
#parser:
6-
#parser.Version:
7-
#parser.Time:
8-
#parser.ArchiveURL:
9-
#date:
10-
#raw:
11-
parser.Filename:
12-
Description:
13-
parser.Priority:
14-
Description:
15-
parser.GitCommit:
16-
Description:
173
raw.Metadata:
184
Description:
195
raw.Metadata.UUID:

schema/descriptions/toplevel.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ parser.Time:
3333
parser.ArchiveURL:
3434
Description: The Google Cloud Storage URL to the archive containing the
3535
Filename for this row.
36+
parser.Filename:
37+
Description: The name of the file within the ArchiveURL originally created by the measurement service.
38+
Results in the raw record are derived from measurements in this file.
39+
parser.GitCommit:
40+
Description: The git commit of this build of the parser.
3641

3742
server:
3843
Description: Location information about the M-Lab server that collected the

0 commit comments

Comments
 (0)