Skip to content

Fix/42/propertie example defined #48

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

Merged
merged 3 commits into from
Nov 14, 2025
+42 −22
Merged

Fix/42/propertie example defined #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3ec8da
testing yaml
Oct 22, 2025
c358466
fix: delete comments if there are any allOf field
Nov 14, 2025
b139b42
modify yaml
Nov 14, 2025
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
60 changes: 40 additions & 20 deletions src/main/java/apiaddicts/sonar/openapi/checks/examples/OAR031ExamplesCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
package apiaddicts.sonar.openapi.checks.examples;

import apiaddicts.sonar.openapi.checks.BaseCheck;
import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.getType;
import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.isArrayType;
import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.isExternalRef;
import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.isObjectType;
import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.isOperation;
import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.resolve;
import com.google.common.collect.ImmutableSet;
import com.sonar.sslr.api.AstNodeType;
import org.sonar.check.Rule;
import org.apiaddicts.apitools.dosonarapi.api.v2.OpenApi2Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v3.OpenApi3Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v31.OpenApi31Grammar;
import apiaddicts.sonar.openapi.checks.BaseCheck;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import static apiaddicts.sonar.openapi.utils.JsonNodeUtils.*;
import org.apiaddicts.apitools.dosonarapi.api.v2.OpenApi2Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v3.OpenApi3Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v31.OpenApi31Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;
import org.sonar.check.Rule;

@Rule(key = OAR031ExamplesCheck.KEY)
public class OAR031ExamplesCheck extends BaseCheck {
Expand Down Expand Up @@ -52,7 +55,9 @@ private void visitV2Node(JsonNode node) {
}
responseNode = resolve(responseNode);
visitResponseV2Node(responseNode);
if (externalRefManagement) externalRefNode = null;
if (externalRefManagement) {
externalRefNode = null;
}
}
}
}
Expand Down Expand Up @@ -80,8 +85,10 @@ private void visitV3Node(JsonNode node) {
}
responseNode = resolve(responseNode);
visitRequestBodyOrResponseV3Node(responseNode);
if (externalRefManagement) externalRefNode = null;
}
if (externalRefManagement) {
externalRefNode = null;
}
}
}
} else if (type.equals(OpenApi3Grammar.SCHEMA)) {
visitSchemaNode(node);
Expand All @@ -92,7 +99,9 @@ private void visitV3Node(JsonNode node) {

private void visitRequestBodyOrResponseV3Node(JsonNode node) {
JsonNode content = node.at("/content");
if (content.isMissing()) return;
if (content.isMissing()) {
return;
}
for (JsonNode mediaTypeNode : content.propertyMap().values()) {
AstNodeType type = node.getType();
JsonNode schemaNode = mediaTypeNode.get("schema");
Expand All @@ -117,8 +126,13 @@ private void visitSchemaNode(JsonNode node) {
if (node.get("example").isMissing() && parentNode.get("example").isMissing() && parentNode.get("examples").isMissing()) {
addIssue(KEY, translate("OAR031.error-parameter"), parentNode);
}
} else if (parentNode.getType().equals(OpenApi3Grammar.SCHEMA_PROPERTIES) ||
parentNode.getType().toString().equals("BLOCK_MAPPING") || parentNode.getType().toString().equals("FLOW_MAPPING")) {
} else if (parentNode.getType().equals(OpenApi3Grammar.SCHEMA_PROPERTIES)
|| parentNode.getType().toString().equals("BLOCK_MAPPING") || parentNode.getType().toString().equals("FLOW_MAPPING")) {
JsonNode schemaParent = (JsonNode) parentNode.getParent().getParent();
if (schemaParent != null && !schemaParent.get("allOf").isMissing()) {
return;
}

JsonNode type = getType(node);
if (!isObjectType(type) && !type.isMissing() && !isArrayType(type)) {
if (node.get("example").isMissing()) {
Expand All @@ -129,7 +143,7 @@ private void visitSchemaNode(JsonNode node) {
}

private void visitPathNode(JsonNode node) {
List<JsonNode> allResponses = node.properties().stream().filter(propertyNode -> isOperation(propertyNode))
List<JsonNode> allResponses = node.properties().stream().filter(propertyNode -> isOperation(propertyNode))
.map(JsonNode::value)
.flatMap(n -> n.properties().stream())
.map(JsonNode::value)
Expand All @@ -148,15 +162,21 @@ private void visitPathNode(JsonNode node) {
} else if (responseNode.getType().equals(OpenApi3Grammar.RESPONSE)) {
JsonNode content = responseNode.at("/content");
if (content.isMissing()) {
if (externalRefManagement) externalRefNode = null;
if (externalRefManagement) {
externalRefNode = null;
}
continue;
}
content.propertyMap().forEach((mediaType, mediaTypeNode) -> { // estudiar función lambda
if (!mediaType.toLowerCase().contains("json")) return;
visitSchemaNode2(mediaTypeNode);
if (!mediaType.toLowerCase().contains("json")) {
return;
}
visitSchemaNode(mediaTypeNode);
});
}
if (externalRefManagement) externalRefNode = null;
if (externalRefManagement) {
externalRefNode = null;
}
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/checks/v3/examples/OAR031/valid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ components:
size:
type: integer
example: 1
pets: # Noncompliant {{OAR031: Properties must have an example defined}}
pets:
type: array
items:
$ref: '#/components/schemas/pet'
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/checks/v3/examples/OAR031/without-examples.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ components:
properties:
size: # Noncompliant {{OAR031: Properties must have an example defined}}
type: integer
pets: # Noncompliant {{OAR031: Properties must have an example defined}}
pets:
type: array
items:
$ref: '#/components/schemas/pet'
Expand Down
Loading