org.jenkinsci.plugins.pipeline.modeldefinition

Class ASTSchema

java.lang.Object

org.jenkinsci.plugins.pipeline.modeldefinition.ASTSchema

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
public class ASTSchema
extends Object
implements RootAction

Endpoint for exposing the AST JSON schema.

Author:

Andrew Bayer

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	AST_SCHEMA_URL

Constructor Summary

Constructors

Constructor and Description
ASTSchema()

Method Summary

Modifier and Type	Method and Description
void	doJson(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
String	getDisplayName()
String	getIconFileName()
static com.github.fge.jsonschema.main.JsonSchema	getJSONSchema() Get the Pipeline Config AST JSON schema.
String	getUrlName()

Methods inherited from class java.lang.Object

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

Field Detail

AST_SCHEMA_URL

public static final String AST_SCHEMA_URL

See Also:

Constant Field Values

Constructor Detail

ASTSchema

public ASTSchema()

Method Detail

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

doJson

public void doJson(org.kohsuke.stapler.StaplerRequest req,
                   org.kohsuke.stapler.StaplerResponse rsp)
            throws IOException,
                   javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getJSONSchema

public static com.github.fge.jsonschema.main.JsonSchema getJSONSchema()
                                                               throws com.github.fge.jsonschema.exceptions.ProcessingException

Get the Pipeline Config AST JSON schema.

Returns:

the schema in JsonSchema form.

Throws:

com.github.fge.jsonschema.exceptions.ProcessingException - if there are issues reading the schema