Added a note re Swagger creation vs obp and openapi formats in resource docs

This commit is contained in:
simonredfern 2025-12-22 06:14:29 +01:00
parent 72ad27d2b8
commit b78d01a18e

View File

@ -661,6 +661,7 @@ trait ResourceDocsAPIMethods extends MdcLoggable with APIMethods220 with APIMeth
List(apiTagDocumentation, apiTagApi)
)
// Note: Swagger format requires special character escaping because it builds JSON via string concatenation (unlike OBP/OpenAPI formats which use case class serialization)
def getResourceDocsSwagger : OBPEndpoint = {
case "resource-docs" :: requestedApiVersionString :: "swagger" :: Nil JsonGet _ => {