Merge pull request #19 from codeclimate/QUA-519/add-regex-filter-docs

QUA-519: add regex filter docs

Author: dantevvp

source/includes/_overview.html.md

@@ -101,6 +101,17 @@ curl \
   https://api.codeclimate.com/v1/repos/696a76232df2736347000001/ref_points
 ```
 
+> Filtering with the `$regex` operator. This can be used to find records with an attribute that matches a certain regular expression.
+
+```shell
+curl \
+  -H "Accept: application/vnd.api+json" \
+  -H "Authorization: Token token={TOKEN}" \
+  --get \
+  --data-urlencode "filter[path][\$regex]=.+\.yml" \
+  https://api.codeclimate.com/v1/repos/59371236d8638a029a0000ef/snapshots/623c2866a758be0001036c9f/files
+```
+
 In some cases, where specified, the Code Climate API supports filtering resource
 collections.
 
@@ -111,7 +122,7 @@ The JSON API is agnostic beyond the `filter[]` key. In the Code Climate API,
 filters can be of two basic formats (examples on the right):
 
 1. A basic key/value
-2. A more complex data structure with an operator. At this time only the `$in` operator is supported.
+2. A more complex data structure with an operator. At this time only the `$in` and `$regex` operators are supported.
 
 See the `Query Parameters` section of each endpoint for details about what filters are supported.
 

source/includes/_repository_analysis.html.md

@@ -258,7 +258,13 @@ Sorted by path in ascending order.
 
 ### Query Parameters
 
-[Paginated](#collection-pagination)
+[Paginated](#collection-pagination), [Filterable](#collection-filtering)
+
+Filters include:
+
+| Name | Description | Required? |
+| ---- | ----------- | --------- |
+| filter[path] | Single path, `$in` clause containing list of categories or `$regex` clause containing regular expressions | No |
 
 ## Get builds