Skip to content

Header option seems to not be functional #209

@lisastaehli

Description

@lisastaehli

What did you do

I tried to remove headers as described in #154 and #153.

What did you expect to happen

That headers will be removed in the generated markdown files.

What happened

The headers were not removed in the generated markdown files. I might be missing some parameters in the schema or the arguments but cannot seem to find the cause of this.

From my understanding, this part of the markdown below should be removed if this is working properly:

---- HEADER -----

Branches Schema

undefined

Example.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none branches.json

---- HEADER -----

What's your environment

  • Operating System: Windows
  • node.js version: v12.13.0

Do you have example files:

For this schema

{ 
   "type":"object",
   "title":"Branches",
   "description":"Example.",
   "required":[ 
      "BranchName",
      "BranchOrder",
      "Existing",
      "OwnerName",
      "UrbanEventID"
   ],
   "properties":{ 
      "GlobalID":{ 
         "type":[ 
            "string",
            "null"
         ],
         "description":"Global ID."
      },
      "CreationDate":{ 
         "type":"integer",
         "date":true
      }
   }
}

I'm getting following Markdown when running
jsonschema2md -d docs -o docs/md -h false

Branches Schema

undefined

Example.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none branches.json

Branches Type

object (Branches)

Branches Properties

Property Type Required Nullable Defined by
GlobalID string Optional can be null Branches
CreationDate integer Optional cannot be null Branches

GlobalID

Global ID.

GlobalID

  • is optional
  • Type: string
  • can be null
  • defined in: Branches

GlobalID Type

string

CreationDate

CreationDate

  • is optional
  • Type: integer
  • cannot be null
  • defined in: Branches

CreationDate Type

integer

Thanks for the help!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions