Skip to content

Fixed: ModelApiReader resolved omitted auth/publish attributes to false, opposite of rest-api.xsd's declared default #2011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mridulpathak wants to merge 2 commits into
base: trunk
Choose a base branch
from
+23 −10
Open

Fixed: ModelApiReader resolved omitted auth/publish attributes to false, opposite of rest-api.xsd's declared default #2011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
368ef45
Fixed: ModelApiReader resolved omitted auth/publish attributes to fal…
mridulpathak Sep 15, 2026
3018510
Reverted: OpenApiResource no longer requires @Secured
mridulpathak Sep 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions framework/rest-api/src/main/java/org/apache/ofbiz/ws/rs/model/ModelApiReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public static ModelApi getModelApi(final File apiDef) {
api.setName(UtilXml.checkEmpty(docElement.getAttribute("name")).intern());
api.setDescription(UtilXml.checkEmpty(docElement.getAttribute("description")).intern());
api.setPath(UtilXml.checkEmpty(docElement.getAttribute("path")).intern());
api.setPublish(Boolean.parseBoolean(UtilXml.checkEmpty(docElement.getAttribute("publish")).intern()));
api.setPublish(parseBooleanDefaultTrue(docElement.getAttribute("publish")));
for (Element resourceEle : UtilXml.childElementList(docElement, "resource")) {
createModelResource(resourceEle, api);
}
Expand Down Expand Up @@ -107,8 +107,8 @@ private static ModelResource buildResource(Element resourceEle) {
.description(UtilXml.checkEmpty(resourceEle.getAttribute("description")).intern())
.displayName(UtilXml.checkEmpty(resourceEle.getAttribute("displayName")).intern())
.path(UtilXml.checkEmpty(resourceEle.getAttribute("path")).intern())
.publish(Boolean.parseBoolean(UtilXml.checkEmpty(resourceEle.getAttribute("publish")).intern()))
.auth(Boolean.parseBoolean(UtilXml.checkEmpty(resourceEle.getAttribute("auth")).intern()))
.publish(parseBooleanDefaultTrue(resourceEle.getAttribute("publish")))
.auth(parseBooleanDefaultTrue(resourceEle.getAttribute("auth")))
.primaryPermission(UtilXml.checkEmpty(resourceEle.getAttribute("primaryPermission")).intern())
.mainAction(UtilXml.checkEmpty(resourceEle.getAttribute("mainAction")).intern())
.customHeaders(UtilXml.checkEmpty(resourceEle.getAttribute("customHeaders")).intern());
Expand All @@ -125,7 +125,7 @@ private static void createOperations(Element resourceEle, ModelResource resource
.produces(UtilXml.checkEmpty(operationEle.getAttribute("produces")).intern())
.consumes(UtilXml.checkEmpty(operationEle.getAttribute("consumes")).intern())
.description(UtilXml.checkEmpty(operationEle.getAttribute("description")).intern())
.auth(Boolean.parseBoolean(UtilXml.checkEmpty(operationEle.getAttribute("auth")).intern()))
.auth(parseBooleanDefaultTrue(operationEle.getAttribute("auth")))
.primaryPermission(UtilXml.checkEmpty(operationEle.getAttribute("primaryPermission"),
resourceEle.getAttribute("primaryPermission")).intern())
.mainAction(UtilXml.checkEmpty(operationEle.getAttribute("mainAction"),
Expand All @@ -144,6 +144,21 @@ private static void createOperations(Element resourceEle, ModelResource resource
}


/**
* Parses an {@code xs:boolean}-typed attribute that {@code rest-api.xsd} declares with
* {@code default="true"} (currently {@code publish} and {@code auth}). DOM's
* {@code Element.getAttribute} returns {@code ""} for an attribute that is absent from the
* source XML, so the omitted case must be defaulted explicitly rather than handed to
* {@link Boolean#parseBoolean(String)}, which would otherwise resolve it to {@code false}.
*
* @param attributeValue the raw attribute value, or {@code ""} if the attribute was omitted
* @return {@code true} if the attribute was omitted or explicitly {@code "true"}; {@code false} otherwise
*/
private static boolean parseBooleanDefaultTrue(String attributeValue) {
String value = UtilXml.checkEmpty(attributeValue).intern();
return value.isEmpty() || Boolean.parseBoolean(value);
}

private static void createQueryParams(Element operationEle, ModelOperation operation) {
for (Element queryParamEle : UtilXml.childElementList(operationEle, "queryParam")) {
ModelQueryParam qp = new ModelQueryParam()
Expand Down
10 changes: 4 additions & 6 deletions framework/rest-api/src/test/java/org/apache/ofbiz/ws/rs/model/ModelApiReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
package org.apache.ofbiz.ws.rs.model;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

Expand Down Expand Up @@ -67,15 +66,14 @@ void testGetModelApiParsesTopLevelAttributes() throws IOException {
}

@Test
void testGetModelApiMissingPublishAttributeDefaultsToFalse() throws IOException {
// No "publish" attribute at all -> UtilXml.checkEmpty(...) yields "",
// and Boolean.parseBoolean("") is false. This locks in that implicit
// default so a change in checkEmpty/parseBoolean behavior is caught.
void testGetModelApiMissingPublishAttributeDefaultsToTrue() throws IOException {
// No "publish" attribute at all -> rest-api.xsd declares this attribute
// default="true", so an omitted attribute must resolve to true.
File file = writeXml("<api name=\"myApi\"/>");

ModelApi api = ModelApiReader.getModelApi(file);

assertFalse(api.isPublish());
assertTrue(api.isPublish());
}

@Test
Expand Down
Loading