Brooklyn

brooklyn.rest.apidoc
[Java] Annotation Type Apidoc

java.lang.Object
  brooklyn.rest.apidoc.Apidoc

@java.lang.annotation.Target(ElementType.TYPE)
@java.lang.annotation.Retention(RetentionPolicy.RUNTIME)
public @interface Apidoc

like Swagger Api annotation (and treated similarly) but doesn't require path to be repeated, and supports a name


Required Element Summary
java.lang.String value

 
Optional Element Summary
java.lang.String description

@default ""

 
Method Summary
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Element Detail

description

public java.lang.String description
@default ""


value

public java.lang.String value


 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.