add enterprise search indexing endpoint (#381)

resolves #375
octokit · Jun 26, 2016 · cf76302 · cf76302
1 parent 1f68401
commit cf76302
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/doc/apidoc.js b/doc/apidoc.js
@@ -599,6 +599,17 @@ github.enterprise.createOrg({ ... });
 github.enterprise.getLicense({ ... });
  */
 
+/**
+ * @api {post} /staff/indexing_jobs queueIndexingJob
+ * @apiName queueIndexingJob
+ * @apiDescription Queue an indexing job
+ * @apiGroup enterprise
+ *
+ * @apiParam {String} target  A string representing the item to index.
+ * @apiExample {js} ex:
+github.enterprise.queueIndexingJob({ ... });
+ */
+
 /**
  * @api {get} /enterprise/stats/:type stats
  * @apiName stats

diff --git a/lib/routes.json b/lib/routes.json
@@ -5737,6 +5737,21 @@
             "params": {},
             "description": "Get license information"
         },
+
+        "queue-indexing-job": {
+            "url": "/staff/indexing_jobs",
+            "method": "POST",
+            "params": {
+                "target": {
+                    "type": "String",
+                    "required": true,
+                    "validation": "",
+                    "invalidmsg": "",
+                    "description": "A string representing the item to index."
+                }
+            },
+            "description": "Queue an indexing job"
+        },
 
         "create-org": {
             "url": "/admin/organizations",

diff --git a/test/enterpriseTest.js b/test/enterpriseTest.js
@@ -51,6 +51,19 @@ describe("[enterprise]", function() {
         );
     });
 
+    it("should successfully execute POST /staff/indexing_jobs (queueIndexingJob)",  function(next) {
+        client.enterprise.queueIndexingJob(
+            {
+                target: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /enterprise/stats/:type (stats)",  function(next) {
         client.enterprise.stats(
             {