[GitHub] flink pull request #5797: [FLINK-9104][doc]Re-generate REST API documentatio...

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/flink/pull/5797


---

[GitHub] flink pull request #5797: [FLINK-9104][doc]Re-generate REST API documentatio...

[walterddr]

Github user walterddr commented on a diff in the pull request:

https://github.com/apache/flink/pull/5797#discussion_r178913403
  
--- Diff: 
flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java ---
@@ -258,6 +265,37 @@ private static String createMessageHtmlEntry(Class 
messageClass, Class emp
return json;
}
 
+   /**
+* Create character escapes for HTML when generating JSON 
request/response string.
+*/
+   private static class HTMLCharacterEscapes extends CharacterEscapes {
--- End diff --

good point. added in comments to illustrate the necessity. 


---

[GitHub] flink pull request #5797: [FLINK-9104][doc]Re-generate REST API documentatio...

[zentol]

Github user zentol commented on a diff in the pull request:

https://github.com/apache/flink/pull/5797#discussion_r178773735
  
--- Diff: 
flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java ---
@@ -258,6 +265,37 @@ private static String createMessageHtmlEntry(Class 
messageClass, Class emp
return json;
}
 
+   /**
+* Create character escapes for HTML when generating JSON 
request/response string.
+*/
+   private static class HTMLCharacterEscapes extends CharacterEscapes {
--- End diff --

It would be good to document that this is necessary because the `id` field 
of the schema may contain generic types, like `SerializedValue`.


---

[GitHub] flink pull request #5797: [Flink 9104][doc]Re-generate REST API documentatio...

[walterddr]

GitHub user walterddr opened a pull request:

https://github.com/apache/flink/pull/5797

[Flink 9104][doc]Re-generate REST API documentation for FLIP-6

## What is the purpose of the change

Fix REST-API doc generator and regenerate rest_dispatcher.html

## Brief change log

- Changes according to FLINK-8843
- Escape HTML characters

## Verifying this change

N/A

## Does this pull request potentially affect one of the following parts:

no

## Documentation

docs updated


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/walterddr/flink FLINK-9104

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/flink/pull/5797.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 #5797


commit a5ad88f7fa8200cea5084b6d630592bc473a9b6a
Author: Rong Rong 
Date:   2018-03-31T19:29:59Z

fix REST API doc generator bug and regenerate rest_dispatcher




---