From ec456cd3dc6fbf1e8b9fc499f7dc4e7accfebdac Mon Sep 17 00:00:00 2001 From: fterrot Date: Sat, 6 Mar 2021 16:56:52 +0100 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 849f875..5253473 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ # java.gitea.api -Can be ween as a fork of https://github.com/zeripath/java-gitea-api with updated Gitea API version and generated thanks to OpenAPI. \ No newline at end of file +Generated Java API for Gitea. + +Original repository is https://forge.chapril.org/gitea/java.gitea.api/. A github mirror https://github.com/teilginn/java-gitea-api is maintained. + +## Credits + +* https://github.com/zeripath/java-gitea-api + +## Why another version ? + +For https://forge.chapril.org/gitea/mylyn-gitea/ project I started to use https://github.com/zeripath/java-gitea-api. + +Unfortunatelly I experimented blocking ssl connections issues due to the obsolete version of okhttp library the generated code is based on. The root cause of the issue is the swagger code generaror. I had also a lot of issue coming from the Java. + +So I decide to restart from scratch with OpenAPI generator which is maintain up to date. + +## Branching Strategy + +`head` -> `openapi` -> `io.io.gitea.` + +* `head` branch shall not be used. It used on Github only to keep track on the original java-gitea-api head branch. +* `openapi` branch will only contains the minimal set of stuff required to generate from scratch. +* `java.io.gitea.` branch is used for the ready to use Gitea __ api (generated from Gitea repository release) +* `java.io.gitea.master` branch may be maintain aligned with the Gitea head branch api. (near future) + +## License + +`generate.sh` and `README.md` are the only files I'm the author. They are provided under the MIT license You will find a copy in the LICENSE file. + +I think that no one should take the ownership of configuration or generated files. So they are provided as-is for your convenience without any warranty. If you use them, You are just ask you to credits the original location you find them. + +The Gitea swagger api description file is provided under the MIT License by the Gitea Authors. + +NOTE: To avoid any ownership confusion, this repository is using a Yaml configuration file. + +## How to generate + +NOTE: Generate requires a *Unix* based host supporting `bash`, `Java JDK` (1.8 or newer) and `Maven`. The *1.13* branch has been generated on a XUbuntu 20.04 host (bash:5.0.17, openjdk 11.0.10, Apache Maven 3.6.3) and openapi-generator-cli 5.0.1. + +`generate.sh` downloads the OpenAPI generator and Gitea swagger API description from their original delivery locations before starting the code generator. At this end it runs _maven_ library packaging and test + +1. Check the generate.sh file parameters +1. run `generate.sh`