added support to exclude a route from documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/8f1c63f7 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/8f1c63f7 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/8f1c63f7 Branch: refs/heads/camel-2.16.x Commit: 8f1c63f7e3dbe7525b55a90775a1ee5b10491df7 Parents: 5b0714b Author: Simion Hantig <simion.han...@hgdata.com> Authored: Mon Mar 14 12:10:27 2016 +0200 Committer: Simion Hantig <simion.han...@hgdata.com> Committed: Mon Mar 14 14:00:35 2016 +0200 ---------------------------------------------------------------------- .../org/apache/camel/model/rest/RestDefinition.java | 7 +++++-- .../org/apache/camel/model/rest/VerbDefinition.java | 14 +++++++++----- .../org/apache/camel/swagger/RestSwaggerReader.java | 6 ++++-- 3 files changed, 18 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/8f1c63f7/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java index 176d31d..cfe7a23 100644 --- a/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java @@ -497,9 +497,12 @@ public class RestDefinition extends OptionalIdentifiedDefinition<RestDefinition> return this; } - public RestDefinition excludeFromDocs() { + /** + * Include or exclude the current Rest Definition in API documentation + */ + public RestDefinition apiDocs(Boolean apiDocs) { VerbDefinition verb = getVerbs().get(getVerbs().size() - 1); - verb.setExcludeFromDocs(true); + verb.setApiDocs(apiDocs); return this; } http://git-wip-us.apache.org/repos/asf/camel/blob/8f1c63f7/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java index d3a9aba..2c33f8e 100644 --- a/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java @@ -99,7 +99,7 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition> @XmlAttribute private String routeId; @XmlAttribute - private Boolean excludeFromDocs; + private Boolean apiDocs; @Override public String getLabel() { @@ -371,12 +371,16 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition> return rest.verb(verb, uri); } - public Boolean getExcludeFromDocs() { - return excludeFromDocs; + public Boolean getApiDocs() { + return apiDocs; } - public void setExcludeFromDocs(Boolean excludeFromDocs) { - this.excludeFromDocs = excludeFromDocs; + /** + * Whether to include or exclude the VerbDefinition in API documentation. + * The default value is true. + */ + public void setApiDocs(Boolean apiDocs) { + this.apiDocs = apiDocs; } public String asVerb() { http://git-wip-us.apache.org/repos/asf/camel/blob/8f1c63f7/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java ---------------------------------------------------------------------- diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java index 36e306c..fa30815 100644 --- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java +++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java @@ -116,7 +116,8 @@ public class RestSwaggerReader { // gather all types in use Set<String> types = new LinkedHashSet<>(); for (VerbDefinition verb : verbs) { - if (verb.getExcludeFromDocs() != null && verb.getExcludeFromDocs()) { + // check if the Verb Definition must be excluded from documentation + if (verb.getApiDocs() != null && !verb.getApiDocs()) { continue; } String type = verb.getType(); @@ -159,7 +160,8 @@ public class RestSwaggerReader { String basePath = rest.getPath(); for (VerbDefinition verb : verbs) { - if (verb.getExcludeFromDocs() != null && verb.getExcludeFromDocs()) { + // check if the Verb Definition must be excluded from documentation + if (verb.getApiDocs() != null && !verb.getApiDocs()) { continue; } // the method must be in lower case
