Skip to content

feat(core): validate operationId uniqueness and warn on duplicates #52

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
halotukozak wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(core): validate operationId uniqueness and warn on duplicates #52

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
c1d27b5
feat(core): validate operationId uniqueness and warn on duplicates (#40)
halotukozak Apr 9, 2026
b1a1eaf
fix(core): add override modifier to HttpError.message property
halotukozak Apr 10, 2026
038a547
Merge origin/master into feat/validate-operation-id-uniqueness
halotukozak Apr 10, 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
14 changes: 14 additions & 0 deletions core/src/main/kotlin/com/avsystem/justworks/core/parser/SpecValidator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,19 @@ object SpecValidator {
Issue.Warning("Links are not supported in v1 and will be ignored")
}
}

val operations = openApi.paths.orEmpty().flatMap { (path, pathItem) ->
pathItem.readOperationsMap().mapNotNull { (method, op) ->
op.operationId?.let { Triple(it, method.name, path) }
}
}
val operationIds = operations.groupBy { it.first }

for ((opId, occurrences) in operationIds) {
ensureOrAccumulate(occurrences.size == 1) {
val locations = occurrences.joinToString { "${it.second} ${it.third}" }
Issue.Warning("Duplicate operationId '$opId' found at: $locations")
}
Comment on lines +42 to +53
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The duplicate-warning message order depends on the iteration order of paths and readOperationsMap() (and then groupBy preserving that order). To keep warnings deterministic (and easier to scan / test), consider sorting occurrences (e.g., by path then method) before joinToString.

Copilot uses AI. Check for mistakes.
}
}
}
54 changes: 54 additions & 0 deletions core/src/test/kotlin/com/avsystem/justworks/core/parser/SpecParserTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,60 @@ class SpecParserTest : SpecParserTestBase() {
}
}

// -- SPEC-03b: Duplicate operationId warning --

@Test
fun `parse spec with duplicate operationId emits warning`() {
val result = SpecParser.parse(
"""
openapi: 3.0.0
info:
title: Test
version: 1.0.0
paths:
/pets:
get:
operationId: listPets
tags: [Pets]
responses:
'200':
description: OK
/animals:
get:
operationId: listPets
tags: [Animals]
responses:
'200':
description: OK
""".trimIndent().toTempFile(),
)
assertIs<ParseResult.Success<ApiSpec>>(result)
val dupWarnings = result.warnings.filter {
it.message.contains("Duplicate operationId")
}
assertTrue(
dupWarnings.isNotEmpty(),
"Expected warning about duplicate operationId, got: ${result.warnings}",
)
assertTrue(
dupWarnings.first().message.contains("listPets"),
"Warning should mention the duplicate operationId",
)
}

@Test
fun `parse spec with unique operationIds has no duplicate warnings`() {
val result = SpecParser.parse(loadResource("petstore.yaml"))
assertIs<ParseResult.Success<ApiSpec>>(result)
val dupWarnings = result.warnings.filter {
it.message.contains("Duplicate operationId")
}
assertTrue(
dupWarnings.isEmpty(),
"Petstore should have no duplicate operationId warnings",
)
}

// -- SPEC-04: Swagger 2.0 auto-conversion --

@Test
Expand Down
Loading