From cf8a8c8811c716ed45cd249d57f0786e8b1a3137 Mon Sep 17 00:00:00 2001
From: Eeshan Garg <jerryguitarist@gmail.com>
Date: Fri, 29 Dec 2017 19:28:37 -0330
Subject: [PATCH] api docs: Document the GET /api/v1/get_stream_id endpoint.

This commit documents the /api/v1/get_stream_id endpoint.

Note that there is currently no way to interface with this
endpoint with zulip-js.
---
 templates/zerver/api/arguments.json   |  8 +++
 templates/zerver/api/get-stream-id.md | 93 +++++++++++++++++++++++++++
 templates/zerver/api/sidebar.md       |  1 +
 3 files changed, 102 insertions(+)
 create mode 100644 templates/zerver/api/get-stream-id.md

diff --git a/templates/zerver/api/arguments.json b/templates/zerver/api/arguments.json
index 45168c72b8..0675206918 100644
--- a/templates/zerver/api/arguments.json
+++ b/templates/zerver/api/arguments.json
@@ -70,5 +70,13 @@
             "required":"Optional",
             "example":"`True` or `False`"
         }
+    ],
+    "get-stream-id.md":[
+        {
+            "argument":"stream",
+            "description":"The name of the stream to retrieve the ID for.",
+            "required":"Required",
+            "example":"Denmark"
+        }
     ]
 }
diff --git a/templates/zerver/api/get-stream-id.md b/templates/zerver/api/get-stream-id.md
new file mode 100644
index 0000000000..8873cc2151
--- /dev/null
+++ b/templates/zerver/api/get-stream-id.md
@@ -0,0 +1,93 @@
+# Get stream ID
+
+Get the unique ID of a given stream.
+
+`GET {{ api_url }}/v1/get_stream_id`
+
+## Arguments
+
+**Note**: The following arguments are all URL query parameters.
+
+{generate_api_arguments_table|arguments.json|get-stream-id.md}
+
+## Usage examples
+
+<div class="code-section" markdown="1">
+<ul class="nav">
+<li data-language="curl">curl</li>
+<li data-language="python">Python</li>
+</ul>
+<div class="blocks">
+
+<div data-language="curl" markdown="1">
+
+```
+curl {{ api_url }}/v1/get_stream_id?stream=Denmark \
+    -u BOT_EMAIL_ADDRESS:BOT_API_KEY
+```
+</div>
+
+<div data-language="python" markdown="1">
+
+```python
+#!/usr/bin/env python
+
+import zulip
+import sys
+
+# Keyword arguments 'email' and 'api_key' are not required if you are using ~/.zuliprc
+client = zulip.Client(email="othello-bot@example.com",
+                      api_key="a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
+                      site="{{ api_url }}")
+
+# Get the ID of a given stream
+print(client.get_stream_id("Denmark"))
+```
+</div>
+
+</div>
+
+</div>
+
+## Response
+
+#### Return values
+
+* `stream_id`: The ID of the given stream.
+
+#### Example response
+
+A typical successful JSON response may look like:
+
+```
+{
+    'stream_id':15,
+    'result':'success',
+    'msg':''
+}
+```
+
+An example of a JSON response for when the supplied stream does not
+exist:
+
+```
+{
+    'code':'BAD_REQUEST',
+    'msg':"Invalid stream name 'nonexistent'",
+    'result':'error'
+}
+```
+
+An example of a JSON response for when the `stream` query parameter is
+not provided:
+
+```
+{
+    "msg":"Missing 'stream' argument",
+    "result":"error",
+    "var_name":"stream",
+    "code":"REQUEST_VARIABLE_MISSING"
+}
+```
+
+{!invalid-api-key-json-response.md!}
diff --git a/templates/zerver/api/sidebar.md b/templates/zerver/api/sidebar.md
index 5c7dd07b41..1f391f66ad 100644
--- a/templates/zerver/api/sidebar.md
+++ b/templates/zerver/api/sidebar.md
@@ -11,6 +11,7 @@
 #### Streams
 
 * [Get all streams](/api/get-all-streams)
+* [Get stream ID](/api/get-stream-id)
 
 ## Integrations