| Title |
@@ -387,7 +374,6 @@ description: JSON schema example for a person entity
-
## Schema
diff --git a/gh-pages/examples/root-level-property.md b/gh-pages/examples/root-level-property.md
new file mode 100644
index 0000000..5cb7b69
--- /dev/null
+++ b/gh-pages/examples/root-level-property.md
@@ -0,0 +1,90 @@
+---
+title: Root level property
+description: JSON schema example demonstrating a schema with a string property directly at the root level
+
+---
+
+
+# Root level property
+
+JSON schema example demonstrating a schema with a string property directly at the root level
+
+
+
+| $id | root-level-property.yml |
|---|
+| $schema | http://json-schema.org/draft-07/schema# |
|---|
+
+
+
+
+
+## Example
+```
+"Value one"
+```
+## Example
+```
+"Value two"
+```
+
+
+
+
+
+
+
+
+
+ | $id |
+ root-level-property.yml |
+
+
+ | Title |
+ Root level property |
+
+
+ | Description |
+ JSON schema example demonstrating a schema with a string property directly at the root level |
+
+ | Type | String |
|---|
+
+ | Min Length |
+ 1 |
+
+ | Max Length |
+ 100 |
+
+ | Examples |
+ Value oneValue two |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Schema
+```
+{
+ "$id": "root-level-property.yml",
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Root level property",
+ "description": "JSON schema example demonstrating a schema with a string property directly at the root level",
+ "type": "string",
+ "examples": [
+ "Value one",
+ "Value two"
+ ],
+ "minLength": 1,
+ "maxLength": 100
+}
+```
+
+
diff --git a/gh-pages/yml/root-level-property.yml b/gh-pages/yml/root-level-property.yml
new file mode 100644
index 0000000..aaee65a
--- /dev/null
+++ b/gh-pages/yml/root-level-property.yml
@@ -0,0 +1,10 @@
+$id: root-level-property.yml
+$schema: http://json-schema.org/draft-07/schema#
+title: Root level property
+description: JSON schema example demonstrating a schema with a string property directly at the root level
+type: string
+examples:
+ - Value one
+ - Value two
+minLength: 1
+maxLength: 100
diff --git a/lib/renderer-markdown.js b/lib/renderer-markdown.js
index 16d7321..7b42a83 100644
--- a/lib/renderer-markdown.js
+++ b/lib/renderer-markdown.js
@@ -44,6 +44,10 @@ Handlebars.registerHelper("isDefined", function (value) {
return value !== undefined;
});
+Handlebars.registerHelper("isNotDefined", function (value) {
+ return value === undefined;
+});
+
Handlebars.registerHelper("isArrayOfStringLikeValues", function (value) {
return Array.isArray(value) && !value.find((v) => typeof v === "object");
});
@@ -118,7 +122,7 @@ const propertiesTable = (schema, parentKey) => {
let properties = schema.properties;
let html =
- "" +
+ '' +
'| Name | Type |
|---|
' +
"";
diff --git a/package-lock.json b/package-lock.json
index 503f340..0854384 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "json-schema-static-docs",
- "version": "0.23.1",
+ "version": "0.24.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "json-schema-static-docs",
- "version": "0.23.1",
+ "version": "0.24.1",
"license": "GPL-3.0-only",
"dependencies": {
"@apidevtools/json-schema-ref-parser": "^10.1.0",
diff --git a/templates/schema.hbs b/templates/schema.hbs
index 2599ea8..3aef63e 100644
--- a/templates/schema.hbs
+++ b/templates/schema.hbs
@@ -11,9 +11,11 @@
+{{#if schema.properties}}
## Properties
{{propertiesTable schema }}
+{{/if}}
{{#if example}}
## Example
@@ -33,22 +35,26 @@
+{{#if schema.properties}}
{{#each schema.properties}}
-
{{> property propertyKey=@key }}
-
{{/each}}
+{{else}}
+{{> property schema isRootLevelProperty=true }}
+{{/if}}
{{#*inline "property"}}
+{{#if (isNotDefined isRootLevelProperty)}}
{{#if (isDefined parentKey)}}
### {{ parentKey }}.{{ propertyKey }}
{{else}}
## {{ propertyKey }}
{{/if}}
+{{/if}}
{{#if (isExternalRef this.$ref)}}
Defined in {{{ getHtmlAnchorForRef this.$ref this.$ref }}}
@@ -109,7 +115,7 @@
{{#*inline "propertyTable"}}
-
+
{{!--
| Attribute |
diff --git a/tests/renderer-markdown.test.js b/tests/renderer-markdown.test.js
index e45ad32..f0db3b1 100644
--- a/tests/renderer-markdown.test.js
+++ b/tests/renderer-markdown.test.js
@@ -71,6 +71,13 @@ const defaultMergedSchemaWithConst = {
},
},
};
+const mergedSchemaWithRootLevelString = {
+ schema: {
+ $id: "/property1",
+ title: "Property 1",
+ type: "string",
+ },
+};
let mergedSchema = {};
const removeFormatting = (value) => {
@@ -102,7 +109,7 @@ test("renders attributes", async () => {
let expectedText =
"## Properties" +
- '| Name | Type |
|---|
' +
+ '| Name | Type |
|---|
' +
'| property1 | String |
' +
'| property2 | [string, integer] |
' +
'| property3 | Array [property3.html] |
' +
@@ -124,7 +131,7 @@ test("renders attributes with const", async () => {
let expectedText =
"## Properties" +
- '| Name | Type |
|---|
' +
+ '";
@@ -133,7 +140,7 @@ test("renders attributes with const", async () => {
// tests recursive rendering of nested properties
test("renders nested property title correctly", async () => {
- expect.assertions(1);
+ expect.assertions(3);
rendererMarkdown = new RendererMarkdown(defaultTemplatePath);
await rendererMarkdown.setup();
let result = rendererMarkdown.renderSchema(mergedSchema);
@@ -145,19 +152,24 @@ test("renders nested property title correctly", async () => {
'| Title | Property 5 |
|---|
' +
'| Type | Object |
|---|
' +
'| Required | Yes |
|---|
' +
- "
" +
+ "
";
+ expect(result).toContain(expectedText);
+
+ let expectedText2 =
"### Properties" +
- '";
+ expect(result).toContain(expectedText2);
+
+ let expectedText3 =
"### property5.property5.1" +
- "" +
+ '' +
"### property5.property5.1.property5.1.1" +
- "" +
+ '';
-
- expect(result).toContain(expectedText);
+ expect(result).toContain(expectedText3);
});
test("renders string property enums", async () => {
@@ -231,3 +243,21 @@ test("renders array property types", async () => {
expect(result).toContain(expectedType);
});
+
+test("renders root level string property", async () => {
+ expect.assertions(2);
+ rendererMarkdown = new RendererMarkdown(defaultTemplatePath);
+ await rendererMarkdown.setup();
+ let result = rendererMarkdown.renderSchema(mergedSchemaWithRootLevelString);
+
+ console.log(result);
+
+ result = removeFormatting(result);
+
+ let expectedTitle = '| Title | Property 1 |
|---|
';
+ expect(result).toEqual(expect.stringContaining(expectedTitle));
+
+ let expectedType = '| Type | String |
|---|
';
+
+ expect(result).toContain(expectedType);
+});