Skip to content

NIFI-3932 Symbols in API comments cause problems with Swagger Codegen#1821

Closed
jskora wants to merge 1 commit intoapache:masterfrom
jskora:NIFI-3932
Closed

NIFI-3932 Symbols in API comments cause problems with Swagger Codegen#1821
jskora wants to merge 1 commit intoapache:masterfrom
jskora:NIFI-3932

Conversation

@jskora
Copy link
Contributor

@jskora jskora commented May 18, 2017

  • 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?
  • 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.

* Update ApiModelProperty descriptions to avoid problematic characters.
@pvillard31
Copy link
Contributor

+1, merged to master, thanks @jskora!

@asfgit asfgit closed this in 0a7d149 May 23, 2017
mattyb149 pushed a commit to mattyb149/nifi that referenced this pull request Nov 30, 2017
* Update ApiModelProperty descriptions to avoid problematic characters.

Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>

This closes apache#1821.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants