Package org.brapi.schematools.core.markdown

Class MarkdownGenerator

java.lang.Object
org.brapi.schematools.core.markdown.MarkdownGenerator
public class MarkdownGenerator extends Object
Generates a Markdown files for type and their field descriptions from a BrAPI Json Schema.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MarkdownGenerator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Response<List<Path>>
    generate(Path schemaDirectory)
    Generates Markdown files for type and their field descriptions from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MarkdownGenerator

      public MarkdownGenerator()

  • Method Details

    • generate

      public Response<List<Path>> generate(Path schemaDirectory)
      Generates Markdown files for type and their field descriptions from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
      Parameters:
      schemaDirectory - the path to the complete BrAPI Specification
      Returns:
      the paths of the Markdown files generated from the complete BrAPI Specification