The generator does not handle allOf/anyOf/oneOf properly if schemas include properties, and are not references.

[MaxSavenkov]

This schema:

{
  "$id" : "id",
  "title" : "title",
  "description" : "desc", 
  "type" : "object",

  "allOf": [
    { "properties": {
        "type": { "enum": [ "one", "two" ] }
      }, "required" : ["type"]
    },
    { "properties": {
        "test": { "type": "string" }
      }, "required" : ["test"]
    }
  ]
}

Produces this MarkDown:

# title Schema

id

desc

| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In |
|----------|------------|--------|-------------------|-----------------------|------------|
| Can be instantiated | No | Experimental | Forbidden | Permitted | [protocol2.schema.json](protocol2.schema.json) |

# title Properties

| Property | Type | Required | Defined by |
|----------|------|----------|------------|
| [test](#test) | `string` | **Required** | title (this schema) |
| `*` | any | Additional | this schema *allows* additional properties |

## test


`test`
* is **required**
* type: `string`
* defined in this schema

### test Type


`string`

The "type" property disappears completely. However, this is a valid schema that requires both properties. Additionally, if you change one of the "allOf" elements to "$ref" with the same content, everything works just fine.

The same problem applies to anyOf and oneOf combinations.

[trieloff]

For the allOf case this is a clear bug.

For anyOf and oneOf, we would first have to define what the output would look like.

[MaxSavenkov]

Is there any difference between the three in terms of output? "and", "or" and "xor" examples from https://github.com/adobe/jsonschema2md/blob/master/examples/docs/complex.schema.md seem to follow the same rules visually, with just a different preface and headers.

[trieloff]

The difference is that in complex.schema.json we have the oneOf at the level of individual properties, not at the root of the schema.

One way to express it could be a big preface with multiple property tables – and then a repetition of the property lists.

[AndyOGo]

I face the same issue, using allOf and mixin a ref with properties.

My schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "$id": "http://www.axa.ch/schemas/components/Link.json",
    "type": "object",
    "title": "Link",
    "description": "Renders a Link.",
    "additionalProperties": false,
    "required": [
        "name",
        "component"
    ],
    "properties": {
        "name": {
            "$ref": "http://www.axa.ch/schemas/types/bpmid.json#"
        },
        "component": {
            "allOf": [
                {
                    "$ref": "http://www.axa.ch/schemas/types/component.json#"
                },
                {
                    "enum": [
                        "Link"
                    ]
                }
            ]
        },
        "properties": {
            "type": "object",
            "title": "Properties",
            "description": "Properties of Link.",
            "additionalProperties": false,
            "properties": {
                "value": {
                    "type": "string",
                    "title": "Value",
                    "description": "The value of the Link."
                },
                "href": {
                    "type": "string",
                    "title": "Href",
                    "description": "URL of the Link."
                }
            }
        },
        "style": {
            "type": "object",
            "title": "Style",
            "description": "Styles of Textarea.",
            "additionalProperties": false,
            "properties": {
                "color": {
                    "type": "string",
                    "title": "Color",
                    "description": "Color of Link.",
                    "enum": [
                        "red",
                        "white",
                        "blue"
                    ],
                    "default": "blue"
                },
                "listed": {
                    "type": "boolean",
                    "title": "Listed",
                    "description": "Whether or not to us lested style.",
                    "default": "false"
                },
                "arrow": {
                    "type": "boolean",
                    "title": "Arrow",
                    "description": "Whether or not to display an arrow icon or not.",
                    "default": "false"
                },
                "motion": {
                    "type": "boolean",
                    "title": "Motion",
                    "description": "Whether or not to use animation upon hovering.",
                    "default": "false"
                }
            }
        },
        "events": {
            "type": "array",
            "title": "Events",
            "description": "Supported events of Link.",
            "uniqueItems": true,
            "additionalItems": false,
            "items": [
                {
                    "$ref": "http://www.axa.ch/schemas/types/event.json#"
                }
            ]
        }
    }
}

And the generated markdown:

# Link Schema

http://www.axa.ch/schemas/components/Link.json

Renders a Link.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|----------|------------|--------|--------------|-------------------|-----------------------|------------|
| Can be instantiated | No | Experimental | No | Forbidden | Forbidden | [components/Link.json](components/Link.json) |
## Schema Hierarchy

* Link `http://www.axa.ch/schemas/components/Link.json`
  * [BPMID](../types/bpmid.md) `http://www.axa.ch/schemas/types/bpmid.json`


# Link Properties

| Property | Type | Required | Defined by |
|----------|------|----------|------------|
| [component](#component) | complex | **Required** | Link (this schema) |
| [events](#events) | `array` | Optional | Link (this schema) |
| [name](#name) | BPMID | **Required** | Link (this schema) |
| [properties](#properties) | `object` | Optional | Link (this schema) |
| [style](#style) | `object` | Optional | Link (this schema) |

## component


`component`
* is **required**
* type: complex
* defined in this schema

### component Type


**All** of the following *requirements* need to be fulfilled.


#### Requirement 1


* []() – `http://www.axa.ch/schemas/types/component.json#`


#### Requirement 2







## events
### Events

Supported events of Link.

`events`
* is optional
* type: `array`

* defined in this schema

### events Type


Array type: `array`

All items must be of the type:
Unknown type ``.

```json
{
  "type": "array",
  "title": "Events",
  "description": "Supported events of Link.",
  "uniqueItems": true,
  "additionalItems": false,
  "items": [
    {
      "$ref": "http://www.axa.ch/schemas/types/event.json#"
    }
  ],
  "simpletype": "`array`"
}

name

name

• is required
• type: BPMID
• defined in this schema

name Type

• BPMID – http://www.axa.ch/schemas/types/bpmid.json#

properties

Properties

Properties of Link.

properties

• is optional
• type: object
• defined in this schema

properties Type

object with following properties:

Property	Type	Required
href	string	Optional
value	string	Optional

href

Href

URL of the Link.

href

• is optional
• type: string

href Type

string

value

Value

The value of the Link.

value

• is optional
• type: string

value Type

string

style

Style

Styles of Textarea.

style

• is optional
• type: object
• defined in this schema

style Type

object with following properties:

Property	Type	Required	Default
arrow	boolean	Optional	"false"
color	string	Optional	"blue"
listed	boolean	Optional	"false"
motion	boolean	Optional	"false"

arrow

Arrow

Whether or not to display an arrow icon or not.

arrow

• is optional
• type: boolean
• default: "false"

arrow Type

boolean

color

Color

Color of Link.

color

• is optional
• type: enum
• default: "blue"

The value of this property must be equal to one of the known values below.

color Known Values

Value	Description
red
white
blue

listed

Listed

Whether or not to us lested style.

listed

• is optional
• type: boolean
• default: "false"

listed Type

boolean

motion

Motion

Whether or not to use animation upon hovering.

motion

• is optional
• type: boolean
• default: "false"

motion Type

boolean

[trieloff]

🎉 This issue has been resolved in version 4.0.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀