Merge pull request #3 from thedumbterminal/typeArray

support descriptions

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## v0.0.3 (25/07/2018)
 
 * Now supporting fields with type(s) as an array.
+* Field descriptions now supported.
 
 ## v0.0.2 (23/07/2018)
 

README.md

@@ -40,7 +40,6 @@ Please ensure that the input JSON schema is dereferenced so that all external re
 * Repeated fields.
 * Enums.
 * Error messages.
-* Descriptions.
 * Handle `oneOf`, `anyOf` and `allOf`.
 * Fields with multiple types.
 

src/index.js

@@ -40,11 +40,15 @@ jsonSchemaBigquery._getMode = (required, name, item) => {
 }
 
 jsonSchemaBigquery._convertProperty = (name, value, mode) => {
-	return {
+	let field = {
 		name: name,
 		type: jsonSchemaBigquery._getType(value.type),
 		mode: mode
 	}
+	if(value.description){
+		field.description = value.description
+	}
+	return field
 }
 
 jsonSchemaBigquery._getType = (types) => {

test/samples/complex/input.json

@@ -4,15 +4,12 @@
 	"type": "object",
 	"properties": {
 		"address": {
-			"description": "the address",
 			"type": "object",
 			"properties": {
 				"street_address": {
-					"description": "the street address",
 					"type": "string"
 				},
 				"country": {
-					"description": "the country",
 					"type" : "string"
 				}
 			}

test/samples/fieldDescription/expected.json

@@ -0,0 +1,12 @@
+{
+	"schema": {
+		"fields": [
+			{
+				"description": "the first name",
+				"name": "first_name",
+				"type": "STRING",
+				"mode": "NULLABLE"
+			}
+		]
+	}
+}

test/samples/fieldDescription/input.json

@@ -0,0 +1,11 @@
+{
+	"id": "http://yourdomain.com/schemas/myschema.json",
+	"description": "Example description",
+	"type": "object",
+	"properties": {
+		"first_name": {
+			"description": "the first name",
+			"type": "string"
+		}
+	}
+}

test/samples/nullable/input.json

@@ -4,11 +4,9 @@
 	"type": "object",
 	"properties": {
 		"first_name": {
-			"description": "the first name",
 			"type": "string"
 		},
 		"last_name": {
-			"description": "the last name",
 			"type": "string"
 		}
 	},

test/samples/simple/input.json

@@ -4,11 +4,9 @@
 	"type": "object",
 	"properties": {
 		"first_name": {
-			"description": "the first name",
 			"type": "string"
 		},
 		"last_name": {
-			"description": "the last name",
 			"type": "string"
 		}
 	}

test/samples/typeArray/input.json

@@ -4,14 +4,12 @@
 	"type": "object",
 	"properties": {
 		"first_name": {
-			"description": "the first name",
 			"type": [
 				"string",
 				"null"
 			]
 		},
 		"last_name": {
-			"description": "the first name",
 			"type": [
 				"string",
 				"null"