JadeOpenAPIGenerator Methods

The methods defined in the JadeOpenAPIGenerator class are summarized in the following table.

Method	Description
create	Instantiates the JadeOpenAPIGenerator class and sets the value of the restClass property to the specified class
deletePath	Excludes the specified path (that is, representation of a method) from the specification
getOpenApiSpec	Generates the OpenAPI specification and returns it as a string
getSavedSemanticVersion	Returns the version of the OpenAPI specification in semantic versioning format if it has previously been saved to the REST class associated with the JadeOpenAPIGenerator; otherwise it returns "1.0.0"
incrementSemanticVer	Takes a version number in semantic versioning format and returns a string representing the next version
isValidSemanticVer	Returns true if the provided string is a version number in semantic versioning format; otherwise it returns false
resetComponents	Resets all components in the specification to default values based on classes referenced in methods of the REST class
resetPaths	Resets all components in the specification to default values based on methods of the REST class
saveComponent	Sets the example and description for a component to new values
saveComponentProperty	Sets the description of a component property to a new value
saveParamDesc	Sets the description of a method parameter to a new value
savePath	Sets the summary and description for a method to new values
saveSpecToRestClass	Saves a specification and version number to the REST class associated with the generator
setProtectedPropsAllowed	Specifies whether properties on that are marked as protected on components are included in the OpenAPI specification

2020.0.02 and higher