-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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.
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
Enumeration of data model properties #21
Comments
Swagger 2.0 allows for more extensive external documentation but it does not offer the ability to attach a description to fixed values in the I will close the issue for now, but will mark it as a feature proposal for the next spec version. |
Closing in favor of #348. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I have a case where I have an enumeration that can return different String values. The @ApiModelProperty's allowableValues is close, but I need to have metadata associated with each possible value. Something like this:
@ApiModelProperty(...., allowableValues={
@ApiModelPropertyValue( value="registered", description="Yada yada...", discriminator="PUT" ),
@ApiModelPropertyValue( value="active", description="Yada yada...", discriminator="PUT,POST" ),
@ApiModelPropertyValue( value="closed", description="Yada yada...", discriminator="POST" )
});
It seems like any time there is a value, you'd need to at least describe the possible values.
The text was updated successfully, but these errors were encountered: