Michael Pasternak has uploaded a new change for review.
Change subject: restapi: rename /api rsdl metadata to avoid collisions
......................................................................
restapi: rename /api rsdl metadata to avoid collisions
api.xsd already has "api" element what can
lead to element->type mapping collisions in some
client bindings
Change-Id: Ic7b0421e4e01f147e55015adeabdcdefd9463f23
Signed-off-by: Michael Pasternak <mpast...@redhat.com>
---
M
backend/manager/modules/restapi/interface/definition/src/main/resources/api.xsd
M
backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/resource/BackendApiResource.java
R
backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/GeneralMetadataBuilder.java
M
backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/RsdlBuilder.java
4 files changed, 37 insertions(+), 37 deletions(-)
git pull ssh://gerrit.ovirt.org:29418/ovirt-engine refs/changes/91/13391/1
diff --git
a/backend/manager/modules/restapi/interface/definition/src/main/resources/api.xsd
b/backend/manager/modules/restapi/interface/definition/src/main/resources/api.xsd
index 19d3884..b0dc308 100644
---
a/backend/manager/modules/restapi/interface/definition/src/main/resources/api.xsd
+++
b/backend/manager/modules/restapi/interface/definition/src/main/resources/api.xsd
@@ -2848,9 +2848,9 @@
</xs:complexContent>
</xs:complexType>
- <xs:element name="entry_point" type="EntryPoint"/>
+ <xs:element name="general_metadata" type="GeneralMetadata"/>
- <xs:complexType name="EntryPoint">
+ <xs:complexType name="GeneralMetadata">
<xs:complexContent>
<xs:extension base="DetailedLink">
<xs:sequence>
@@ -2868,7 +2868,7 @@
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:element type="Version" name="version" minOccurs="0" maxOccurs="1" />
<xs:element ref="schema" minOccurs="0" maxOccurs="1" />
- <xs:element type="EntryPoint" name="api" minOccurs="0"/>
+ <xs:element type="GeneralMetadata" name="general" minOccurs="0"
maxOccurs="1"/>
<xs:element type="DetailedLinks" name="links" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="href" type="xs:string"/>
diff --git
a/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/resource/BackendApiResource.java
b/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/resource/BackendApiResource.java
index 646fc10..6199c6b 100644
---
a/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/resource/BackendApiResource.java
+++
b/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/resource/BackendApiResource.java
@@ -53,7 +53,7 @@
import org.ovirt.engine.api.model.Users;
import org.ovirt.engine.api.model.VMs;
import org.ovirt.engine.api.resource.ApiResource;
-import org.ovirt.engine.api.restapi.rsdl.EntryPointBuilder;
+import org.ovirt.engine.api.restapi.rsdl.GeneralMetadataBuilder;
import org.ovirt.engine.api.restapi.rsdl.RsdlBuilder;
import org.ovirt.engine.api.restapi.rsdl.SchemaBuilder;
import org.ovirt.engine.api.restapi.types.DateMapper;
@@ -83,9 +83,9 @@
private static final String SCHEMA_DESCRIPTION = "oVirt API entities
schema.";
private static final String SCHEMA_NAME = "ovirt-engine-api-schema.xsd";
private static final String QUERY_PARAMETER = "?";
- private static final String ENTRY_POINT_REL = "api";
- private static final String ENTRY_POINT_NAME = "root";
- private static final String ENTRY_POINT_DESCRIPTION = "The oVirt RESTful
API.";
+ private static final String GENERAL_METADATA_REL = "*";
+ private static final String GENERAL_METADATA_NAME = "The oVirt RESTful API
generic descriptor.";
+ private static final String GENERAL_METADATA_DESCRIPTION = "These options
are valid for entire application.";
private static RSDL rsdl = null;
@@ -367,11 +367,11 @@
.name(SCHEMA_NAME)
.description(SCHEMA_DESCRIPTION)
.build())
- .entryPoint(new EntryPointBuilder()
- .rel(ENTRY_POINT_REL)
- .href(getUriInfo().getBaseUri().getPath())
- .name(ENTRY_POINT_NAME)
- .description(ENTRY_POINT_DESCRIPTION)
+ .generalMetadata(new GeneralMetadataBuilder()
+ .rel(GENERAL_METADATA_REL)
+
.href(getUriInfo().getBaseUri().getPath().replace("api", "*"))
+ .name(GENERAL_METADATA_NAME)
+ .description(GENERAL_METADATA_DESCRIPTION)
.build())
.build();
}
diff --git
a/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/EntryPointBuilder.java
b/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/GeneralMetadataBuilder.java
similarity index 63%
rename from
backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/EntryPointBuilder.java
rename to
backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/GeneralMetadataBuilder.java
index ac3819c..ebbaf35 100644
---
a/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/EntryPointBuilder.java
+++
b/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/GeneralMetadataBuilder.java
@@ -17,30 +17,30 @@
package org.ovirt.engine.api.restapi.rsdl;
import org.ovirt.engine.api.common.security.auth.SessionUtils;
-import org.ovirt.engine.api.model.EntryPoint;
+import org.ovirt.engine.api.model.GeneralMetadata;
import org.ovirt.engine.api.model.Header;
import org.ovirt.engine.api.model.Headers;
import org.ovirt.engine.api.model.Request;
-public class EntryPointBuilder {
+public class GeneralMetadataBuilder {
- private EntryPoint entryPoint;
+ private GeneralMetadata generalMetadata;
- public EntryPointBuilder() {
- this.entryPoint = new EntryPoint();
+ public GeneralMetadataBuilder() {
+ this.generalMetadata = new GeneralMetadata();
}
- public EntryPoint build() {
+ public GeneralMetadata build() {
produceRequestHeaders();
- return this.entryPoint;
+ return this.generalMetadata;
}
private void produceRequestHeaders() {
- this.entryPoint.setRequest(new Request());
- this.entryPoint.getRequest().setHeaders(new Headers());
+ this.generalMetadata.setRequest(new Request());
+ this.generalMetadata.getRequest().setHeaders(new Headers());
- injectSessionTtlHeader(this.entryPoint.getRequest().getHeaders());
+ injectSessionTtlHeader(this.generalMetadata.getRequest().getHeaders());
}
private void injectSessionTtlHeader(Headers headers) {
@@ -59,23 +59,23 @@
}
}
- public EntryPointBuilder description(String description) {
- this.entryPoint.setDescription(description);
+ public GeneralMetadataBuilder description(String description) {
+ this.generalMetadata.setDescription(description);
return this;
}
- public EntryPointBuilder href(String href) {
- this.entryPoint.setHref(href);
+ public GeneralMetadataBuilder href(String href) {
+ this.generalMetadata.setHref(href);
return this;
}
- public EntryPointBuilder name(String name) {
- this.entryPoint.setName(name);
+ public GeneralMetadataBuilder name(String name) {
+ this.generalMetadata.setName(name);
return this;
}
- public EntryPointBuilder rel(String rel) {
- this.entryPoint.setRel(rel);
+ public GeneralMetadataBuilder rel(String rel) {
+ this.generalMetadata.setRel(rel);
return this;
}
}
diff --git
a/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/RsdlBuilder.java
b/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/RsdlBuilder.java
index a3cbb79..ecf6f4c 100644
---
a/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/RsdlBuilder.java
+++
b/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/rsdl/RsdlBuilder.java
@@ -43,7 +43,7 @@
import org.ovirt.engine.api.model.Body;
import org.ovirt.engine.api.model.DetailedLink;
import org.ovirt.engine.api.model.DetailedLinks;
-import org.ovirt.engine.api.model.EntryPoint;
+import org.ovirt.engine.api.model.GeneralMetadata;
import org.ovirt.engine.api.model.Header;
import org.ovirt.engine.api.model.Headers;
import org.ovirt.engine.api.model.HttpMethod;
@@ -74,7 +74,7 @@
private String rel;
private String href;
private Schema schema;
- private EntryPoint entryPoint;
+ private GeneralMetadata generalMetadata;
private String description;
private static final String ACTION = "Action";
@@ -140,7 +140,7 @@
rsdl.setHref(getHref());
rsdl.setDescription(getDescription());
rsdl.setSchema(getSchema());
- rsdl.setApi(getEntryPoint());
+ rsdl.setGeneral(getGeneralMetadata());
} catch (Exception e) {
e.printStackTrace();
LOG.error("RSDL generation failure.", e);
@@ -163,8 +163,8 @@
return this;
}
- public RsdlBuilder entryPoint(EntryPoint entryPoint) {
- this.entryPoint = entryPoint;
+ public RsdlBuilder generalMetadata(GeneralMetadata entryPoint) {
+ this.generalMetadata = entryPoint;
return this;
}
@@ -185,8 +185,8 @@
return schema;
}
- public EntryPoint getEntryPoint() {
- return entryPoint;
+ public GeneralMetadata getGeneralMetadata() {
+ return generalMetadata;
}
public String getDescription() {
--
To view, visit http://gerrit.ovirt.org/13391
To unsubscribe, visit http://gerrit.ovirt.org/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ic7b0421e4e01f147e55015adeabdcdefd9463f23
Gerrit-PatchSet: 1
Gerrit-Project: ovirt-engine
Gerrit-Branch: master
Gerrit-Owner: Michael Pasternak <mpast...@redhat.com>
_______________________________________________
Engine-patches mailing list
Engine-patches@ovirt.org
http://lists.ovirt.org/mailman/listinfo/engine-patches
