swagger-api/swagger-codegen

CodegenOperation isMemberPath()

Open

#4,030 opened on Oct 18, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaIssue: Bughelp wanted

Description

Description

CodegenOperation methods isRestfulUpdate and isRestulDestroy has the condition of isMemberPath() which contains this login:

` if (pathParams.size() != 1) return false;

I believe it is valid for a REST call to contain multiple path param: eg. DELETE /org/{myOrg}/user/{myUser} and PATCH /org/{myOrg}/user/{myUser} (valid in my current model)

This is preventing me from properly using the isRestfulUpdate method within a mustache template.

Swagger-codegen version

2.2.1

Suggest a Fix

Remove the isMemberPath() references from the IsRestful* methods, or change condition to have if (pathParams.size() == 0) return false;

Contributor guide

Tech stack
java
Domain
backendapitooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Java knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue is in the CodegenOperation class, specifically in the isRestfulUpdate and isRestfulDestroy methods which call isMemberPath(). The isMemberPath() method currently returns false if pathParams.size() != 1. To fix, modify the condition to allow multiple path parameters by changing it to pathParams.size() == 0. The files are likely in the swagger codegen/src/main/java/io/swagger/codegen/ directory. Review the existing PRs or comments for any prior attempts.