[
https://issues.apache.org/jira/browse/FLINK-8133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16281655#comment-16281655
]
ASF GitHub Bot commented on FLINK-8133:
---------------------------------------
Github user kl0u commented on a diff in the pull request:
https://github.com/apache/flink/pull/5052#discussion_r155482662
--- Diff:
flink-runtime/src/main/java/org/apache/flink/runtime/rest/RestServerEndpoint.java
---
@@ -317,7 +317,21 @@ public int compare(
return
CASE_INSENSITIVE_ORDER.compare(o1.f0.getTargetRestEndpointURL(),
o2.f0.getTargetRestEndpointURL());
}
- static final class CaseInsensitiveOrderComparator implements
Comparator<String>, Serializable {
+ /**
+ * Comparator for Rest URLs.
+ *
+ * <p>The comparator orders the Rest URLs such that URLs with
path parameters are ordered behind
+ * those without parameters. E.g.:
+ * /jobs
+ * /jobs/overview
+ * /jobs/:jobid
+ * /jobs/:jobid/config
+ * /:*
+ *
+ * <p>IMPORTANT: This comparator is highly specific to how
Netty path parameter are encoded. Namely
--- End diff --
1) "path parameter" -> "path parameters"
2) "Namely via" -> "Namely with"
3) Also update accordingly the `RestHandlerUrlComparator` class javadoc
(which is a copy)
> Generate documentation for new REST API
> ---------------------------------------
>
> Key: FLINK-8133
> URL: https://issues.apache.org/jira/browse/FLINK-8133
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, REST
> Reporter: Chesnay Schepler
> Assignee: Chesnay Schepler
> Priority: Blocker
> Fix For: 1.5.0
>
>
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
