DashboardsCollection: Don't serialize 'isDefault' as 'default'
The name 'default' can't be used as a member name because it's a
reserved word in Java. Instead it is defined as isDefault, and its
serialization overrided as "default" using gson's @SerializedName
annotation.
This is inconsistent with other REST APIs, which do not override
such names. For example "isPrivate" is allowed to be serialized
as "is_private".
Also, using @SerializedName means that if we want to move the
DashboardInfo class out to the extension API, we would also need
to introduce a dependency on gson in the extension API.
Remove the annotation and let it be serialized as "is_default".
Adjust the GWT UI to use the new name. Include support for the old
name for backwards compatibility in case the GWT UI and backend
are updated separately.
Change-Id: I3ddbb1f15a388c03386d088b9a45a7da1e060e0a
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt
index 11277f3..f083d073 100644
--- a/Documentation/rest-api-projects.txt
+++ b/Documentation/rest-api-projects.txt
@@ -2347,7 +2347,7 @@
"path": "closed",
"description": "Merged and abandoned changes in last 7 weeks",
"url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w",
- "default": true,
+ "is_default": true,
"title": "Closed changes",
"sections": [
{
@@ -2398,7 +2398,7 @@
"path": "closed",
"description": "Merged and abandoned changes in last 7 weeks",
"url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w",
- "default": true,
+ "is_default": true,
"title": "Closed changes",
"sections": [
{
@@ -2434,7 +2434,7 @@
"path": "closed",
"description": "Merged and abandoned changes in last 7 weeks",
"url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w",
- "default": true,
+ "is_default": true,
"title": "Closed changes",
"sections": [
{
@@ -2489,7 +2489,7 @@
"path": "closed",
"description": "Merged and abandoned changes in last 7 weeks",
"url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w",
- "default": true,
+ "is_default": true,
"title": "Closed changes",
"sections": [
{
@@ -2830,7 +2830,7 @@
The URL under which the dashboard can be opened in the Gerrit Web UI. +
The URL is relative to the canonical web URL. +
Tokens in the queries such as `${project}` are resolved.
-|`default` |not set if `false`|
+|`is_default` |not set if `false`|
Whether this is the default dashboard of the project.
|`title` |optional|The title of the dashboard.
|`sections` ||
diff --git a/gerrit-gwtui/src/main/java/com/google/gerrit/client/dashboards/DashboardInfo.java b/gerrit-gwtui/src/main/java/com/google/gerrit/client/dashboards/DashboardInfo.java
index 0d49677..5c6b51a 100644
--- a/gerrit-gwtui/src/main/java/com/google/gerrit/client/dashboards/DashboardInfo.java
+++ b/gerrit-gwtui/src/main/java/com/google/gerrit/client/dashboards/DashboardInfo.java
@@ -35,7 +35,13 @@
public final native String url() /*-{ return this.url; }-*/;
- public final native boolean isDefault() /*-{ return this['default'] ? true : false; }-*/;
+ private final native boolean isDefaultLegacy() /*-{ return this['default'] ? true : false; }-*/;
+
+ private final native boolean isDefaultNew() /*-{ return this.is_default ? true : false; }-*/;
+
+ public final boolean isDefault() {
+ return isDefaultLegacy() || isDefaultNew();
+ }
protected DashboardInfo() {}
}
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/project/DashboardsCollection.java b/gerrit-server/src/main/java/com/google/gerrit/server/project/DashboardsCollection.java
index e806ed5..70bc8e2 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/project/DashboardsCollection.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/project/DashboardsCollection.java
@@ -39,7 +39,6 @@
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.RefPermission;
-import com.google.gson.annotations.SerializedName;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
@@ -230,7 +229,6 @@
String foreach;
String url;
- @SerializedName("default")
Boolean isDefault;
String title;
