Skip to content

[Core] Add warning on headers with underscores #4412

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

Closed
ybelenko wants to merge 10 commits into from
Closed

[Core] Add warning on headers with underscores #4412

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5f25c61
[Core] Throw warning if header contains underscore
ybelenko Nov 7, 2019
290cb13
[Core] Throw warning if apiKey contains underscore
ybelenko Nov 7, 2019
27fec2d
[PHP] Don't suppress warning from default codegen
ybelenko Nov 7, 2019
6130249
[Slim] Don't suppress warning from abstract php
ybelenko Nov 7, 2019
e3be1c9
Revert "[Slim] Don't suppress warning from abstract php"
ybelenko Nov 8, 2019
d83006a
Revert "[PHP] Don't suppress warning from default codegen"
ybelenko Nov 8, 2019
50dcc3f
Revert "[Core] Throw warning if apiKey contains underscore"
ybelenko Nov 8, 2019
adb00e9
Revert "[Core] Throw warning if header contains underscore"
ybelenko Nov 8, 2019
624bc10
[Server] Warn if header contains underscore
ybelenko Nov 8, 2019
f1d54fe
[Server] Warn if apiKey contains underscore
ybelenko Nov 8, 2019
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
33 changes: 33 additions & 0 deletions modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,6 +851,17 @@ private Map<String, Object> buildSupportFileBundle(List<Object> allOperations, L
if (hasBearerMethods(authMethods)) {
bundle.put("hasBearerMethods", true);
}

if (CodegenType.SERVER.equals(config.getTag())) {
// throw warning only for server generators
for (String key : securitySchemeMap.keySet()) {
final SecurityScheme securityScheme = securitySchemeMap.get(key);
if (SecurityScheme.Type.APIKEY.equals(securityScheme.getType()) && securityScheme.getName().contains("_")) {
// api key in underscored http header
LOGGER.warn("Security schema '" + securityScheme.getName() + "' mapped to underscored header '" + securityScheme.getName() + "' which is forbidden in Apache and Nginx webservers by default. https://stackoverflow.com/questions/22856136/why-http-servers-forbid-underscores-in-http-header-names/22856867#22856867");
}
}
}
}

List<CodegenServer> servers = config.fromServers(openAPI.getServers());
Expand Down Expand Up @@ -1114,6 +1125,28 @@ private Map<String, Object> processOperations(CodegenConfig config, String tag,
Set<String> allImports = new TreeSet<String>();
for (CodegenOperation op : ops) {
allImports.addAll(op.imports);

if (CodegenType.SERVER.equals(config.getTag())) {
// throw warning only for server generators
if (op.getHasHeaderParams()) {
List<CodegenParameter> headerParams = (List<CodegenParameter>) op.headerParams;
for (CodegenParameter param : headerParams) {
String paramBaseName = (String) param.baseName;
if (paramBaseName.contains("_")) {
LOGGER.warn("Request header parameter name '" + paramBaseName + "' contains underscore which is forbidden in Apache and Nginx webservers by default. https://stackoverflow.com/questions/22856136/why-http-servers-forbid-underscores-in-http-header-names/22856867#22856867");
}
}
}
if (op.getHasResponseHeaders()) {
List<CodegenProperty> responseHeaders = (List<CodegenProperty>) op.responseHeaders;
for (CodegenProperty prop : responseHeaders) {
String propBaseName = (String) prop.baseName;
if (propBaseName.contains("_")) {
LOGGER.warn("Response header name '" + propBaseName + "' contains underscore which is forbidden in Apache and Nginx webservers by default. https://stackoverflow.com/questions/22856136/why-http-servers-forbid-underscores-in-http-header-names/22856867#22856867");
}
}
}
}
}

List<Map<String, String>> imports = new ArrayList<Map<String, String>>();
Expand Down