Skip to content

Commit 194fcb7

Browse files
committed
Add link for the swagger api docs
1 parent 8f19604 commit 194fcb7

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -88,16 +88,19 @@ Note that `cf.ldif` contains **default credentials** and should only be used dur
8888

8989
### Verification
9090

91-
To check that the server is running correctly, visit [the default homepage](http://localhost:8080/).
91+
To check that the server is running correctly, visit [the default homepage](http://localhost:8080/). For more
92+
information on the api see the [swagger docs endpoint](http://localhost:8080/swagger-ui/index.html).
9293

9394
## Development
9495

95-
It's strongly encouraged to use a modern IDE such as [Intelij](https://www.jetbrains.com/idea/) and [Eclipse](https://eclipseide.org/).
96+
It's strongly encouraged to use a modern IDE such as [Intelij](https://www.jetbrains.com/idea/)
97+
and [Eclipse](https://eclipseide.org/).
9698

9799
* Prerequisites
98100

99-
* JDK 17
100-
* Maven (via package manager or via the wrapper `./mvnw`) (version specified in [the wrapper properties](./.mvn/wrapper/maven-wrapper.properties))
101+
* JDK 17
102+
* Maven (via package manager or via the wrapper `./mvnw`) (version specified
103+
in [the wrapper properties](./.mvn/wrapper/maven-wrapper.properties))
101104

102105
For the following commands `mvn` can be interchangeably used instead via `./mvnw`
103106

@@ -127,7 +130,8 @@ See `src/test/java` and package
127130

128131
* `org.phoebus.channelfinder.docker`
129132

130-
Integration tests start docker containers for ChannelFinder and Elasticsearch and run http requests (GET, POST, PUT, DELETE) towards the application to test behavior (read, list, query, create, update, remove) and
133+
Integration tests start docker containers for ChannelFinder and Elasticsearch and run http requests (GET, POST, PUT,
134+
DELETE) towards the application to test behavior (read, list, query, create, update, remove) and
131135
replies are received and checked if content is as expected.
132136

133137
There are tests for properties, tags and channels separately and in combination.
@@ -154,27 +158,27 @@ using the sonatype repositories.
154158
Create a sonatype account and update the maven settings.xml file with your sonatype credentials
155159

156160
```xml
157-
<servers>
158-
<server>
159-
<id>phoebus-releases</id>
160-
<username>username</username>
161-
<password>*******</password>
162-
</server>
163-
</servers>
161+
<servers>
162+
<server>
163+
<id>phoebus-releases</id>
164+
<username>username</username>
165+
<password>*******</password>
166+
</server>
167+
</servers>
164168
```
165169

166170
#### Prepare the release
167171

168172
```bash
169173
mvn release:prepare
170174
```
175+
171176
In this step will ensure there are no uncommitted changes, ensure the versions number are correct, tag the scm, etc..
172177
A full list of checks is
173178
documented [here](https://maven.apache.org/maven-release/maven-release-plugin/examples/prepare-release.html):
174179

175180
#### Perform the release
176181

177-
178182
```bash
179183
mvn release:perform
180184
```

0 commit comments

Comments
 (0)