ExternalVendorCode/onefuzz
1
0
Fork 0
mirror of https://github.com/microsoft/onefuzz.git synced 2025-06-20 13:33:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ensure consistency in doc generation by always sorting json keys (#449)

Browse Source
This commit is contained in:
bmc-msft
2021-01-21 10:28:11 -05:00
committed by GitHub
parent b499b9b17d
commit 7e6415b15f
2 changed files with 1943 additions and 1936 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3798
docs/webhook_events.md
View File

File diff suppressed because it is too large Load Diff

15
src/pytypes/extra/generate-docs.py
View File

@ -223,7 +223,9 @@ def main():
"Each event will be submitted via HTTP POST to the user provided URL.",
)
typed(3, "Example", message.json(indent=4, exclude_none=True), "json")
typed(
3, "Example", message.json(indent=4, exclude_none=True, sort_keys=True), "json"
)
layer(2, "Event Types (EventType)")
event_map = {get_event_type(x).name: x for x in examples}
@ -236,10 +238,15 @@ def main():
for name in sorted(event_map.keys()):
example = event_map[name]
layer(3, name)
typed(4, "Example", example.json(indent=4, exclude_none=True), "json")
typed(4, "Schema", example.schema_json(indent=4), "json")
typed(
4,
"Example",
example.json(indent=4, exclude_none=True, sort_keys=True),
"json",
)
typed(4, "Schema", example.schema_json(indent=4, sort_keys=True), "json")
typed(2, "Full Event Schema", message.schema_json(indent=4), "json")
typed(2, "Full Event Schema", message.schema_json(indent=4, sort_keys=True), "json")
if __name__ == "__main__":