Skip to content

Postman Generator: Add folder description #23249

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
wing328 merged 5 commits into from
Mar 15, 2026
Merged

Postman Generator: Add folder description #23249

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
26054d9
Add folder description
gcatanese Mar 14, 2026
6aeb0cd
Generate samples
gcatanese Mar 14, 2026
0252d3c
Refactor test to avoid relying on endpoints order
gcatanese Mar 14, 2026
77836de
Address cubic-dev comments
gcatanese Mar 14, 2026
2dbc78d
Refactor test to avoid relying on endpoints order
gcatanese Mar 14, 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
44 changes: 37 additions & 7 deletions ...-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public class PostmanCollectionCodegen extends DefaultCodegen implements CodegenC


// operations grouped by tag
public Map<String, List<CodegenOperation>> codegenOperationsByTag = new HashMap<>();
public Map<PostmanRequestFolder, List<CodegenOperation>> codegenOperationsByTag = new HashMap<>();
// list of operations
public List<CodegenOperation> codegenOperationsList = new ArrayList<>();

Expand Down Expand Up @@ -319,22 +319,28 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
* @param codegenOperation Codegen operation instance
*/
public void addToMap(CodegenOperation codegenOperation) {

String key = null;
String tagName;
String tagDescription;
if (codegenOperation.tags == null || codegenOperation.tags.isEmpty()) {
key = "default";
tagName = "Default";
tagDescription = "Default tag";
} else {
key = codegenOperation.tags.get(0).getName();
tagName = codegenOperation.tags.get(0).getName();
tagDescription = codegenOperation.tags.get(0).getDescription();
if (tagDescription == null) {
tagDescription = tagName + " tag";
}
}

List<CodegenOperation> list = codegenOperationsByTag.get(key);
PostmanRequestFolder folder = new PostmanRequestFolder(tagName, tagDescription);
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
List<CodegenOperation> list = codegenOperationsByTag.get(folder);

if (list == null) {
list = new ArrayList<>();
}
list.add(codegenOperation);

codegenOperationsByTag.put(key, list);
codegenOperationsByTag.put(folder, list);

// sort requests by path
Collections.sort(list, Comparator.comparing(obj -> obj.path));
Expand Down Expand Up @@ -883,6 +889,30 @@ public String getPostmanType(CodegenProperty codegenProperty) {
}
}

@Getter
public static class PostmanRequestFolder {
private final String name;
private final String description;

public PostmanRequestFolder(String name, String description) {
this.name = name;
this.description = description;
}

@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
PostmanRequestFolder that = (PostmanRequestFolder) o;
return Objects.equals(name, that.name) && Objects.equals(description, that.description);
}

@Override
public int hashCode() {
return Objects.hash(name, description);
}
}

// Supporting models
@Getter
@Setter
Expand Down
3 changes: 2 additions & 1 deletion modules/openapi-generator/src/main/resources/postman-collection/postman.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
{{#codegenOperationsByTag}}
{{#entrySet}}
{
"name": "{{key}}",
"name": "{{key.name}}",
"description": "{{key.description}}",
"item": [{{#value}}
{{>item}}{{^-last}},{{/-last}}{{/value}}
]
Expand Down
30 changes: 24 additions & 6 deletions ...enerator/src/test/java/org/openapitools/codegen/postman/PostmanCollectionCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.*;
import static org.openapitools.codegen.TestUtils.*;
Expand Down Expand Up @@ -75,6 +77,9 @@ public void testBasicGeneration() throws IOException {
assertFileContains(path, "\"name\": \"Get User\"");
// verify request endpoint
TestUtils.assertFileContains(path, "\"name\": \"/users/:userId\"");
// verify folder name and description
TestUtils.assertFileContains(path, "\"name\": \"basic\"");
TestUtils.assertFileContains(path, "\"description\": \"Basic tag\"");
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
Outdated

}

Expand Down Expand Up @@ -702,24 +707,26 @@ public void testAddToMap() {

CodegenOperation operationUsers = new CodegenOperation();
operationUsers.path = "/users";
operationUsers.tags = new ArrayList<>(Arrays.asList(new Tag().name("basic")));
operationUsers.tags = new ArrayList<>(Arrays.asList(new Tag().name("basic").description("Basic tag")));
postmanV2Generator.addToMap(operationUsers);

CodegenOperation operationGroups = new CodegenOperation();
operationGroups.path = "/groups";
operationGroups.tags = new ArrayList<>(Arrays.asList(new Tag().name("basic")));
operationGroups.tags = new ArrayList<>(Arrays.asList(new Tag().name("basic").description("Basic tag")));
postmanV2Generator.addToMap(operationGroups);

CodegenOperation operationUserId = new CodegenOperation();
operationUserId.path = "/users/{id}";
operationUserId.tags = new ArrayList<>(Arrays.asList(new Tag().name("basic")));
operationUserId.tags = new ArrayList<>(Arrays.asList(new Tag().name("basic").description("Basic tag")));
postmanV2Generator.addToMap(operationUserId);

PostmanCollectionCodegen.PostmanRequestFolder folder = new PostmanCollectionCodegen.PostmanRequestFolder("basic", "Basic tag");

// verify tag 'basic'
assertEquals(1, postmanV2Generator.codegenOperationsByTag.size());
assertEquals(true, postmanV2Generator.codegenOperationsByTag.containsKey("basic"));
assertEquals(true, postmanV2Generator.codegenOperationsByTag.containsKey(folder));

List<CodegenOperation> operations = postmanV2Generator.codegenOperationsByTag.get("basic");
List<CodegenOperation> operations = postmanV2Generator.codegenOperationsByTag.get(folder);
// verify order
assertEquals("/groups", operations.get(0).path);
assertEquals("/users", operations.get(1).path);
Expand All @@ -737,7 +744,18 @@ public void testAddToMapUsingDefaultTag() {

// verify tag 'default' is used
assertEquals(1, postmanV2Generator.codegenOperationsByTag.size());
assertEquals(true, postmanV2Generator.codegenOperationsByTag.containsKey("default"));
assertEquals(true, postmanV2Generator.codegenOperationsByTag.containsKey(new PostmanCollectionCodegen.PostmanRequestFolder("Default", "Default tag")));
}

@Test
public void testPostmanRequestFolderInMap() {
PostmanCollectionCodegen.PostmanRequestFolder folder1 = new PostmanCollectionCodegen.PostmanRequestFolder("test", "descr");
Map<PostmanCollectionCodegen.PostmanRequestFolder, String> map = new HashMap<>();
map.put(folder1, "folder1");
PostmanCollectionCodegen.PostmanRequestFolder folder2 = new PostmanCollectionCodegen.PostmanRequestFolder("test", "descr");

assertTrue(map.containsKey(folder2));
assertEquals("folder1", map.get(folder2));
}

@Test
Expand Down
Loading
Loading