Added support for OpenAPI v3 schema rendering. (#5)

data/specs/bookstore.openapi.json

@@ -8,7 +8,7 @@
  },
  "servers": [
  {
- "url": "https://alzasloneuap05.azure-api.net/book-store-api"
+ "url": "https://contoso.com"
  }
  ],
  "paths": {

package.json

@@ -96,6 +96,7 @@
  "remark": "^13.0.0",
  "remark-html": "^13.0.1",
  "routing-controllers": "^0.9.0-alpha.6",
+ "saxen": "^8.1.2",
  "slick": "^1.12.2",
  "topojson-client": "^3.1.0",
  "truncate-html": "^1.0.3",

src/components/operations/operation-details/ko/runtime/operation-details.ts

@@ -211,7 +211,7 @@ export class OperationDetails {
  .map(p => p.typeName)
  .filter((item, pos, self) => self.indexOf(item) === pos);
 
- const schemasPromises = schemaIds.map(schemaId => this.apiService.getApiSchema(`${apiId}/${schemaId}`));
+ const schemasPromises = schemaIds.map(schemaId => this.apiService.getApiSchema(this.selectedApiName()));
  const schemas = await Promise.all(schemasPromises);
  const definitions = schemas.map(x => x.definitions).flat();
 

src/contracts/openapi/index.ts

@@ -0,0 +1,16 @@
+export * from "./openApiComponents";
+export * from "./openApiExample";
+export * from "./openApiExternalDoc";
+export * from "./openApiMediaType";
+export * from "./openApiObjectInfo";
+export * from "./openApiOperation";
+export * from "./openApiParameter";
+export * from "./openApiPath";
+export * from "./openApiPaths";
+export * from "./openApiReference";
+export * from "./openApiRequestBody";
+export * from "./openApiResponse";
+export * from "./openApiResponses";
+export * from "./openApiSchema";
+export * from "./openApiServer";
+export * from "./openApiTag";

src/contracts/openapi/openApi.ts

@@ -0,0 +1,50 @@
+import {
+ OpenApiComponents,
+ OpenApiExternalDoc,
+ OpenApiObjectInfo,
+ OpenApiPaths,
+ OpenApiServer,
+ OpenApiTag
+} from "./";
+
+/**
+ * This is the root document object of the
+ */
+export interface OpenApiSpec30 {
+ /**
+ * This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses.
+ */
+ openapi: string;
+
+ /**
+ * The available paths and operations for the API.
+ */
+ paths: OpenApiPaths;
+
+ /**
+ * Provides metadata about the API. The metadata MAY be used by tooling as required.
+ */
+ info: OpenApiObjectInfo;
+
+ /**
+ * Additional external documentation.
+ */
+ externalDocs?: OpenApiExternalDoc;
+
+ /**
+ * An array of Server Objects, which provide connectivity information to a target server.
+ * If the servers property is not provided, or is an empty array, the default value would
+ * be a Server Object with a URL value of /.
+ */
+ servers?: OpenApiServer[];
+
+ /**
+ * A list of tags used by the specification with additional metadata.
+ */
+ tags?: OpenApiTag[];
+
+ /**
+ * An element to hold various schemas for the specification.
+ */
+ components: OpenApiComponents;
+}

src/contracts/openapi/openApiComponents.ts

@@ -0,0 +1,3 @@
+export interface OpenApiComponents {
+ schemas?: any;
+}

src/contracts/openapi/openApiExample.ts

@@ -0,0 +1,21 @@
+export interface OpenApiExample {
+ /**
+ * Short description for the example.
+ */
+ summary: string;
+
+ /**
+ * Long description for the example.
+ */
+ description: string;
+
+ /**
+ * Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.
+ */
+ value: any;
+
+ /**
+ * A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.
+ */
+ externalValue: string;
+}

src/contracts/openapi/openApiExternalDoc.ts

@@ -0,0 +1,4 @@
+export interface OpenApiExternalDoc {
+ url: string;
+ description?: string;
+}

src/contracts/openapi/openApiMediaType.ts

@@ -0,0 +1,9 @@
+import { OpenApiExample } from "./openApiExample";
+
+
+export interface OpenApiMediaType {
+ schema: any; // OpenApiSchema | OpenApiReference;
+ example: OpenApiExample;
+ examples: any;
+ encoding: any;
+}

src/contracts/openapi/openApiObjectInfo.ts

@@ -0,0 +1,6 @@
+export interface OpenApiObjectInfo {
+ title: string;
+ description?: string;
+ version: string;
+ termsOfService?: string;
+}

src/contracts/openapi/openApiOperation.ts

@@ -0,0 +1,15 @@
+import { OpenApiParameter } from "./openApiParameter";
+import { OpenApiResponses } from "./openApiResponses";
+import { OpenApiRequestBody } from "./openApiRequestBody";
+
+
+export interface OpenApiOperation {
+ operationId: string;
+ description: string;
+ parameters: OpenApiParameter[];
+ responses: OpenApiResponses;
+ summary: string;
+ consumes?: string[];
+ produces?: string[];
+ requestBody?: OpenApiRequestBody;
+}

src/contracts/openapi/openApiParameter.ts

@@ -0,0 +1,10 @@
+export interface OpenApiParameter {
+ name: string;
+ in: string;
+ required: boolean;
+ description: string;
+ type?: string;
+ schema?: any;
+ default?: string;
+ enum: string[];
+}

src/contracts/openapi/openApiPath.ts

@@ -0,0 +1,6 @@
+import { OpenApiOperation } from "./openApiOperation";
+
+
+export interface OpenApiPath {
+ [key: string]: OpenApiOperation;
+}

src/contracts/openapi/openApiPaths.ts

@@ -0,0 +1,5 @@
+import { OpenApiPath } from "./openApiPath";
+
+export interface OpenApiPaths {
+ [key: string]: OpenApiPath;
+}

src/contracts/openapi/openApiReference.ts

@@ -0,0 +1,3 @@
+export interface OpenApiReference {
+ $ref: string;
+}

src/contracts/openapi/openApiRequestBody.ts

@@ -0,0 +1,24 @@
+import { Bag } from "@paperbits/common";
+import { OpenApiMediaType } from "./openApiMediaType";
+
+/**
+ * Describes a single request body.
+ */
+export interface OpenApiRequestBody {
+ /**
+ * A brief description of the request body. This could contain examples of use.
+ */
+ description: string;
+
+ /**
+ * Determines if the request body is required in the request. Defaults to false.
+ */
+ required: boolean;
+
+ /**
+ * The content of the request body. The key is a media type or media type range and the value describes it.
+ * For requests that match multiple keys, only the most specific key is applicable,
+ * e.g. text/plain overrides text/*
+ */
+ content: Bag<OpenApiMediaType>;
+}

src/contracts/openapi/openApiResponse.ts

@@ -0,0 +1,10 @@
+import { Bag } from "@paperbits/common";
+import { OpenApiMediaType } from "./openApiMediaType";
+import { OpenApiParameter } from "./openApiParameter";
+
+
+export interface OpenApiResponse {
+ description: string;
+ headers: Bag<OpenApiParameter>;
+ content: Bag<OpenApiMediaType>;
+}

src/contracts/openapi/openApiResponses.ts

@@ -0,0 +1,5 @@
+import { OpenApiResponse } from "./openApiResponse";
+
+export interface OpenApiResponses {
+ [key: string]: OpenApiResponse;
+}

src/contracts/openapi/openApiSchema.ts

@@ -0,0 +1 @@
+export interface OpenApiSchema { }

src/contracts/openapi/openApiServer.ts

@@ -0,0 +1,5 @@
+
+export interface OpenApiServer {
+ url: string;
+ description?: string;
+}

src/contracts/openapi/openApiTag.ts

@@ -0,0 +1,8 @@
+import { OpenApiExternalDoc } from "./openApiExternalDoc";
+
+
+export interface OpenApiTag {
+ name: string;
+ description?: string;
+ externalDocs?: OpenApiExternalDoc;
+}

src/contracts/request.ts

@@ -1,12 +1,12 @@
 import { ParameterContract } from "./parameter";
 import { RepresentationContract } from "./representation";
 
-/*
-Model of API operation request
-*/
+/**
+ * Model of API operation request
+ */
 export interface RequestContract {
  description?: string;
- queryParameters: ParameterContract[];
- headers: ParameterContract[];
- representations: RepresentationContract[];
+ queryParameters?: ParameterContract[];
+ headers?: ParameterContract[];
+ representations?: RepresentationContract[];
 }

src/contracts/schema.ts

@@ -30,6 +30,8 @@ export interface SchemaObjectContract extends ReferenceObjectContract {
  */
  required?: string[];
 
+ readOnly?: boolean;
+
  properties?: Bag<SchemaObjectContract>;
 
  items?: SchemaObjectContract;
@@ -72,7 +74,25 @@ export interface SchemaObjectContract extends ReferenceObjectContract {
 
  minProperties?: number;
 
+ /**
+ * Example of the payload represented by this schema object.
+ */
  example?: string;
+
+ /**
+ * Format of payload example represented by this schema object. It is used for syntax highlighting.
+ */
+ exampleFormat?: string;
+
+ /**
+ * Raw schema representation.
+ */
+ rawSchema?: string;
+
+ /**
+ * Raw schema format. It is used for syntax highlighting.
+ */
+ rawSchemaFormat?: string;
 }
 
 /**
@@ -122,17 +142,23 @@ export interface OpenApiSchemaContract {
  };
 }
 
+export interface XsdSchemaContract {
+ value: string;
+}
+
+
 /**
  * 
  */
-export interface SchemaContract extends ArmResource  {
+export interface SchemaContract extends ArmResource {
  properties: {
  contentType: string;
- document?: SwaggerSchemaContract | OpenApiSchemaContract;
+ document?: SwaggerSchemaContract | OpenApiSchemaContract | XsdSchemaContract;
  };
 }
 
 export enum SchemaType {
  swagger = "application/vnd.ms-azure-apim.swagger.definitions+json",
- openapi = "application/vnd.oai.openapi.components+json"
+ openapi = "application/vnd.oai.openapi.components+json",
+ xsd = "application/vnd.ms-azure-apim.xsd+xml"
 }