You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brooklyn.apache.org by andreaturli <gi...@git.apache.org> on 2015/12/10 15:56:52 UTC
[GitHub] incubator-brooklyn pull request: Generate Swagger API Specificatio...
GitHub user andreaturli opened a pull request:
https://github.com/apache/incubator-brooklyn/pull/1100
Generate Swagger API Specification using a maven plugin
- combined with https://github.com/swagger-api/swagger-codegen, it can generate rest bindings for multiple languages
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/andreaturli/incubator-brooklyn feature/generate-swagger-api-spec
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-brooklyn/pull/1100.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 #1100
----
commit a1295b8288c4d924f65d02f56efde571a3386d42
Author: Andrea Turli <an...@gmail.com>
Date: 2015-12-10T14:53:32Z
Generate Swagger API Specification using a maven plugin
- combined with https://github.com/swagger-api/swagger-codegen, it can generate rest bindings for multiple languages
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Generate Swagger API Specificatio...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-brooklyn/pull/1100
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Generate Swagger API Specificatio...
Posted by sjcorbett <gi...@git.apache.org>.
Github user sjcorbett commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1100#discussion_r47345353
--- Diff: usage/rest-api/pom.xml ---
@@ -98,4 +98,48 @@
</dependency>
</dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>com.github.kongchen</groupId>
+ <artifactId>swagger-maven-plugin</artifactId>
+ <version>3.1.0</version>
+ <configuration>
+ <apiSources>
+ <apiSource>
+ <springmvc>false</springmvc>
+ <locations>org.apache.brooklyn.rest.api</locations>
+ <schemes>http,https</schemes>
+ <host>brooklyn.io</host>
--- End diff --
Why include `host`? brooklyn.io doesn't serve this API.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Generate Swagger API Specificatio...
Posted by sjcorbett <gi...@git.apache.org>.
Github user sjcorbett commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1100#discussion_r47345369
--- Diff: usage/rest-api/pom.xml ---
@@ -98,4 +98,48 @@
</dependency>
</dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>com.github.kongchen</groupId>
+ <artifactId>swagger-maven-plugin</artifactId>
+ <version>3.1.0</version>
+ <configuration>
+ <apiSources>
+ <apiSource>
+ <springmvc>false</springmvc>
+ <locations>org.apache.brooklyn.rest.api</locations>
+ <schemes>http,https</schemes>
+ <host>brooklyn.io</host>
+ <basePath>/api</basePath>
--- End diff --
Isn't this dependent on whoever has deployed the API?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Generate Swagger API Specificatio...
Posted by andreaturli <gi...@git.apache.org>.
Github user andreaturli commented on the pull request:
https://github.com/apache/incubator-brooklyn/pull/1100#issuecomment-163917036
thanks @sjcorbett, you are right, I was misled by the reference example of that maven plugin. I'll remove those configurations as not required.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---