Merge pull request #23 from muxinc/jm-update-doc-comments-incidents

Removal of required params for incidents routes

Author: JacquiManzi

src/data/resources/incidents.js

@@ -22,8 +22,7 @@ class Incidents extends Base {
   /**
    * Returns a list of all open incidents
    *
-   * @param {Object} [params] - example { status: 'open' }
-   * Note: the status query parameter is required
+   * @param {Object} [params] - example { status: 'open', severity: 'warning' }
    * @returns {Promise} - Returns a resolved Promise with a response from the Mux API
    *
    * @example
@@ -35,11 +34,6 @@ class Incidents extends Base {
    * @see https://api-docs.mux.com/#incident-get
    */
   list(params) {
-    if (!params || (params && !params.status)) {
-      throw new Error(
-        'The status query parameter is required for listing incidents.'
-      );
-    }
     return this.http.get(PATH, { params });
   }
 

test/unit/data/resources/incidents.spec.js

@@ -43,15 +43,6 @@ describe('Unit::Incidents', () => {
   /** @test {Incidents.list} */
   describe('Incidents.list', () => {
     /** @test {Incidents.list} */
-    it('throws an error if the status query parameter is not provided', () => {
-      expect(() => incidentsInstance.list()).to.throw(
-        'The status query parameter is required for listing incidents.'
-      );
-      expect(() => incidentsInstance.list({})).to.throw(
-        'The status query parameter is required for listing incidents.'
-      );
-    });
-
     it('makes a get request to the Mux data incidents route', done => {
       moxios.stubRequest('https://api.mux.com/data/v1/incidents?status=open', {
         status: 200,