update types

Author: Mpdreamz

specification/src/domain.d.ts

@@ -48,22 +48,43 @@ declare module Domain {
         required: boolean;
         constructor(data: any);
     }
+    class Documentation {
+        description: string;
+        url: string;
+        constructor(data: any);
+    }
+    enum Stability {
+        stable = 0,
+        beta = 1,
+        experimental = 2,
+    }
+    class Deprecation {
+        version: string;
+        description: string;
+        constructor(data: any);
+    }
     class Endpoint {
         name: string;
-        documentation: string;
-        bodyDocumentation: BodyDocumentation;
-        methods: string[];
-        url: Route;
         typeMapping: RestSpecMapping;
+        documentation: Documentation;
+        stability: Stability;
+        body: BodyDocumentation;
+        url: Url;
+        queryStringParameters: QueryStringParameter[];
+        deprecated: Deprecation;
         constructor(file: string, restSpecMapping: {
             [p: string]: RestSpecMapping;
         });
     }
-    class Route {
+    class UrlPath {
         path: string;
-        paths: string[];
+        methods: string[];
         parts: RoutePart[];
-        queryStringParameters: QueryStringParameter[];
+        deprecated: Deprecation;
+        constructor(data: any);
+    }
+    class Url {
+        paths: UrlPath[];
         constructor(data: any);
     }
     class RestSpecTypeConverter {

specification/src/domain.ts

@@ -1,5 +1,6 @@
 import {RestSpecMapping} from "./specification/rest-spec-mapping";
 import * as _ from "lodash";
+import { BreakpointResolver } from "ntypescript";
 
 module Domain {
   import Any = ts.formatting.Shared.TokenRange.Any;
@@ -55,42 +56,81 @@ module Domain {
       this.required = !!data.required;
     }
   }
+  export class Documentation {
+    description: string;
+    url: string;
+    constructor(data: any) {
+      this.description = data.description;
+      this.url = data.url;
+    }
+  }
+  export enum Stability { stable, beta, experimental }
+
+  export class Deprecation {
+    version: string;
+    description: string;
+    constructor(data: any) {
+      this.version = data.version;
+      this.description = data.description;
+    }
+  }
 
   export class Endpoint {
     name: string;
-    documentation: string;
-    bodyDocumentation: BodyDocumentation;
-    methods: string[];
-    url: Route;
     typeMapping: RestSpecMapping;
 
+    documentation: Documentation;
+    stability: Stability;
+    body: BodyDocumentation;
+    url: Url;
+    queryStringParameters: QueryStringParameter[] = [];
+    deprecated: Deprecation;
+
     constructor(file: string, restSpecMapping: { [p: string]: RestSpecMapping }) {
       const json = require(file);
 
       this.name = _(json).keys().first();
       this.typeMapping = restSpecMapping[this.name];
       const data = json[this.name];
 
-      this.documentation = data.documentation;
-      this.methods = data.methods;
-      if (data.body)
-        this.bodyDocumentation  = new BodyDocumentation(data.body);
+      this.documentation = new Documentation(data.documentation);
+      this.queryStringParameters = _(data.params).map((v, k) => new QueryStringParameter(k, v)).value();
 
-      this.url = new Route(data.url);
+      if (data.body)
+        this.body  = new BodyDocumentation(data.body);
+      if (data.deprecated) 
+        this.deprecated = new Deprecation(data.deprecated);
+
+      switch(data.stability)
+      {
+        case "stable": this.stability =  Stability.stable; break;
+        case "beta": this.stability = Stability.stable; break;
+        case "experimental": this.stability = Stability.stable; break;
+      };
+
+      this.url = new Url(data.url);
     }
   }
-
-  export class Route {
+  export class UrlPath {
     path: string;
-    paths: string[];
+    methods: string[];
     parts: RoutePart[];
-    queryStringParameters: QueryStringParameter[] = [];
-
+    deprecated: Deprecation;
     constructor(data: any) {
       this.path = data.path;
-      this.paths = data.paths;
+      this.methods = data.methods;
       this.parts = _(data.parts).map((v, k) => new RoutePart(k, v)).value();
-      this.queryStringParameters = _(data.params).map((v, k) => new QueryStringParameter(k, v)).value();
+      if (data.deprecated) 
+        this.deprecated = new Deprecation(data.deprecated);
+    }
+  }
+
+  export class Url {
+    paths: UrlPath[];
+
+
+    constructor(data: any) {
+      this.paths = _(data.paths).map(p => new UrlPath(p)).value();
     }
   }
   export class RestSpecTypeConverter {

swagger-generator/src/swagger-enpoint-builder.js

@@ -1,6 +1,6 @@
 import {Specification} from "../../specification/src/api-specification";
 import {Path, Schema, Operation, Response, Parameter} from "swagger-schema-official";
-import {Endpoint, QueryStringParameter, RoutePart} from "../../specification/src/domain";
+import {Endpoint, QueryStringParameter, RoutePart, UrlPath} from "../../specification/src/domain";
 
 export type Paths = { [p: string]: Path};
 
@@ -12,43 +12,42 @@ export class SwaggerEndpointBuilder {
     return this.specification.endpoints
       .map(e => e.url.paths.map(p => ({ endpoint: e, path: p})))
       .reduce((a, paths) => a.concat(paths), [])
-      .reduce((o, e) => ({...o, [e.path]: SwaggerEndpointBuilder.createPath(e.endpoint, e.path)}), {});
+      .reduce((o, e) => ({...o, [e.path.path]: SwaggerEndpointBuilder.createPath(e.endpoint, e.path)}), {});
   }
 
-  private static createPath(e: Endpoint, url: string): Path {
+  private static createPath(e: Endpoint, url: UrlPath): Path {
     const path: Path = {
-      parameters: e.url.queryStringParameters
+      parameters: e.queryStringParameters
         .map(SwaggerEndpointBuilder.urlQueryStringToParameter)
     };
 
-    if (e.bodyDocumentation)
+    if (e.body)
       path.parameters.push(SwaggerEndpointBuilder.urlBodyToParameter(e));
 
-    return e.methods
+    return url.methods
       .map(m => m.toLowerCase())
       .reduce((o, m) => ({...o, [m]: SwaggerEndpointBuilder.createOperation(e, url)}), path);
   }
 
-  private static createOperation(endpoint: Endpoint, url: string): Operation {
+  private static createOperation(endpoint: Endpoint, url: UrlPath): Operation {
     const defaultContentTypes = ["application/json"];
     return {
       responses: SwaggerEndpointBuilder.getResponses(endpoint),
       tags: [endpoint.name],
       consumes: defaultContentTypes,
       produces: defaultContentTypes,
-      parameters: endpoint.url.parts
-        .filter(p => url.match(new RegExp("\{" + p.name + "\}")))
+      parameters: url.parts
         .map(SwaggerEndpointBuilder.urlPartToParameter),
-      externalDocs: endpoint.documentation ? {url: endpoint.documentation} : null
+      externalDocs: endpoint.documentation ? {url: endpoint.documentation.url || ""} : null
     };
   }
 
   private static urlBodyToParameter(e: Endpoint) {
     return {
       in: "body",
       name: "request",
-      description: e.bodyDocumentation ? e.bodyDocumentation.description : null,
-      required: e.bodyDocumentation ? e.bodyDocumentation.required : false,
+      description: e.body ? e.body.description : null,
+      required: e.body ? e.body.required : false,
       schema: {$ref: "#/definitions/" + e.typeMapping.request }
     };
   }

swagger-generator/src/swagger-enpoint-builder.ts

@@ -19,7 +19,7 @@ export class SwaggerGenerator {
       definitions: new JsonSchemaBuilder(this.specification).build()
     };
 
-    const swaggerRoot = Yaml.safeDump(swag, { noRefs: true, lineWidth: 400 });
+    const swaggerRoot = Yaml.safeDump(swag, { noRefs: true, lineWidth: 400, skipInvalid: true });
     const f = __dirname + "/" + folder;
 
     fs.writeFileSync( f + "/index.yml", swaggerRoot);