Merge pull request #91 from bcomnes/node-client

Add node client info

Author: bcomnes

.gitignore

@@ -1,2 +1,3 @@
 *.iml
 vendor
+*node_modules

Makefile

@@ -2,6 +2,8 @@
 CHECK_FILES?=$$(go list ./... | grep -v /vendor/)
 
 
+
+
 help: ## Show this help.
 		@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
 
@@ -22,3 +24,6 @@ test: ## Test the go code.
 
 validate: ## Check that the swagger spec is valid.
 	swagger validate swagger.yml
+
+node: ## Generate the node module.
+	swagger-codegen generate -i ./swagger.yml -l javascript -o ./node/

README.md

@@ -1,24 +1,24 @@
-# Introduction
+# Netlify open-api
 
 This repository contains Netlify's API definition in the [Open API format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md), formerly known as Swagger.
 
 It's still a work in progress and we welcome feedback and contributions.
 
-## Installation
+## Go Client
 
 We use [go-swagger](https://github.com/go-swagger/go-swagger) to validate our spec against the 2.0 spec of Open API.
 
 We currently depend on version 0.12.0 of the swagger toolchain. You can download the binary for your platform from this release page:
 
 https://github.com/go-swagger/go-swagger/releases/tag/0.12.0
 
-## Spec validation
+### Spec validation
 
 You can run this command to validate the spec:
 
 	make validate
 
-## Code generation
+### Code generation
 
 Currently, we're generating client code for Go, but we're planning on releasing libraries in any language that can generate code from the spec.
 
@@ -28,6 +28,33 @@ You can use this command to generate the Go client:
 
 You may first want to edit swagger.yml to add your field or endpoint definitions.
 
+## Node Client
+
+In order to generate the Node client, you must install Java 8 and the swagger-codegen tool.
+
+1. You will need java8 (or 7) to run the code-gen
+
+    ```bash
+    # install java 8 via homebrew
+    brew cask install homebrew/cask-versions/java8
+    ```
+
+
+2. Then install swagger codegen
+
+    ```bash
+    # install code-gen via homebrew
+    brew install swagger-codegen
+    ```
+
+3. Generate the library
+
+	```console
+	$ make node
+	```
+
+The `swagger-codegen` generates an entire module in the `node` folder.  You can publish new versions of the client from that folder with `npm publish`.
+
 ## Explore API
 
 Go to https://open-api.netlify.com to explore the spec definitions using Open-Api's UI.

node/.swagger-codegen-ignore

@@ -0,0 +1,23 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

node/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+2.3.1

node/.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - "6"
+  - "6.1"
+  - "5"
+  - "5.11"
+

node/README.md

@@ -0,0 +1,12 @@
+# NetlifysApiDefinition.AccessToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**accessToken** | **String** |  | [optional] 
+**userId** | **String** |  | [optional] 
+**userEmail** | **String** |  | [optional] 
+**createdAt** | **String** |  | [optional] 
+
+

node/docs/AccessToken.md

@@ -0,0 +1,23 @@
+# NetlifysApiDefinition.AccountMembership
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**slug** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**capabilities** | [**AccountMembershipCapabilities**](AccountMembershipCapabilities.md) |  | [optional] 
+**billingName** | **String** |  | [optional] 
+**billingEmail** | **String** |  | [optional] 
+**billingDetails** | **String** |  | [optional] 
+**billingPeriod** | **String** |  | [optional] 
+**paymentMethodId** | **String** |  | [optional] 
+**typeName** | **String** |  | [optional] 
+**typeId** | **String** |  | [optional] 
+**ownerIds** | **[String]** |  | [optional] 
+**rolesAllowed** | **[String]** |  | [optional] 
+**createdAt** | **String** |  | [optional] 
+**updatedAt** | **String** |  | [optional] 
+
+

node/docs/AccountMembership.md

@@ -0,0 +1,9 @@
+# NetlifysApiDefinition.AccountMembershipCapabilities
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sites** | [**AccountUsageCapability**](AccountUsageCapability.md) |  | [optional] 
+**collaborators** | [**AccountUsageCapability**](AccountUsageCapability.md) |  | [optional] 
+
+