Skip to content

Feature/125/openapi 3 2 #20

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
SebastianDT1 merged 5 commits into from
May 8, 2026
Merged

Feature/125/openapi 3 2 #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
551b75d
feat: add support openapi3.2
mels-h May 5, 2026
eeee257
feat: complete missing validation checks for openapi 3.2 and solve fo…
mels-h May 6, 2026
8e03cea
feat: update readme and changelog
mels-h May 6, 2026
1207930
fix: duplicated code and ref
mels-h May 7, 2026
62a90c6
fix: sonar issues
mels-h May 7, 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
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.2.0] - 2024-05-05

## Added

### Now, support for OpenAPI 3.2 is included. These are some of the new changes:

- Full implementation of the grammar and parser for the new specification.
- Full coverage for the OpenAPI 3.2 grammar components and API visitors.
- Completed and adjusted pending validation checks to ensure full compatibility for both OpenAPI 3.1 and 3.2.
- Refactored error handling and loading states to improve frontend stability.


## [1.1.2] - 2026-03-06

## Fixed
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# 🛠️ Sonar OpenApi (plugin) ![Release](https://img.shields.io/badge/release-1.1.2-purple) ![Swagger](https://img.shields.io/badge/-openapi-%23Clojure?style=flat&logo=swagger&logoColor=white) ![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=flat&logo=openjdk&logoColor=white) [![License: LGPL v3](https://img.shields.io/badge/license-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
# 🛠️ Sonar OpenApi (plugin) ![Release](https://img.shields.io/badge/release-1.2.0-purple) ![Swagger](https://img.shields.io/badge/-openapi-%23Clojure?style=flat&logo=swagger&logoColor=white) ![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=flat&logo=openjdk&logoColor=white) [![License: LGPL v3](https://img.shields.io/badge/license-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

Sonar OpenApi (plugin) is a code analyzer for OpenAPI specifications, is the spiritual successor of [SonarOpenApi](https://github.com/societe-generale/sonar-openapi), carrying on from the point where it left off with support of Apiaddicts community.

Expand Down Expand Up @@ -32,7 +32,7 @@ Feel free to drop by and greet us on our GitHub discussion or Discord chat. You

## ⚙️ Features

* Full compatibility with OpenAPI v2.0, v3.0.0, v3.0.1, v3.0.2, v3.0.3 and v3.1.0
* Full compatibility with OpenAPI v2.0, v3.0.0, v3.0.1, v3.0.2, v3.0.3, v3.1.0 and v3.2.0

![SonarOpenApi in action](sonarqube.jpg)

Expand Down
2 changes: 1 addition & 1 deletion its/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>org.apiaddicts.apitools.dosonarapi</groupId>
<artifactId>dosonarapi</artifactId>
<version>1.1.2</version>
<version>1.2.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion openapi-checks/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>org.apiaddicts.apitools.dosonarapi</groupId>
<artifactId>dosonarapi</artifactId>
<version>1.1.2</version>
<version>1.2.0</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
4 changes: 3 additions & 1 deletion ...hecks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/ContactValidEmailCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

import com.google.common.collect.ImmutableSet;
Expand All @@ -39,7 +41,7 @@ public class ContactValidEmailCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return ImmutableSet.of(OpenApi2Grammar.CONTACT, OpenApi3Grammar.CONTACT);
return ImmutableSet.of(OpenApi2Grammar.CONTACT, OpenApi3Grammar.CONTACT, OpenApi31Grammar.CONTACT, OpenApi32Grammar.CONTACT);
}

@Override
Expand Down
4 changes: 3 additions & 1 deletion openapi-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/DeclaredTagCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = DeclaredTagCheck.CHECK_KEY)
Expand All @@ -34,7 +36,7 @@ public class DeclaredTagCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION);
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION, OpenApi31Grammar.OPERATION, OpenApi32Grammar.OPERATION);
}

@Override
Expand Down
4 changes: 3 additions & 1 deletion ...-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/DefaultResponseCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.impl.MissingNode;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

Expand All @@ -36,7 +38,7 @@ public class DefaultResponseCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.RESPONSES, OpenApi3Grammar.RESPONSES);
return Sets.newHashSet(OpenApi2Grammar.RESPONSES, OpenApi3Grammar.RESPONSES, OpenApi31Grammar.RESPONSES, OpenApi32Grammar.RESPONSES);
}

@Override
Expand Down
4 changes: 3 additions & 1 deletion ...-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/DefinedResponseCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = DefinedResponseCheck.CHECK_KEY)
Expand All @@ -40,7 +42,7 @@ public class DefinedResponseCheck extends OpenApiCheck {
@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(
OpenApi2Grammar.RESPONSES, OpenApi3Grammar.RESPONSES);
OpenApi2Grammar.RESPONSES, OpenApi3Grammar.RESPONSES, OpenApi31Grammar.RESPONSES, OpenApi32Grammar.RESPONSES);
}

@Override
Expand Down
4 changes: 3 additions & 1 deletion ...c/main/java/org/apiaddicts/apitools/dosonarapi/checks/DescriptionDiffersSummaryCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = DescriptionDiffersSummaryCheck.CHECK_KEY)
Expand All @@ -34,7 +36,7 @@ public class DescriptionDiffersSummaryCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION);
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION, OpenApi31Grammar.OPERATION, OpenApi32Grammar.OPERATION);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...pi-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/DocumentedTagCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
import org.apiaddicts.apitools.dosonarapi.api.PreciseIssue;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.impl.MissingNode;

Expand All @@ -39,7 +41,7 @@ public class DocumentedTagCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.TAG, OpenApi2Grammar.OPERATION, OpenApi3Grammar.TAG, OpenApi3Grammar.OPERATION);
return Sets.newHashSet(OpenApi2Grammar.TAG, OpenApi2Grammar.OPERATION, OpenApi3Grammar.TAG, OpenApi3Grammar.OPERATION, OpenApi31Grammar.TAG, OpenApi31Grammar.OPERATION, OpenApi32Grammar.TAG, OpenApi32Grammar.OPERATION);
}

@Override
Expand All @@ -61,7 +63,7 @@ public void visitFile(JsonNode root) {
@Override
protected void visitNode(JsonNode node) {
AstNodeType nodeType = node.getType();
if (nodeType == OpenApi2Grammar.TAG || nodeType == OpenApi3Grammar.TAG) {
if (nodeType == OpenApi2Grammar.TAG || nodeType == OpenApi3Grammar.TAG || nodeType == OpenApi31Grammar.TAG || nodeType == OpenApi32Grammar.TAG) {
visitTag(node);
} else {
visitOperation(node);
Expand Down
7 changes: 5 additions & 2 deletions openapi-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/MediaTypeCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = MediaTypeCheck.CHECK_KEY)
Expand All @@ -44,7 +46,7 @@ public class MediaTypeCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.ROOT, OpenApi2Grammar.OPERATION, OpenApi3Grammar.RESPONSE, OpenApi3Grammar.REQUEST_BODY, OpenApi3Grammar.PARAMETER);
return Sets.newHashSet(OpenApi2Grammar.ROOT, OpenApi2Grammar.OPERATION, OpenApi3Grammar.RESPONSE, OpenApi3Grammar.REQUEST_BODY, OpenApi3Grammar.PARAMETER, OpenApi31Grammar.RESPONSE, OpenApi31Grammar.REQUEST_BODY, OpenApi31Grammar.PARAMETER, OpenApi32Grammar.RESPONSE, OpenApi32Grammar.REQUEST_BODY, OpenApi32Grammar.PARAMETER);
}

@Override
Expand All @@ -70,7 +72,8 @@ private void verifyMimeTypeArray(JsonNode node) {
}

private void visitOpenApi3(JsonNode node) {
if (node.getType() == OpenApi3Grammar.PARAMETER) {
AstNodeType type = node.getType();
if (type == OpenApi3Grammar.PARAMETER || type == OpenApi31Grammar.PARAMETER || type == OpenApi32Grammar.PARAMETER) {
verifyParameterContent(node);
} else {
verifyContent(node);
Expand Down
9 changes: 6 additions & 3 deletions ...i-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/NoContentIn204Check.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = NoContentIn204Check.CHECK_KEY)
Expand All @@ -35,7 +37,7 @@ public class NoContentIn204Check extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION);
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION, OpenApi31Grammar.OPERATION, OpenApi32Grammar.OPERATION);
}

@Override
Expand All @@ -57,7 +59,8 @@ private void checkNoContent(JsonNode response) {
}

private static boolean hasContent(JsonNode effective) {
return effective.getType() instanceof OpenApi2Grammar && !effective.get("schema").isMissing()
|| effective.getType() instanceof OpenApi3Grammar && ! effective.get("content").isMissing();
AstNodeType type = effective.getType();
return type instanceof OpenApi2Grammar && !effective.get("schema").isMissing()
|| (type instanceof OpenApi3Grammar || type instanceof OpenApi31Grammar || type instanceof OpenApi32Grammar) && !effective.get("content").isMissing();
}
}
10 changes: 8 additions & 2 deletions ...ecks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/NoUnusedDefinitionCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.Utils;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.impl.MissingNode;
Expand All @@ -46,7 +48,7 @@ public class NoUnusedDefinitionCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION);
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION, OpenApi31Grammar.OPERATION, OpenApi32Grammar.OPERATION);
}

@Override
Expand Down Expand Up @@ -165,7 +167,11 @@ private static Set<JsonPointer> usedReferences(JsonNode node, Function<JsonNode,

private static List<JsonPointer> getReference(JsonNode node) {
if (node.isRef()) {
return Collections.singletonList(JsonPointer.compile(node.at("/$ref").getTokenValue().substring(1)));
String refValue = node.at("/$ref").getTokenValue();
if (!refValue.startsWith("#")) {
return Collections.emptyList();
}
return Collections.singletonList(JsonPointer.compile(refValue.substring(1)));
} else {
return Collections.emptyList();
}
Expand Down
4 changes: 3 additions & 1 deletion ...-checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/PathMaskeradingCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
import org.apiaddicts.apitools.dosonarapi.api.PreciseIssue;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

import static org.apiaddicts.apitools.dosonarapi.checks.PathMaskeradingCheck.ConflictMode.AMBIGUOUS;
Expand Down Expand Up @@ -78,7 +80,7 @@ private static void ensureSize(List<List<Bucket>> list, int size) {

@Override
public Set<AstNodeType> subscribedKinds() {
return ImmutableSet.of(OpenApi2Grammar.PATHS, OpenApi3Grammar.PATHS);
return ImmutableSet.of(OpenApi2Grammar.PATHS, OpenApi3Grammar.PATHS, OpenApi31Grammar.PATHS, OpenApi32Grammar.PATHS);
}

@Override
Expand Down
4 changes: 3 additions & 1 deletion ...checks/src/main/java/org/apiaddicts/apitools/dosonarapi/checks/ProvideOpSummaryCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
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.api.v32.OpenApi32Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = ProvideOpSummaryCheck.CHECK_KEY)
Expand All @@ -34,7 +36,7 @@ public class ProvideOpSummaryCheck extends OpenApiCheck {

@Override
public Set<AstNodeType> subscribedKinds() {
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION);
return Sets.newHashSet(OpenApi2Grammar.OPERATION, OpenApi3Grammar.OPERATION, OpenApi31Grammar.OPERATION, OpenApi32Grammar.OPERATION);
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion openapi-front-end/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>org.apiaddicts.apitools.dosonarapi</groupId>
<artifactId>dosonarapi</artifactId>
<version>1.1.2</version>
<version>1.2.0</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
Loading
Loading