Skip to content

Commit

Permalink
health endpoint in SDK (#12)
Browse files Browse the repository at this point in the history
* health endpoint in SDK

* git commit info in SDK

* removing git info changes: these need to reside in the connector

* documentation

* More docs
  • Loading branch information
EmilDafinov authored and gbranchaudrubenovitch committed Nov 7, 2016
1 parent c6ee413 commit eedaa35
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,29 @@ public class MinimalConnector {
* `GET /health`
Returns a 200 (Success) HTTP code. Used to verify that the server is up

* `GET /info`
Returns information about the deployed application. The information returned varies
according to the configuration of the client application. Currently we've
confirmed that if there is a `git.properties` file in the classpath, generated
by the [git commit id maven plugin](https://github.com/ktoso/maven-git-commit-id-plugin),
you'll get output like:
```
{
"git": {
"commit": {
"time": "2016-11-07T18:05:22.000+0000",
"id": "2940352"
},
"branch": "bugfix/HTTPSigInConnector"
}
}
```
* `GET /api/v1/integration/processEvent?eventUrl=[insert-event-callback-url-here]`
That is the endpoint where the appmarket sends event notifications

Note that the SDK includes the `spring-boot-starter-actuator`, which
means several more endpoints are exposed automatically by Spring.
For more information review the documentation [here](http://docs.spring.io/spring-boot/docs/1.4.1.RELEASE/reference/htmlsingle/#production-ready-endpoints)

## Building
* `mvn clean javadoc:jar source:jar install`
4 changes: 4 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@

<dependencies>
<!-- Spring -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
Expand Down

0 comments on commit eedaa35

Please sign in to comment.