Skip to content

Commit 35c5291

Browse files
committed
Use swagger.json instead of openapi.yml
1 parent 8531896 commit 35c5291

File tree

5 files changed

+2114
-6
lines changed

5 files changed

+2114
-6
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
[![Latest version](https://img.shields.io/maven-central/v/software.xdev/mailpit-java-client?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/mailpit-java-client)
22
[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/mailpit-java-client/check-build.yml?branch=develop)](https://github.com/xdev-software/mailpit-java-client/actions/workflows/check-build.yml?query=branch%3Adevelop)
3-
[![API Specification Editor](https://img.shields.io/badge/API--Spec-Editor-85ea2d?logo=swagger)](https://editor.swagger.io/?url=https://raw.githubusercontent.com/xdev-software/mailpit-java-client/develop/openapi/openapi.yml)
43

54
# mailpit-java-client
65

7-
This client [is generated](./mailpit-java-client/pom.xml) from an [``openapi.yml``](./openapi/openapi.yml) using [OpenAPI Generator](https://openapi-generator.tech/).
6+
This client [is generated](./mailpit-java-client/pom.xml) from an [``swagger.json``](./openapi/swagger.json) using [OpenAPI Generator](https://openapi-generator.tech/).
87

98
## Installation
109
[Installation guide for the latest release](https://github.com/xdev-software/mailpit-java-client/releases/latest#Installation)

mailpit-java-client/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@
282282
<profile>
283283
<id>openapi-generator</id>
284284
<properties>
285-
<componentName>INSERT_NAME_HERE</componentName>
285+
<componentName>mailpit</componentName>
286286

287287
<generatedDir>${project.basedir}/${generatedDirRelative}</generatedDir>
288288
<openApiRelativeGeneratorDir>src/gen</openApiRelativeGeneratorDir>
@@ -331,7 +331,7 @@
331331
<goal>generate</goal>
332332
</goals>
333333
<configuration>
334-
<inputSpec>${project.basedir}/../openapi/openapi.yml</inputSpec>
334+
<inputSpec>${project.basedir}/../openapi/swagger.json</inputSpec>
335335
<generatorName>java</generatorName>
336336
<configOptions>
337337
<sourceFolder>${openApiRelativeGeneratorDir}</sourceFolder>

openapi/INFO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This ``openapi.yml`` was written manually as INSERT_NAME_HERE fails to provide an API schema or something similar.
1+
This ``swagger.json`` is a copy from https://github.com/axllent/mailpit/blob/develop/server/ui/api/v1/swagger.json.
22

33
The Java API Client can be generated using ``mvn clean compile -P openapi-generator`` inside [``mailpit-java-client``](../mailpit-java-client/).
44

openapi/openapi.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)