6 | 2. Expand the **KaiZen OpenAPI Editor** category.
7 | 3. Choose one of the available options:
8 | * Choose **Swagger v2 Spec** to create a Swagger-OpenAPI 2.0 specification. This is the current industry-standard API description language, supported by thousands of open source projects and all major API technology vendors.
9 | * Choose **OpenAPI v3 Spec** to create an OpenAPI 3.0 specification. This is the first major upgrade to OAS, scheduled for a final release in July 2017. See [OpenAPI 3.0 Editing Support](OPEN_API_V3_SUPPORT.md) for more information on current and planned features. 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /OPEN_API_V3_SUPPORT.md: -------------------------------------------------------------------------------- 1 | # NEW! Full OpenAPI 3.0 Editing Support 2 | We are really pleased to inform you that KaiZen OpenAPI Editor now fully supports the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md). Here's some of the cool stuff that you can now do with OpenAPI v3 specs: 3 | 4 | ## Validation 5 |
6 |
7 | ## Content Assist
8 | 
9 |
10 | ## Quick Outline
11 | 
12 |
13 | ## Outline
14 | 
15 |
16 | # FAQ
17 | ## How do I create a new OpenAPI v3 spec?
18 | Please use the *OpenAPI v3 Spec* wizard from the *KaiZen OpenAPI Editor* category:
19 |
20 |
21 |
22 |
23 | ## The editor for Swagger v2 uses an underlying JSON Schema. There's no official JSON Schema for OpenAPI v3, so what are you using?
24 | We use a modification of the JSON Schema provided by [googleapis/gnostic](https://github.com/googleapis/gnostic). We use the [SwagEdit branch](https://github.com/RepreZen/gnostic/tree/SwagEdit) to generate our JSON Schema. Thanks to @timburks and @MikeRalphson for the contribution!
25 |
26 |
--------------------------------------------------------------------------------
/TROUBLESHOOTING.md:
--------------------------------------------------------------------------------
1 | ## Autoformat (Ctrl+Shift+F) removes YAML comments
2 | This is a [known issue](https://github.com/oyse/yedit/issues/15) of YEdit, the YAML Editor on which KaiZen OpenAPI Editor is built. There is no fix for this yet, so we recommend that you disable the key binding for YEdit in Eclipse Preferences:
3 | 
4 |
5 | 1. Open the "General > Keys" page.
6 | 2. Type "format" in the search box.
7 | 3. Select the command from the YEdit category.
8 | 4. Click the "Unbind Command" button.
9 | 5. Confirm by selecting "OK".
10 |
11 | ## Handling special (non-UTF) characters
12 | JSON does not support non UTF encoding, so for now we recommend avoid using special characters, e.g. accented letters, in your Swagger specification. See [issue 158](https://github.com/RepreZen/SwagEdit/issues/158) for details
13 |
--------------------------------------------------------------------------------
/com.reprezen.swagedit.core/.classpath:
--------------------------------------------------------------------------------
1 |
2 | 20 | * 21 | * Example of an array type definition: 22 | * 23 | *
24 | *
25 | * "tags": {
26 | * "type": "array",
27 | * "items": {
28 | * "$ref": "#/definitions/tag"
29 | * },
30 | * "uniqueItems": true
31 | * }
32 | *
33 | *
34 | *
35 | */
36 | public class ArrayTypeDefinition extends TypeDefinition {
37 |
38 | public final TypeDefinition itemsType;
39 |
40 | public ArrayTypeDefinition(JsonSchema schema, JsonPointer pointer, JsonNode definition) {
41 | super(schema, pointer, definition, JsonType.ARRAY);
42 | itemsType = schema.createType(this, "items", definition.get("items"));
43 | }
44 |
45 | @Override
46 | public TypeDefinition getPropertyType(String property) {
47 | return itemsType;
48 | }
49 | }
--------------------------------------------------------------------------------
/com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/JsonSchemaUtils.java:
--------------------------------------------------------------------------------
1 | /*******************************************************************************
2 | * Copyright (c) 2017 ModelSolv, Inc. and others.
3 | * All rights reserved. This program and the accompanying materials
4 | * are made available under the terms of the Eclipse Public License v1.0
5 | * which accompanies this distribution, and is available at
6 | * http://www.eclipse.org/legal/epl-v10.html
7 | *
8 | * Contributors:
9 | * ModelSolv, Inc. - initial API and implementation and/or initial documentation
10 | *******************************************************************************/
11 | package com.reprezen.swagedit.core.schema;
12 |
13 | import java.util.ArrayList;
14 | import java.util.List;
15 | import java.util.StringJoiner;
16 |
17 | import com.fasterxml.jackson.databind.JsonNode;
18 | import com.fasterxml.jackson.databind.node.ArrayNode;
19 |
20 | public class JsonSchemaUtils {
21 | public static String getHumanFriendlyText(JsonNode swaggerSchemaNode, final String defaultValue) {
22 | String schemaTitle = getSchemaTitle(swaggerSchemaNode);
23 | if (schemaTitle != null) {
24 | return schemaTitle;
25 | }
26 | // nested array
27 | if (swaggerSchemaNode.get("items") != null) {
28 | return getHumanFriendlyText(swaggerSchemaNode.get("items"), defaultValue);
29 | }
30 | // "$ref":"#/definitions/headerParameterSubSchema"
31 | JsonNode ref = swaggerSchemaNode.get("$ref");
32 | if (ref != null) {
33 | return getLabelForRef(ref.asText());
34 | }
35 | // Auxiliary oneOf in "oneOf": [ { "$ref": "#/definitions/securityRequirement" }]
36 | JsonNode oneOf = swaggerSchemaNode.get("oneOf");
37 | if (oneOf != null) {
38 | if (oneOf instanceof ArrayNode) {
39 | ArrayNode arrayNode = (ArrayNode) oneOf;
40 | if (arrayNode.size() > 0) {
41 | List