Skip to content

bugfix/Fix empty Operation ID for resource-docs and swagger endpoints #2748

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
simonredfern merged 2 commits into from
Mar 27, 2026
Merged

bugfix/Fix empty Operation ID for resource-docs and swagger endpoints #2748

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6ec7c3
Fix empty Operation ID for resource-docs and swagger endpoints
simonredfern Mar 25, 2026
d912a11
Merge remote-tracking branch 'OBP/develop' into obp-develop
hongwei1 Mar 26, 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
82 changes: 26 additions & 56 deletions obp-api/src/main/scala/code/api/ResourceDocs1_4_0/ResourceDocs140.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,151 +17,121 @@ import net.liftweb.http.{GetRequest, InMemoryResponse, PlainTextResponse, Req, S
object ResourceDocs140 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version = ApiVersion.v1_4_0 // "1.4.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObp,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
ImplementationsResourceDocs.getResourceDocsSwagger,
)
routes.foreach(route => {
oauthServe(apiPrefix{route})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}


// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs200 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version = ApiVersion.v2_0_0 // "2.0.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObp,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix{route})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}


// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs210 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v2_1_0 // "2.1.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObp,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix{route})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}

// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs220 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v2_2_0 // "2.2.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObp,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix{route})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}

// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs300 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version : ApiVersion = ApiVersion.v3_0_0 // = "3.0.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObp,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix{route})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)

// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs310 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v3_1_0 // = "3.0.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObp,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix {
route
})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}
// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs400 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v4_0_0 // = "4.0.0" // We match other api versions so API explorer can easily use the path.
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObpV400,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix {
route
})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}
// Hack to provide Resource Docs / Swagger on endpoints other than 1.4.0 where it is defined.
object ResourceDocs500 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v5_0_0
val version: ApiVersion = ApiVersion.v5_0_0
val versionStatus = ApiVersionStatus.STABLE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObpV400,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
)
routes.foreach(route => {
oauthServe(apiPrefix {
route
})
})
}

registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}

object ResourceDocs510 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v5_1_0
val version: ApiVersion = ApiVersion.v5_1_0
val versionStatus = ApiVersionStatus.BLEEDING_EDGE.toString
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObpV400,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
// ImplementationsResourceDocs.getStaticResourceDocsObp
)
routes.foreach(route => {
oauthServe(apiPrefix {
route
})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)
}

object ResourceDocs600 extends OBPRestHelper with ResourceDocsAPIMethods with MdcLoggable {
val version: ApiVersion = ApiVersion.v6_0_0
val version: ApiVersion = ApiVersion.v6_0_0
val versionStatus = ApiVersionStatus.BLEEDING_EDGE.toString
override def includeTechnologyInResponse: Boolean = true
val routes: Seq[OBPEndpoint] = List(
val routes: List[OBPEndpoint] = List(
ImplementationsResourceDocs.getResourceDocsObpV400,
ImplementationsResourceDocs.getResourceDocsSwagger,
ImplementationsResourceDocs.getResourceDocsOpenAPI31,
ImplementationsResourceDocs.getBankLevelDynamicResourceDocsObp,
// ImplementationsResourceDocs.getStaticResourceDocsObp
)
routes.foreach(route => {
oauthServe(apiPrefix {
route
})
})
registerRoutes(routes, ImplementationsResourceDocs.localResourceDocs, apiPrefix)

// Register YAML endpoint using standard RestHelper approach
serve {
Expand Down
Loading