Skip to content

Commit 1cd28ae

Browse files
committed
<feature>[vm-metadata]: annotate all APIMessage subclasses with @MetadataImpact
Scan all APIMessage subclasses across zstack (excl premium) and add @MetadataImpact annotations per design doc vm-metadata-01b §4: - STORAGE (17 APIs): volume attach/detach/delete/recover, reimage, storage migration, snapshot CRUD, clone, template VM - CONFIG (22 APIs): systemtag CRUD, resourceconfig, update/recover VM, VM NIC ops, boot/ssh/hostname/qga settings, resize volume, convert template - NONE (513 APIs): all remaining APIMessage subclasses Classification rules derived from vm-metadata-01b-API拦截与VM解析.md §4. CI will enforce that all APIMessage subclasses carry this annotation. Resolves: ZSV-10000
1 parent f12598a commit 1cd28ae

552 files changed

Lines changed: 1598 additions & 474 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

core/src/main/java/org/zstack/core/captcha/APIRefreshCaptchaMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import org.zstack.header.message.APIParam;
77
import org.zstack.header.message.APISyncCallMessage;
88
import org.zstack.header.rest.RestRequest;
9+
import org.zstack.header.vm.MetadataImpact;
910

1011
/**
1112
* Created by kayo on 2018/7/6.
@@ -16,6 +17,7 @@
1617
method = HttpMethod.GET,
1718
responseClass = APIRefreshCaptchaReply.class
1819
)
20+
@MetadataImpact(MetadataImpact.Impact.NONE)
1921
public class APIRefreshCaptchaMsg extends APISyncCallMessage {
2022
@APIParam(resourceType = CaptchaVO.class)
2123
private String uuid;

core/src/main/java/org/zstack/core/config/APIGetGlobalConfigOptionsMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
import org.zstack.header.message.APIParam;
55
import org.zstack.header.message.APISyncCallMessage;
66
import org.zstack.header.rest.RestRequest;
7+
import org.zstack.header.vm.MetadataImpact;
78

89
@RestRequest(
910
path = "/global-configurations/{category}/{name}",
1011
method = HttpMethod.GET,
1112
responseClass = APIGetGlobalConfigOptionsReply.class
1213
)
14+
@MetadataImpact(MetadataImpact.Impact.NONE)
1315
public class APIGetGlobalConfigOptionsMsg extends APISyncCallMessage {
1416
@APIParam
1517
private String category;

core/src/main/java/org/zstack/core/config/APIQueryGlobalConfigMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import java.util.List;
99

1010
import static java.util.Arrays.asList;
11+
import org.zstack.header.vm.MetadataImpact;
1112

1213
/**
1314
*/
@@ -17,6 +18,7 @@
1718
method = HttpMethod.GET,
1819
responseClass = APIQueryGlobalConfigReply.class
1920
)
21+
@MetadataImpact(MetadataImpact.Impact.NONE)
2022
public class APIQueryGlobalConfigMsg extends APIQueryMessage {
2123
public static List<String> __example__() {
2224
return asList();

core/src/main/java/org/zstack/core/config/APIResetGlobalConfigMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
import org.zstack.header.message.APIEvent;
55
import org.zstack.header.message.APIMessage;
66
import org.zstack.header.rest.RestRequest;
7+
import org.zstack.header.vm.MetadataImpact;
78

89
@RestRequest(
910
path = "/global-configurations/actions",
1011
method = HttpMethod.PUT,
1112
isAction = true,
1213
responseClass = APIResetGlobalConfigEvent.class
1314
)
15+
@MetadataImpact(MetadataImpact.Impact.NONE)
1416
public class APIResetGlobalConfigMsg extends APIMessage {
1517
public static APIResetGlobalConfigMsg __example__() {
1618
APIResetGlobalConfigMsg msg = new APIResetGlobalConfigMsg();

core/src/main/java/org/zstack/core/config/APIUpdateGlobalConfigMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@
55
import org.zstack.header.message.APIMessage;
66
import org.zstack.header.message.APIParam;
77
import org.zstack.header.rest.RestRequest;
8+
import org.zstack.header.vm.MetadataImpact;
89

910
@RestRequest(
1011
path = "/global-configurations/{category}/{name}/actions",
1112
method = HttpMethod.PUT,
1213
isAction = true,
1314
responseClass = APIUpdateGlobalConfigEvent.class
1415
)
16+
@MetadataImpact(MetadataImpact.Impact.NONE)
1517
public class APIUpdateGlobalConfigMsg extends APIMessage {
1618
@APIParam
1719
private String category;

core/src/main/java/org/zstack/core/debug/APICleanQueueMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import org.zstack.header.message.APIMessage;
66
import org.zstack.header.message.APIParam;
77
import org.zstack.header.rest.RestRequest;
8+
import org.zstack.header.vm.MetadataImpact;
89

910
/**
1011
* Created by LiangHanYu on 2021/5/20 14:51
@@ -14,6 +15,7 @@
1415
isAction = true,
1516
method = HttpMethod.PUT,
1617
responseClass = APICleanQueueEvent.class)
18+
@MetadataImpact(MetadataImpact.Impact.NONE)
1719
public class APICleanQueueMsg extends APIMessage {
1820
@APIParam()
1921
private String signatureName;

core/src/main/java/org/zstack/core/debug/APIDebugSignalMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
import java.util.Arrays;
99
import java.util.List;
10+
import org.zstack.header.vm.MetadataImpact;
1011

1112
/**
1213
* Created by xing5 on 2016/7/25.
@@ -17,6 +18,7 @@
1718
parameterName = "params",
1819
responseClass = APIDebugSignalEvent.class
1920
)
21+
@MetadataImpact(MetadataImpact.Impact.NONE)
2022
public class APIDebugSignalMsg extends APIMessage {
2123
@APIParam
2224
private List<String> signals;

core/src/main/java/org/zstack/core/debug/APIGetDebugSignalMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
import org.springframework.http.HttpMethod;
44
import org.zstack.header.message.APISyncCallMessage;
55
import org.zstack.header.rest.RestRequest;
6+
import org.zstack.header.vm.MetadataImpact;
67

78
@RestRequest(
89
path = "/debug",
910
method = HttpMethod.GET,
1011
responseClass = APIGetDebugSignalReply.class)
12+
@MetadataImpact(MetadataImpact.Impact.NONE)
1113
public class APIGetDebugSignalMsg extends APISyncCallMessage {
1214
public static APIGetDebugSignalMsg __example__() {
1315
APIGetDebugSignalMsg msg = new APIGetDebugSignalMsg();

core/src/main/java/org/zstack/core/errorcode/APICheckElaborationContentMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import org.zstack.header.message.APIParam;
55
import org.zstack.header.message.APISyncCallMessage;
66
import org.zstack.header.rest.RestRequest;
7+
import org.zstack.header.vm.MetadataImpact;
78

89
/**
910
* Created by mingjian.deng on 2018/12/21.
@@ -14,6 +15,7 @@
1415
responseClass = APICheckElaborationContentReply.class,
1516
parameterName = "params"
1617
)
18+
@MetadataImpact(MetadataImpact.Impact.NONE)
1719
public class APICheckElaborationContentMsg extends APISyncCallMessage {
1820
@APIParam(nonempty = true, emptyString = false, required = false)
1921
private String elaborateFile;

core/src/main/java/org/zstack/core/errorcode/APIGetElaborationCategoriesMsg.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import org.springframework.http.HttpMethod;
44
import org.zstack.header.message.APISyncCallMessage;
55
import org.zstack.header.rest.RestRequest;
6+
import org.zstack.header.vm.MetadataImpact;
67

78
/**
89
* Created by mingjian.deng on 2018/12/1.
@@ -12,6 +13,7 @@
1213
method = HttpMethod.GET,
1314
responseClass = APIGetElaborationCategoriesReply.class
1415
)
16+
@MetadataImpact(MetadataImpact.Impact.NONE)
1517
public class APIGetElaborationCategoriesMsg extends APISyncCallMessage {
1618
public static APIGetElaborationCategoriesMsg __example__() {
1719
return new APIGetElaborationCategoriesMsg();

0 commit comments

Comments
 (0)