com.phoenixnap.oss.ramlapisync.verification

Interface RamlActionVisitorCheck

All Known Implementing Classes:

ActionContentTypeChecker, ActionQueryParameterChecker, ActionResponseBodySchemaChecker

public interface RamlActionVisitorCheck

A visitor that will be invoked when an action is identified

Since:

0.0.2

Author:

Kurt Paris

Method Summary

Modifier and Type	Method and Description
Pair<Set<Issue>,Set<Issue>>	check(RamlActionType name, RamlAction reference, RamlAction target, IssueLocation location, IssueSeverity maxSeverity) Checks a particular action

Method Detail

check

Pair<Set<Issue>,Set<Issue>> check(RamlActionType name,
                                  RamlAction reference,
                                  RamlAction target,
                                  IssueLocation location,
                                  IssueSeverity maxSeverity)

Checks a particular action

Parameters:

name - The key/verb of the action

reference - The Action which is the source of truth from the RAML model

target - The target Action to check against from the RAML model

location - The location where the issue (if any) lies

maxSeverity - The maximum severity that can be applied to any errors

Returns:

A pair containing a set of Warnings and Errors (as first and second respectively). This method must not return null.