Skip to content

WIP removed the apparently-unnecessary anyOf blocks #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
777arc merged 4 commits into from
Mar 15, 2025
Merged

WIP removed the apparently-unnecessary anyOf blocks #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff7f45b
removed the apparently-unnecessary anyOf blocks
gmabey Jan 31, 2025
42d0c60
should fix doc generation script
gmabey Feb 5, 2025
53f851b
jq-ification
gmabey Feb 5, 2025
f9d603e
reverts maximum value to 2**63-1
gmabey Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs-generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,16 @@ def gen_fields(doc, d):
doc.append("\n\n")
doc.append(NoEscape("\\rowcolors{1}{}{lightblue}"))
with doc.create(Tabular("lllp{3.8in}")) as table:
gen_table(table, data["properties"]["captures"]["items"]["anyOf"][0])
gen_fields(doc, data["properties"]["captures"]["items"]["anyOf"][0])
gen_table(table, data["properties"]["captures"]["items"])
gen_fields(doc, data["properties"]["captures"]["items"])

with doc.create(Subsection("Annotations Array")):
doc.append(NoEscape(add_code_tags(data["properties"]["annotations"]["description"])))
doc.append("\n\n")
doc.append(NoEscape("\\rowcolors{1}{}{lightblue}"))
with doc.create(Tabular("lllp{3.8in}")) as table:
gen_table(table, data["properties"]["annotations"]["items"]["anyOf"][0])
gen_fields(doc, data["properties"]["annotations"]["items"]["anyOf"][0])
gen_table(table, data["properties"]["annotations"]["items"])
gen_fields(doc, data["properties"]["annotations"]["items"])

with doc.create(Subsection("SigMF Collection Format")):
doc.append(NoEscape(add_code_tags(data_collection["properties"]["collection"]["description"])))
Expand All @@ -158,8 +158,8 @@ def gen_fields(doc, d):
doc.append("\n\n")
doc.append(NoEscape("\\rowcolors{1}{}{lightblue}"))
with doc.create(Tabular("lllp{3.8in}")) as table:
gen_table(table, data_antenna["properties"]["annotations"]["items"]["anyOf"][0])
gen_fields(doc, data_antenna["properties"]["annotations"]["items"]["anyOf"][0])
gen_table(table, data_antenna["properties"]["annotations"]["items"])
gen_fields(doc, data_antenna["properties"]["annotations"]["items"])

doc.append(NoEscape("\\nn"))
doc.append(NoEscape(add_code_tags(data_antenna["properties"]["collection"]["description"])))
Expand Down
36 changes: 16 additions & 20 deletions extensions/antenna-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
"global": {
"description": "The following names are specified in the `antenna` namespace and should be used in the `global` object:",
"type": "object",
"required": ["antenna:model"],
"required": [
"antenna:model"
],
"properties": {
"antenna:model": {
"description": "Antenna make and model number. E.g. ARA CSB-16, L-com HG3512UP-NF.",
Expand Down Expand Up @@ -83,26 +85,20 @@
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"description": "The annotations value is an array of annotation segment objects that describe anything regarding the signal data not part of the Captures and Global objects. It MUST be sorted by the value of each Annotation Segment's `core:sample_start` key, ascending.",
"type": "object",
"properties": {
"antenna:azimuth_angle": {
"description": "Angle of main beam in azimuthal plane from North, in degrees.",
"type": "number"
},
"antenna:elevation_angle": {
"description": "Angle of main beam in elevation plane from horizontal, in degrees.",
"type": "number"
},
"antenna:polarization": {
"description": "E.g. \"vertical\", \"horizontal\", \"slant-45\", \"left-hand circular\", \"right-hand circular\".",
"type": "string"
}
}
"properties": {
"antenna:azimuth_angle": {
"description": "Angle of main beam in azimuthal plane from North, in degrees.",
"type": "number"
},
"antenna:elevation_angle": {
"description": "Angle of main beam in elevation plane from horizontal, in degrees.",
"type": "number"
},
"antenna:polarization": {
"description": "E.g. \"vertical\", \"horizontal\", \"slant-45\", \"left-hand circular\", \"right-hand circular\".",
"type": "string"
}
]
}
}
},
"collection": {
Expand Down
Loading