[
https://issues.apache.org/jira/browse/NIFI-3932?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16015785#comment-16015785
]
ASF GitHub Bot commented on NIFI-3932:
--------------------------------------
GitHub user jskora opened a pull request:
https://github.com/apache/nifi/pull/1821
NIFI-3932 Symbols in API comments cause problems with Swagger Codegen
* Update ApiModelProperty descriptions to avoid problematic characters.
Thank you for submitting a contribution to Apache NiFi.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [ ] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number
you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [ ] Has your PR been rebased against the latest commit within the target
branch (typically master)?
- [ ] Is your initial contribution a single, squashed commit?
### For code changes:
- [ ] Have you ensured that the full suite of tests is executed via mvn
-Pcontrib-check clean install at the root nifi folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main
LICENSE file under nifi-assembly?
- [ ] If applicable, have you updated the NOTICE file, including the main
NOTICE file found under nifi-assembly?
- [ ] If adding new Properties, have you added .displayName in addition to
.name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in
which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jskora/nifi NIFI-3932
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/nifi/pull/1821.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1821
----
commit b6c8c69a7941fd4de8fe1e856752f8e0bbe2edb9
Author: Joe Skora <[email protected]>
Date: 2017-05-18T13:45:36Z
NIFI-3932 Symbols in API comments cause problems with Swagger Codegen
* Update ApiModelProperty descriptions to avoid problematic characters.
----
> Symbols in API comments cause problems with Swagger Codegen
> -----------------------------------------------------------
>
> Key: NIFI-3932
> URL: https://issues.apache.org/jira/browse/NIFI-3932
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Core Framework
> Affects Versions: 1.2.0
> Reporter: Joe Skora
> Assignee: Joe Skora
> Priority: Trivial
>
> DTO property descriptions that describe styles as "key => value" cause errors
> in source generated by Swagger Codegen do to the greater-than (">")
> character. Replacing these with "key: value" will keep the meaning clear and
> simplify API generation.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
