Skip to content

Commit 669ff53

Browse files
committed
apply the formatting
1 parent 37d47eb commit 669ff53

File tree

882 files changed

+29289
-33058
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

882 files changed

+29289
-33058
lines changed

.github/test-mvn-deploy/pom.xml

+24-25
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0"
2-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4-
<modelVersion>4.0.0</modelVersion>
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
54

6-
<groupId>com.apicurio.test</groupId>
7-
<artifactId>verify-registry-maven-deploy</artifactId>
8-
<version>1.0.0-SNAPSHOT</version>
9-
<name>verify-registry-maven-deploy</name>
10-
<description>Simple Project to verify the deployment of Apicurio Registry JARS</description>
5+
<groupId>com.apicurio.test</groupId>
6+
<artifactId>verify-registry-maven-deploy</artifactId>
7+
<version>1.0.0-SNAPSHOT</version>
8+
<name>verify-registry-maven-deploy</name>
9+
<description>Simple Project to verify the deployment of Apicurio Registry JARS</description>
1110

12-
<properties>
13-
<!-- To be filled at runtime using "-Dversion.apicurio=1.x.x.Final" -->
14-
<version.apicurio>TBD</version.apicurio>
15-
</properties>
11+
<properties>
12+
<!-- To be filled at runtime using "-Dversion.apicurio=1.x.x.Final" -->
13+
<version.apicurio>TBD</version.apicurio>
14+
</properties>
1615

17-
<dependencies>
18-
<dependency>
19-
<groupId>io.apicurio</groupId>
20-
<artifactId>apicurio-registry-serdes-avro-serde</artifactId>
21-
<version>${version.apicurio}</version>
22-
</dependency>
23-
<dependency>
24-
<groupId>io.apicurio</groupId>
25-
<artifactId>apicurio-registry-java-sdk</artifactId>
26-
<version>${version.apicurio}</version>
27-
</dependency>
28-
</dependencies>
16+
<dependencies>
17+
<dependency>
18+
<groupId>io.apicurio</groupId>
19+
<artifactId>apicurio-registry-serdes-avro-serde</artifactId>
20+
<version>${version.apicurio}</version>
21+
</dependency>
22+
<dependency>
23+
<groupId>io.apicurio</groupId>
24+
<artifactId>apicurio-registry-java-sdk</artifactId>
25+
<version>${version.apicurio}</version>
26+
</dependency>
27+
</dependencies>
2928
</project>

CONTRIBUTING.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Contributing guide
22

3-
**Want to contribute? Great!**
3+
**Want to contribute? Great!**
44
We try to make it easy, and all contributions, even the smaller ones, are more than welcome.
5-
This includes bug reports, fixes, documentation, examples...
5+
This includes bug reports, fixes, documentation, examples...
66
But first, read this page (including the small print at the end).
77

88
* [Legal](#legal)
@@ -66,7 +66,7 @@ Because we are all humans, and to ensure Apicurio Registry is stable for everyon
6666

6767
### Tests and documentation are not optional
6868

69-
Don't forget to include tests in your pull requests.
69+
Don't forget to include tests in your pull requests.
7070
Also don't forget the documentation (reference documentation, javadoc...).
7171

7272
Be sure to test your pull request using all storage variants:
@@ -97,4 +97,3 @@ The important parts are as follows:
9797
## The small print
9898

9999
This project is an open source project. Please act responsibly, be nice, polite and enjoy!
100-

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ An API/Schema registry - stores and retrieves APIs and Schemas.
1010

1111
This project supports several build configuration options that affect the produced executables.
1212

13-
By default, `mvn clean install` produces an executable JAR with the *dev* Quarkus configuration profile enabled, and *in-memory* persistence implementation.
13+
By default, `mvn clean install` produces an executable JAR with the *dev* Quarkus configuration profile enabled, and *in-memory* persistence implementation.
1414

1515
Apicurio Registry supports 4 persistence implementations:
1616
- In-Memory
@@ -34,15 +34,15 @@ For this property, there are three possible values:
3434
Additionally, there are 2 main configuration profiles:
3535
- *dev* - suitable for development, and
3636
- *prod* - for production environment.
37-
37+
3838
### Getting started (APIs)
3939

4040
```
4141
./mvnw clean install -DskipTests
4242
cd app/
4343
../mvnw quarkus:dev
4444
```
45-
45+
4646
This should result in Quarkus and the in-memory registry starting up, with the REST APIs available on localhost port 8080:
4747

4848
* [API documentation](http://localhost:8080/apis)
@@ -78,7 +78,7 @@ The following parameters are available for executable files:
7878
### SQL
7979
- By default, the application expects an H2 server running at `jdbc:h2:tcp://localhost:9123/mem:registry`.
8080
- For configuring the database kind and the datasource values, the following configuration options are available:
81-
81+
8282
| Option | Command argument | Env. variable |
8383
|---------------------------|---------------------------------|--------------------------------|
8484
| Registry SQL storage kind | `-Dapicurio.storage.sql.kind` | `APICURIO_STORAGE_SQL_KIND` |
@@ -87,8 +87,8 @@ The following parameters are available for executable files:
8787
| DS Password | `-Dapicurio.datasource.password` | `APICURIO_DATASOURCE_PASSWORD` |
8888

8989
To see additional options, visit:
90-
- [Data Source config](https://quarkus.io/guides/datasource)
91-
- [Data Source options](https://quarkus.io/guides/datasource-guide#configuration-reference)
90+
- [Data Source config](https://quarkus.io/guides/datasource)
91+
- [Data Source options](https://quarkus.io/guides/datasource-guide#configuration-reference)
9292

9393
### KafkaSQL
9494
`./mvnw clean install -Pprod -DskipTests` builds the application artifact.
@@ -119,7 +119,7 @@ java \
119119
This will start up the registry with the persistence managed by the external kafka cluster.
120120

121121
## Docker containers
122-
Every time a commit is pushed to `main` an updated docker image is built and pushed to Docker
122+
Every time a commit is pushed to `main` an updated docker image is built and pushed to Docker
123123
Hub. The image can be found in:
124124

125125
* [apicurio-registry](https://hub.docker.com/r/apicurio/apicurio-registry)
@@ -128,8 +128,8 @@ Run the above docker image like this:
128128

129129
docker run -it -p 8080:8080 apicurio/apicurio-registry:latest-snapshot
130130

131-
The same configuration options are available for the docker containers, but only in the form of environment
132-
variables (The command line parameters are for the `java` executable and at the moment it's not possible to
131+
The same configuration options are available for the docker containers, but only in the form of environment
132+
variables (The command line parameters are for the `java` executable and at the moment it's not possible to
133133
pass them into the container). Each docker image will support the environment variable configuration options
134134
documented above for their respective storage type.
135135

@@ -161,7 +161,7 @@ Run Apicurio Registry with Postgres:
161161

162162
- Compile using `mvn clean install -DskipTests -Pprod -Ddocker`
163163

164-
- Then create a docker-compose file `test.yml`:
164+
- Then create a docker-compose file `test.yml`:
165165
```yaml
166166
version: '3.1'
167167

@@ -187,7 +187,7 @@ services:
187187
## Security
188188

189189
You can enable authentication for both the application REST APIs and the user interface using a server based
190-
on OpenID Connect (OIDC). The same server realm and users are federated across the user interface and the
190+
on OpenID Connect (OIDC). The same server realm and users are federated across the user interface and the
191191
REST APIs using Open ID Connect so that you only require one set of credentials.
192192

193193
In order no enable this integration, you will need to set the following environment variables.
@@ -221,7 +221,7 @@ For more information see the documentation on [how to configure security in Regi
221221
## Eclipse IDE
222222

223223
Some notes about using the Eclipse IDE with the Apicurio Registry codebase. Before
224-
importing the registry into your workspace, we recommend some configuration of the
224+
importing the registry into your workspace, we recommend some configuration of the
225225
Eclipse IDE.
226226

227227
### Lombok Integration
@@ -239,7 +239,7 @@ We use the **maven-dependency-plugin** in a few places to unpack a maven module
239239
reactor into another module. For example, the `app` module unpacks the contents of
240240
the `ui` module to include/embed the user interface into the running application.
241241
Eclipse does not like this. To fix this, configure the Eclipse Maven "Lifecycle Mappings"
242-
to ignore the usage of **maven-dependency-plugin**.
242+
to ignore the usage of **maven-dependency-plugin**.
243243

244244
* Open up **Window->Preferences**
245245
* Choose **Maven->Lifecycle Mappings**
@@ -264,7 +264,7 @@ to ignore the usage of **maven-dependency-plugin**.
264264
</pluginExecution>
265265
```
266266
267-
* Now go back into **Maven->Lifecycle Mappings** -> **Maven->Lifecycle Mappings** and click
267+
* Now go back into **Maven->Lifecycle Mappings** -> **Maven->Lifecycle Mappings** and click
268268
the **Reload workspace lifecycle mappings metadata** button.
269269
* If you've already imported the Apicurio projects, select all of them and choose **Maven->Update Project**.
270270
@@ -273,5 +273,5 @@ the **Reload workspace lifecycle mappings metadata** button.
273273
We use some Google Protobuf files and a maven plugin to generate some Java classes that
274274
get stored in various modules' `target` directories. These are then recognized by m2e
275275
but are sometimes deleted during the Eclipse "clean" phase. To prevent Eclipse from
276-
over-cleaning these files, find the **os-maven-plugin-1.6.2.jar** JAR in your
276+
over-cleaning these files, find the **os-maven-plugin-1.6.2.jar** JAR in your
277277
`.m2/repository` directory and copy it into `$ECLIPSE_HOME/dropins`.

TESTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Apicurio Registry testsuite has various types of tests: unit tests and integrati
99
Quick tests that verify specific functionalities or components of the application. Each maven module can have it's own set of unit tests.
1010
For the Apicurio Registry app they can be found in `app/src/test`
1111

12-
Because Apicurio Registry is a Quarkus application we use `@QuarkusTest` for the unit tests, that allow us to run multiple different configurations of
12+
Because Apicurio Registry is a Quarkus application we use `@QuarkusTest` for the unit tests, that allow us to run multiple different configurations of
1313
the application, easily provide mocks or external dependencies... QuarkusTest allows us to easily verify feature flags or config properties that change completely the behavior of the application. In order to do that we use `@QuarkusTestProfile` quite often.
1414

1515
Unit tests are executed as part of the project build. You can build the project and run the tests by executing this command:

0 commit comments

Comments
 (0)