openapi: Document /register and add tests for it.

We'll want to do more iteration on the details here, but this is a
huge milestone.

Fixes #14188.

zerver/openapi/openapi.py

@@ -18,7 +18,7 @@ OPENAPI_SPEC_PATH = os.path.abspath(os.path.join(
 EXCLUDE_UNDOCUMENTED_ENDPOINTS = {"/realm/emoji/{emoji_name}:delete", "/users:patch"}
 # Consists of endpoints with some documentation remaining.
 # These are skipped but return true as the validator cannot exclude objects
-EXCLUDE_DOCUMENTED_ENDPOINTS = {"/register:post", "/settings/notifications:patch"}
+EXCLUDE_DOCUMENTED_ENDPOINTS = {"/settings/notifications:patch"}
 class OpenAPISpec():
     def __init__(self, path: str) -> None:
         self.path = path

zerver/openapi/python_examples.py

@@ -871,6 +871,15 @@ def update_message_flags(client: Client) -> None:
     validate_against_openapi_schema(result, '/messages/flags', 'post',
                                     '200')
 
+def register_queue_all_events(client: Client) -> str:
+
+    # Register the queue and get all events
+    # Mainly for verifying schema of /register.
+    result = client.register()
+
+    validate_against_openapi_schema(result, '/register', 'post', '200')
+    return result['queue_id']
+
 @openapi_test_function("/register:post")
 def register_queue(client: Client) -> str:
 
@@ -1215,6 +1224,7 @@ def test_queues(client: Client) -> None:
     # the effort to come up with asynchronous logic for testing those here.
     queue_id = register_queue(client)
     deregister_queue(client, queue_id)
+    register_queue_all_events(client)
 
 def test_server_organizations(client: Client) -> None: