add swagger validator

Author: kamicut

README.md

@@ -8,7 +8,10 @@
     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"
       alt="Standard" />
   </a>
-</div>
+  <a href="http://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/developmentseed/osm-teams/master/docs/api.yml">
+    <img src="http://validator.swagger.io/validator?url=https://raw.githubusercontent.com/developmentseed/osm-teams/master/docs/api.yml">
+  </a>
+  </div>
 
 Check the beta 👉 <!-- markdownlint-disable MD034 -->https://mapping.team
 <!-- markdownlint-enable MD034 -->

docs/api.md

@@ -23,9 +23,9 @@ create a client
 
 ##### Responses
 
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | oath 2.0 client | object |
+| Code | Description |
+| ---- | ----------- |
+| 200 | oath 2.0 client |
 
 ### /clients/{id}
 

docs/api.yml

@@ -8,12 +8,6 @@ info:
 servers:
   - url: /api
 
-consumes:
-  - application/json
-
-produces:
-  - application/json
-
 tags:
   - name: teams
     description: Teams
@@ -255,12 +249,13 @@ components:
           description: the timestamp of the time and date the client was last updated
           format: date-time
     ResponseError:
-      statusCode:
-        type: integer
-      error:
-        type: string
-      message:
-        type: string
+      properties:
+        statusCode:
+          type: integer
+        error:
+          type: string
+        message:
+          type: string
   parameters:
     ClientId:
       name: id
@@ -304,11 +299,12 @@ paths:
       responses:
         '200':
           description: A JSON array of client objects
-          application/json:
-            schema:
-              type: array
-              items:
-                $ref: '#/components/schemas/Client'
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Client'
     post:
       summary: create a client
       tags:
@@ -322,11 +318,13 @@ paths:
       responses:
         '200':
           description: oath 2.0 client
-          schema:
-            type: object
-            properties:
-              client:
-                $ref: '#/components/schemas/Client'
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  client:
+                    $ref: '#/components/schemas/Client'
   /clients/{id}:
     parameters:
       - $ref: '#/components/parameters/ClientId'

package.json

@@ -3,8 +3,9 @@
   "version": "0.0.0",
   "description": "Teams for OpenStreetMap!",
   "scripts": {
+    "docs:validate": "swagger-cli validate docs/api.yml",
     "docs:api": "swagger-markdown -i docs/api.yml -o docs/api.md",
-    "docs": "npm run docs:api",
+    "docs": "npm run docs:validate && npm run docs:api",
     "dev": "NODE_ENV=development nodemon --watch app app/index.js",
     "migrate": "knex --knexfile app/db/knexfile.js migrate:latest",
     "test": "NODE_ENV=test ava app/tests/**/*.test.js -c 1 --serial --verbose",
@@ -78,6 +79,7 @@
     "yamljs": "^0.3.0"
   },
   "devDependencies": {
+    "@apidevtools/swagger-cli": "^4.0.2",
     "@babel/core": "^7.5.5",
     "@babel/preset-env": "^7.5.5",
     "@babel/preset-react": "^7.0.0",