Package com.mayam.wf.ws.rest

Interface ExampleRegistry.Example

Enclosing interface:
ExampleRegistry
public static interface ExampleRegistry.Example

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Short description of the example (or null).
    String
    getLocator()
    The fully qualified name of a data type/valueClass (i.e.
    Object
    getSerializable()
    The root object of the example, which will be serialized by Jackson.

  • Method Details

    • getLocator

      String getLocator()
      The fully qualified name of a data type/valueClass (i.e. com.mayam.wf.attributes.shared.AttributeMap) or a locator for a resource operation request or response body. The latter takes the form of resourceClassName + "::" + methodName + "#" + isRequest?"request":"response" (i.e. com.mayam.wf.ws.rest.resource.AssetsResource::createAsset#request). More than one example is allowed per locator.

    • getDescription

      String getDescription()
      Short description of the example (or null).

    • getSerializable

      Object getSerializable()
      The root object of the example, which will be serialized by Jackson.