openapi: Add comments on top of various OpenAPI doc files.

This is part of our standard approach for trying to make it easy for
folks to find relevant documentation on a system they're trying to
understand.
This commit is contained in:
Tim Abbott
2020-09-14 15:24:01 -07:00
parent 2bc3924672
commit f751acbec5
7 changed files with 56 additions and 2 deletions

View File

@@ -1,3 +1,9 @@
# Zulip's OpenAPI-based API documentation system is documented at
# https://zulip.readthedocs.io/en/latest/documentation/api.html
#
# This Python file wraps the test suite for Zulip's JavaScript API
# examples and validates the responses against our OpenAPI definitions.
import json
import os
import subprocess