Building Forest Specification

A forest specification, or ForestSpec, is a way for your code to identify the forest that you'd like to access. The forest may come from different sources – it could be a structure, it could be a transformed structure, it could be a result of query or some other types of forest source.

So the first step before you read or update a forest is to create an instance of ForestSpec. Here are some examples of how you can do that.

ForestSpec.structure(123)

ForestSpec.sQuery("jql", "priority = Blocker")

ForestSpec.sQuery("text", "text to find")

ForestSpec.structure(123).transform(
    CoreStructureGenerators.SORTER_ATTRIBUTE, ImmutableMap.of(
        "attribute", (Object) ImmutableMap.of("id", IssueFieldConstants.PRIORITY, "format", "order")
        "desc", true
    )
);

ForestSpec.skeleton(123)

ForestSpec.skeleton(123).withTitle()

More details are available in Javadocs for ForestSpec.