The Unified and Autonomous Development Platform
Improved restful api help
Robin Shende909a166b44
diff --git a/server-core/src/main/java/io/onedev/server/model/Membership.java b/server-core/src/main/java/io/onedev/server/model/Membership.javaindex 214ecef662..0f2e61c5af 100644--- a/server-core/src/main/java/io/onedev/server/model/Membership.java+++ b/server-core/src/main/java/io/onedev/server/model/Membership.java@@ -1,16 +1,10 @@package io.onedev.server.model;-import javax.persistence.Entity;-import javax.persistence.FetchType;-import javax.persistence.Index;-import javax.persistence.JoinColumn;-import javax.persistence.ManyToOne;-import javax.persistence.Table;-import javax.persistence.UniqueConstraint;-import org.hibernate.annotations.Cache;import org.hibernate.annotations.CacheConcurrencyStrategy;+import javax.persistence.*;+@Entity@Table(indexes={@Index(columnList="o_user_id"), @Index(columnList="o_group_id")},@@ -32,7 +26,7 @@ public class Membership extends AbstractEntity {@ManyToOne(fetch=FetchType.LAZY)@JoinColumn(nullable=false)private Group group;-+public User getUser() {return user;}diff --git a/server-core/src/main/java/io/onedev/server/rest/AgentTokenResource.java b/server-core/src/main/java/io/onedev/server/rest/AgentTokenResource.javaindex b107aa179c..9b79931d3d 100644--- a/server-core/src/main/java/io/onedev/server/rest/AgentTokenResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/AgentTokenResource.java@@ -1,25 +1,5 @@package io.onedev.server.rest;-import java.util.Collection;-import java.util.List;-import java.util.UUID;--import javax.inject.Inject;-import javax.inject.Singleton;-import javax.ws.rs.Consumes;-import javax.ws.rs.DELETE;-import javax.ws.rs.GET;-import javax.ws.rs.POST;-import javax.ws.rs.Path;-import javax.ws.rs.PathParam;-import javax.ws.rs.Produces;-import javax.ws.rs.QueryParam;-import javax.ws.rs.core.MediaType;-import javax.ws.rs.core.Response;--import org.apache.shiro.authz.UnauthorizedException;-import org.hibernate.criterion.Restrictions;-import io.onedev.server.entitymanager.AgentTokenManager;import io.onedev.server.model.Agent;import io.onedev.server.model.AgentToken;@@ -28,6 +8,16 @@ import io.onedev.server.rest.annotation.Api;import io.onedev.server.rest.exception.InvalidParamException;import io.onedev.server.rest.support.RestConstants;import io.onedev.server.security.SecurityUtils;+import org.apache.shiro.authz.UnauthorizedException;+import org.hibernate.criterion.Restrictions;++import javax.inject.Inject;+import javax.inject.Singleton;+import javax.ws.rs.*;+import javax.ws.rs.core.MediaType;+import javax.ws.rs.core.Response;+import java.util.Collection;+import java.util.List;@Api(order=10100)@Path("/agent-tokens")@@ -81,13 +71,11 @@ public class AgentTokenResource {return tokenManager.query(criteria, offset, count);}- @Api(order=500, description="Create new token if id property not provided")+ @Api(order=500, createOnly = true, description="Create new token")@POST- public Long createOrUpdate() {+ public Long create(AgentToken token) {if (!SecurityUtils.isAdministrator())throw new UnauthorizedException();- AgentToken token = new AgentToken();- token.setValue(UUID.randomUUID().toString());tokenManager.create(token);return token.getId();}diff --git a/server-core/src/main/java/io/onedev/server/rest/IssueVoteResource.java b/server-core/src/main/java/io/onedev/server/rest/IssueVoteResource.javaindex b186ada9bb..6aaba72b32 100644--- a/server-core/src/main/java/io/onedev/server/rest/IssueVoteResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/IssueVoteResource.java@@ -44,7 +44,7 @@ public class IssueVoteResource {return vote;}- @Api(order=200, description="Create new issue vote. Id property should not be specified")+ @Api(order=200, createOnly = true, description="Create new issue vote")@POSTpublic Long create(@NotNull IssueVote vote) {if (!SecurityUtils.canAccess(vote.getIssue().getProject())diff --git a/server-core/src/main/java/io/onedev/server/rest/MembershipResource.java b/server-core/src/main/java/io/onedev/server/rest/MembershipResource.javaindex ceb081c649..4e484a60a0 100644--- a/server-core/src/main/java/io/onedev/server/rest/MembershipResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/MembershipResource.java@@ -13,6 +13,8 @@ import javax.ws.rs.Produces;import javax.ws.rs.core.MediaType;import javax.ws.rs.core.Response;+import io.onedev.server.model.Group;+import io.onedev.server.model.User;import org.apache.shiro.authz.UnauthorizedException;import io.onedev.server.entitymanager.MembershipManager;@@ -20,6 +22,8 @@ import io.onedev.server.model.Membership;import io.onedev.server.rest.annotation.Api;import io.onedev.server.security.SecurityUtils;+import java.lang.reflect.Member;+@Api(order=6100)@Path("/memberships")@Consumes(MediaType.APPLICATION_JSON)@@ -43,7 +47,7 @@ public class MembershipResource {return membershipManager.load(membershipId);}- @Api(order=200, description="Create new membership. Id property should not be specified")+ @Api(order=200, createOnly = true, description="Create new membership")@POSTpublic Long create(@NotNull Membership membership) {if (!SecurityUtils.isAdministrator())diff --git a/server-core/src/main/java/io/onedev/server/rest/PullRequestAssignmentResource.java b/server-core/src/main/java/io/onedev/server/rest/PullRequestAssignmentResource.javaindex 4fccd3d747..46d3ff8c25 100644--- a/server-core/src/main/java/io/onedev/server/rest/PullRequestAssignmentResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/PullRequestAssignmentResource.java@@ -45,7 +45,7 @@ public class PullRequestAssignmentResource {return assignment;}- @Api(order=200, description="Create new pull request assignment. Id property should not be specified")+ @Api(order=200, createOnly = true, description="Create new pull request assignment")@POSTpublic Long create(PullRequestAssignment assignment) {PullRequest pullRequest = assignment.getRequest();diff --git a/server-core/src/main/java/io/onedev/server/rest/SshKeyResource.java b/server-core/src/main/java/io/onedev/server/rest/SshKeyResource.javaindex 9e304575bf..ac6b2f1325 100644--- a/server-core/src/main/java/io/onedev/server/rest/SshKeyResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/SshKeyResource.java@@ -45,7 +45,7 @@ public class SshKeyResource {return sshKey;}- @Api(order=150, description="Create new ssh key. Id property should not be specified")+ @Api(order=150, createOnly = true, description="Create new ssh key")@POSTpublic Long create(SshKey sshKey) {if (!SecurityUtils.isAdministrator() && !sshKey.getOwner().equals(SecurityUtils.getUser()))diff --git a/server-core/src/main/java/io/onedev/server/rest/annotation/Api.java b/server-core/src/main/java/io/onedev/server/rest/annotation/Api.javaindex fd8a3f588c..1f0af24a5c 100644--- a/server-core/src/main/java/io/onedev/server/rest/annotation/Api.java+++ b/server-core/src/main/java/io/onedev/server/rest/annotation/Api.java@@ -19,6 +19,8 @@ public @interface Api {boolean readOnly() default false;+ boolean createOnly() default false;+int order() default 100;}diff --git a/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java b/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.javaindex e9e45ed55f..b336ab5254 100644--- a/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java+++ b/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java@@ -35,6 +35,7 @@ import org.apache.wicket.util.visit.IVisitor;import org.glassfish.jersey.server.ResourceConfig;import javax.annotation.Nullable;+import javax.persistence.Id;import javax.persistence.JoinColumn;import javax.persistence.ManyToOne;import javax.ws.rs.GET;@@ -126,14 +127,9 @@ public class ExampleValuePanel extends Panel {builder.append(toJson(((AbstractEntity)getValue()).getId()));} else if (getValue() instanceof Collection) {List<String> elements = new ArrayList<>();- visitChildren(ExampleValuePanel.class, new IVisitor<ExampleValuePanel, Void>() {-- @Override- public void component(ExampleValuePanel object, IVisit<Void> visit) {- elements.add(object.getValueAsJson());- visit.dontGoDeeper();- }-+ visitChildren(ExampleValuePanel.class, (IVisitor<ExampleValuePanel, Void>) (object, visit) -> {+ elements.add(object.getValueAsJson());+ visit.dontGoDeeper();});if (elements.isEmpty())builder.append("[ ]");@@ -315,29 +311,29 @@ public class ExampleValuePanel extends Panel {private Fragment newArrayFragment() {Fragment fragment = new Fragment("content", "arrayFrag", this);- fragment.add(new ListView<Serializable>("elements", new AbstractReadOnlyModel<List<Serializable>>() {+ fragment.add(new ListView<>("elements", new AbstractReadOnlyModel<List<Serializable>>() {@SuppressWarnings("unchecked")@Overridepublic List<Serializable> getObject() {- return new ArrayList<Serializable>((Collection<? extends Serializable>) getValue());+ return new ArrayList<>((Collection<? extends Serializable>) getValue());}-+}) {@Overrideprotected void populateItem(ListItem<Serializable> item) {- IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<ValueInfo>() {+ IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {Type declaredType = ReflectionUtils.getCollectionElementType(getDeclaredType());- return new ValueInfo(getValueOrigin(), declaredType, null);+ return new ValueInfo(getValueOrigin(), declaredType);}-+};- item.add(new ExampleValuePanel("element", new IModel<Serializable>() {+ item.add(new ExampleValuePanel("element", new IModel<>() {@Overridepublic void detach() {@@ -348,20 +344,20 @@ public class ExampleValuePanel extends Panel {return item.getModelObject();}- @SuppressWarnings({ "unchecked", "rawtypes" })+ @SuppressWarnings({"unchecked", "rawtypes"})@Overridepublic void setObject(Serializable object) {- Collection collection = (Collection)getValue();+ Collection collection = (Collection) getValue();collection.remove(item.getModelObject());collection.add(object);}-+}, valueInfoModel, requestBodyClass));-+item.add(new WebMarkupContainer("comma")- .setVisible(item.getIndex() < getModelObject().size()-1));+ .setVisible(item.getIndex() < getModelObject().size() - 1));}-+});return fragment;}@@ -371,42 +367,42 @@ public class ExampleValuePanel extends Panel {fragment.add(new WebMarkupContainer("typeInfo").setVisible(false));- IModel<List<Map.Entry<Serializable, Serializable>>> entriesModel =- new AbstractReadOnlyModel<List<Map.Entry<Serializable, Serializable>>>() {+ IModel<List<Map.Entry<Serializable, Serializable>>> entriesModel =+ new AbstractReadOnlyModel<>() {- @SuppressWarnings("unchecked")- @Override- public List<Map.Entry<Serializable, Serializable>> getObject() {- return new ArrayList<Map.Entry<Serializable, Serializable>>(((Map<Serializable, Serializable>)getValue()).entrySet());- }-- };+ @SuppressWarnings("unchecked")+ @Override+ public List<Map.Entry<Serializable, Serializable>> getObject() {+ return new ArrayList<>(((Map<Serializable, Serializable>) getValue()).entrySet());+ }++ };- fragment.add(new ListView<Map.Entry<Serializable, Serializable>>("properties", entriesModel) {+ fragment.add(new ListView<>("properties", entriesModel) {@Overrideprotected void populateItem(ListItem<Map.Entry<Serializable, Serializable>> item) {- IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<ValueInfo>() {+ IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {Type declaredType = ReflectionUtils.getMapKeyType(getDeclaredType());- return new ValueInfo(getValueOrigin(), declaredType, null);+ return new ValueInfo(getValueOrigin(), declaredType);}-+};item.add(new ExampleValuePanel("name", Model.of(item.getModelObject().getKey()), valueInfoModel, requestBodyClass));-- valueInfoModel = new LoadableDetachableModel<ValueInfo>() {++ valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {Type declaredType = ReflectionUtils.getMapValueType(getDeclaredType());- return new ValueInfo(getValueOrigin(), declaredType, null);+ return new ValueInfo(getValueOrigin(), declaredType);}-+};- item.add(new ExampleValuePanel("value", new IModel<Serializable>() {+ item.add(new ExampleValuePanel("value", new IModel<>() {@Overridepublic void detach() {@@ -420,16 +416,16 @@ public class ExampleValuePanel extends Panel {@SuppressWarnings("unchecked")@Overridepublic void setObject(Serializable object) {- Map<Serializable, Serializable> map = (Map<Serializable, Serializable>)getValue();+ Map<Serializable, Serializable> map = (Map<Serializable, Serializable>) getValue();map.put(item.getModelObject().getKey(), object);}-+}, valueInfoModel, requestBodyClass));-+item.add(new WebMarkupContainer("comma")- .setVisible(item.getIndex() < getModelObject().size()-1));+ .setVisible(item.getIndex() < getModelObject().size() - 1));}-+});return fragment;}@@ -437,13 +433,18 @@ public class ExampleValuePanel extends Panel {private Fragment newObjectFragment() {Fragment fragment = new Fragment("content", "objectFrag", this);- IModel<List<Field>> fieldsModel = new LoadableDetachableModel<List<Field>>() {+ IModel<List<Field>> fieldsModel = new LoadableDetachableModel<>() {@Overrideprotected List<Field> load() {- return ApiHelpUtils.getJsonFields(getValue().getClass(), getValueOrigin());+ List<Field> fields = ApiHelpUtils.getJsonFields(getValue().getClass(), getValueOrigin());+ for (Iterator<Field> it = fields.iterator(); it.hasNext();) {+ if (getValueInfo().isCreateOnly() && it.next().getAnnotation(Id.class) != null)+ it.remove();+ }+ return fields;}-+};if (getDeclaredClass() != null@@ -452,23 +453,23 @@ public class ExampleValuePanel extends Panel {&& !Map.class.isAssignableFrom(getDeclaredClass())) {Fragment typeInfoFragment = new Fragment("typeInfo", "typeInfoFrag", this);- IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<ValueInfo>() {+ IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {- return new ValueInfo(getValueOrigin(), String.class, null);+ return new ValueInfo(getValueOrigin(), String.class);}-+};typeInfoFragment.add(new ExampleValuePanel("name", Model.of(JsonTypeInfo.Id.NAME.getDefaultPropertyName()),valueInfoModel, requestBodyClass));- typeInfoFragment.add(new ExampleValuePanel("value", new AbstractReadOnlyModel<Serializable>() {+ typeInfoFragment.add(new ExampleValuePanel("value", new AbstractReadOnlyModel<>() {@Overridepublic Serializable getObject() {return getValue().getClass().getSimpleName();}-+}, valueInfoModel, requestBodyClass));typeInfoFragment.add(new MenuLink("implementations") {@@ -526,7 +527,7 @@ public class ExampleValuePanel extends Panel {@Overrideprotected ValueInfo load() {- return new ValueInfo(getValueOrigin(), String.class, null);+ return new ValueInfo(getValueOrigin(), String.class);}};@@ -536,17 +537,17 @@ public class ExampleValuePanel extends Panel {item.add(new ExampleValuePanel("name", Model.of(field.getName()), valueInfoModel, requestBodyClass));field.setAccessible(true);- valueInfoModel = new LoadableDetachableModel<ValueInfo>() {+ valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {Field field = item.getModelObject();- return new ValueInfo(getValueOrigin(), field.getGenericType(), field);+ return new ValueInfo(getValueOrigin(), field.getGenericType(), field, false);}-+};- item.add(new ExampleValuePanel("value", new IModel<Serializable>() {+ item.add(new ExampleValuePanel("value", new IModel<>() {@Overridepublic void detach() {@@ -560,7 +561,7 @@ public class ExampleValuePanel extends Panel {return (Serializable) field.get(getValue());} catch (IllegalArgumentException | IllegalAccessException e) {throw new RuntimeException(e);- }+ }}@Override@@ -573,7 +574,7 @@ public class ExampleValuePanel extends Panel {throw new RuntimeException(e);}}-+}, valueInfoModel, requestBodyClass));item.add(new WebMarkupContainer("comma")diff --git a/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java b/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.javaindex 0a277560d1..891c65027d 100644--- a/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java@@ -132,12 +132,14 @@ public class MethodDetailPage extends ApiHelpPage {if (exampleValue == null)exampleValue = ApiHelpUtils.getExampleValue(param.getParameterizedType(), ValueInfo.Origin.REQUEST_BODY);requestBodyClass = exampleValue.getClass();- IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<ValueInfo>() {+ IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {+ Api api = getResourceMethod().getAnnotation(Api.class);return new ValueInfo(ValueInfo.Origin.REQUEST_BODY,- getRequestBodyParam().getParameterizedType(), null);+ getRequestBodyParam().getParameterizedType(), null,+ api != null && api.createOnly());}};@@ -224,7 +226,7 @@ public class MethodDetailPage extends ApiHelpPage {@Overrideprotected ValueInfo load() {return new ValueInfo(ValueInfo.Origin.PATH_PLACEHOLDER,- item.getModelObject().getParameterizedType(), null);+ item.getModelObject().getParameterizedType());}};@@ -275,7 +277,7 @@ public class MethodDetailPage extends ApiHelpPage {@Overrideprotected ValueInfo load() {return new ValueInfo(ValueInfo.Origin.QUERY_PARAM,- item.getModelObject().getParameterizedType(), null);+ item.getModelObject().getParameterizedType());}};@@ -307,12 +309,12 @@ public class MethodDetailPage extends ApiHelpPage {if (exampleValue == null)exampleValue = ApiHelpUtils.getExampleValue(method.getGenericReturnType(), ValueInfo.Origin.RESPONSE_BODY);- IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<ValueInfo>() {+ IModel<ValueInfo> valueInfoModel = new LoadableDetachableModel<>() {@Overrideprotected ValueInfo load() {return new ValueInfo(ValueInfo.Origin.RESPONSE_BODY,- getResourceMethod().getGenericReturnType(), null);+ getResourceMethod().getGenericReturnType());}};@@ -417,7 +419,7 @@ public class MethodDetailPage extends ApiHelpPage {add(new Label("curlExample", curlExample));- add(new CopyToClipboardLink("copyCurlExample", Model.of(curlExample.toString().substring(1))));+ add(new CopyToClipboardLink("copyCurlExample", Model.of(curlExample.substring(1))));}@Overridediff --git a/server-core/src/main/java/io/onedev/server/web/page/help/ValueInfo.java b/server-core/src/main/java/io/onedev/server/web/page/help/ValueInfo.javaindex 5d9923c2ae..860dd181fb 100644--- a/server-core/src/main/java/io/onedev/server/web/page/help/ValueInfo.java+++ b/server-core/src/main/java/io/onedev/server/web/page/help/ValueInfo.java@@ -15,12 +15,19 @@ class ValueInfo {private final Field field;- public ValueInfo(Origin origin, Type declaredType, @Nullable Field field) {+ private final boolean createOnly;++ public ValueInfo(Origin origin, Type declaredType, @Nullable Field field, boolean createOnly) {this.origin = origin;this.declaredType = declaredType;this.field = field;+ this.createOnly = createOnly;}+ public ValueInfo(Origin origin, Type declaredType) {+ this(origin, declaredType, null, false);+ }+public Type getDeclaredType() {return declaredType;}@@ -34,4 +41,7 @@ class ValueInfo {return field;}+ public boolean isCreateOnly() {+ return createOnly;+ }}\ No newline at end of file