cadox8 · cadox8 · Jul 4, 2024 · Jul 4, 2024 · Jul 4, 2024 · Jul 5, 2024
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,35 +1,36 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a report and we will try to help with your problem!
 
 ---
 
+> [!CAUTION]
+> Web-API (formerly the .php version) is deprecated and won't receive any help
+
+> [!CAUTION]
+> Remember this is public, please don't add any sensitive information
+
+> [!TIP]
+> Please, set XenAPI with debug output by setting the option (XenAPI::setDebug(true)) if you want to add the trace of the bug
+
+**About the environment (please complete the following information):**
+
+- Xenforo version: [e.g. Xenforo 2.1.0]
+- Java Version: [e.g. termiun 21]
+- RequestType & Params [e.g. Request: getNode, Params: AUTH_USER]
+- XenAPI Version [e.g. 2.0.0]
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Web-API (please complete the following information):**
- - Action [e.g. getNode]
- - Hash [e.g. username:hash, api-key]
- - Version [e.g. 1.4.4]
-
-**Java-API (please complete the following information):**
- - Action: [e.g. getNode]
- - Hash [e.g. api-key]
- - RequestType & Params [e.g. Request: getNode, Params: AUTH_USER] 
- - Version [e.g. 0.3.2]
-
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here. Also, if the base API was modified in any way, please explain what changed here.
diff --git a/.github/workflow/build.yml b/.github/workflow/build.yml
@@ -0,0 +1,31 @@
+name: XenAPI CI
+
+on:
+  push:
+    branches: [ dev, master ]
+  pull_request:
+    types: [ opened ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [ '11', '17', '21' ]
+    name: Java ${{ matrix.Java }} sample
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Setup java
+        uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
+          cache: maven
+      - name: Cache the Maven packages to speed up build
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - run: mvn clean install --file pom.xml
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,16 @@
 .idea
-
+target
 # Used for testing
-src/es/cadox8/xenapi/Launcher.java
+/src/test/
+# Docs
+/docs/docs
+/docs/src
+/docs/static
+/docs/node_modules
+/docs/docusaurus.config.ts
+/docs/package-lock.json
+/docs/pnpm-workspace.yaml
+/docs/package.json
+/docs/pnpm-lock.yaml
+/docs/sidebars.ts
+/docs/tsconfig.json
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,88 +1,107 @@
-![Logo](docs/img/logo_64.png)
+![Logo](docs/logo/svg/logo-no-background.svg)
 
-[![Build Status](https://travis-ci.org/cadox8/XenAPI.svg?branch=master)](https://travis-ci.org/cadox8/XenAPI)
+[![Build Status](https://github.com/cadox8/XenAPI/actions/workflows/build.yml/badge.svg)](https://github.com/cadox8/XenAPI/actions)
+
+## This is a simple XenForo 2.X API for Java.
 
-### This is a simple XenForo API for Java.
 -----
 
 ## Summary
+
 * [XenAPI for Xenforo 1.X](#me.cadox8.xenapi-for-xenforo-1x)
 * [Downloads & Repo](#downloads--repo)
 * [Documentation](#documentation)
 * [Bug Reporting](#bug-reporting)
 * [Contributing](#contributing)
-* [Instalation](#installation)
 * [Usage & API Key](#usage--api-key)
 * [Dependencies](#dependencies)
 * [Bug Reporting](#bug-reporting)
 * [License & Copyright](#license--copyright)
-* [Donations](#donations)
-* [TODO](https://github.com/cadox8/XenAPI/issues/15)
+
 -----
 
 ## XenAPI for Xenforo 1.X
+
 This repo contains only a framework for Xenforo 2.X.
 
-v1.X of Xenforo will not be developed anymore. If you need the old API you can grab it from [here](https://github.com/cadox8/XenAPI/releases/tag/Xenforo_v1.X).
+v1.X of Xenforo will not be developed anymore. If you need the old API you can grab it
+from [here](https://github.com/cadox8/XenAPI/releases/tag/Xenforo_v1.X).
+
+> [!CAUTION]
+> The v1.X is deprecated
 
 ## Downloads & Repo
-All downloads are hosted in [Github](https://github.com/cadox8/XenAPI/releases).
+
+All downloads are hosted in [this repo](https://repo.cadox8.es/#/).
+
+Alternatively, you can download files [here on Github](https://github.com/cadox8/XenAPI/releases/latest).
 
 For the Java-API, you can add it on Maven:
 
 ```xml
-    <repositories>
-        <repository>
-            <id>XenAPI Repo</id>
-            <url>https://cadox8.es/repo</url>
-        </repository>
-    </repositories>
-
-    <dependencies>
-        <dependency>
-            <groupId>es.cadox8</groupId>
-            <artifactId>XenAPI</artifactId>
-            <version>RELEASE</version>
-        </dependency>
-    </dependencies>
+
+<repositories>
+    <repository>
+        <id>XenAPI Repo</id>
+        <url>https://repo.cadox8.es/#/</url>
+    </repository>
+</repositories>
+
+<dependencies>
+<dependency>
+    <groupId>es.cadox8</groupId>
+    <artifactId>XenAPI</artifactId>
+    <version>LATEST</version>
+</dependency>
+</dependencies>
 ```
 
-**NOTE:** You can use ``RELEASE`` as version or you can use the version number (you can check all versions [here](https://github.com/cadox8/XenAPI/releases))
+**NOTE:** You can use ``LATEST`` as version, or you can use the version number (you can check all
+versions [here](https://repo.cadox8.es/#/) or [on the docs](https://)).
 
 ## Documentation
-**Web-API & Java-API:** You can get the documentation [here](https://cadox8.github.io/XenAPI/#/).
 
-**Javadocs:** You can check the Javadocs [here](https://cadox8.github.io/XenAPI/javadocs).
+**XenAPI Docs**: You can get the documentation [here](https://cadox8.github.io/XenAPI/#/).
+
+**Javadocs**:
+Now you can see the javadocs by version!
+
+Just go to https://repo.cadox8.es/javadoc/snapshots/es/cadox8/XenAPI/<version>
+
+*Replace <version> with the version you want to check! Example: 2.0.0-9-SNAPSHOT*
+
+**Endpoints**: I use [Yaak](https://yaak.app/) to check/tests the endpoints, you can import it from [here](docs/yaak.xenforo.json)
 
 ## Bug Reporting
+
 You can create an issue here on GitHub to report a bug with the API or to suggest enhancements.
 
 ## Contributing
-If you want to contribute to the project, you must accept and follow our [Code Of Conduct](.github/CODE_OF_CONDUCT.md) and our [guides for contributing](.github/CONTRIBUTING.md).
-
-## Instalation
 
+If you want to contribute to the project, you must accept and follow our [Code Of Conduct](.github/CODE_OF_CONDUCT.md) and
+our [guides for contributing](.github/CONTRIBUTING.md).
 
 ## Usage & API Key
-You will need to enable API in your XenForo. You can use this [guide](https://xenforo.com/docs/dev/rest-api/).
 
+You will need to enable API in your XenForo. You can use this [guide](https://xenforo.com/docs/dev/rest-api/).
 
 ## Dependencies
+
 The XenAPI (Java) has the following dependencies:
+
 * [Google Gson library](https://mvnrepository.com/artifact/com.google.code.gson/gson)
 * [Project Lombok](https://projectlombok.org)
 * [Apache HttpClient](https://hc.apache.org)
+* [StaticLog](https://github.com/jupf/staticlog)
 
 ## License & Copyright
+
 XenAPI is licensed under [GNU LESSER GENERAL PUBLIC LICENSE Version 3](LICENSE.md).
 
-The logo and some parts of the PHP Code is property of [Contex](https://github.com/Contex/XenAPI).
+Some parts of the PHP Code is property of [Contex](https://github.com/Contex/XenAPI).
 
 Cadox8 updated the code and created the Java API.
 
 [Contex](https://github.com/Contex) © 2012-2014
 
-[Cadox8](https://cadox8.es) © 2018-2021
-
-## Donations
-Building an Open Source Project is hard. You have to invert time and resources. :money_with_wings: :money_with_wings:
+[Cadox8](https://cadox8.es) © 2018-2025
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_404.md b/docs/_404.md
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
diff --git a/docs/_navbar.md b/docs/_navbar.md
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
diff --git a/docs/actions/auth.md b/docs/actions/auth.md
diff --git a/docs/actions/me/me_get.md b/docs/actions/me/me_get.md
diff --git a/docs/api.md b/docs/api.md
diff --git a/docs/img/logo.png b/docs/img/logo.png
diff --git a/docs/img/logo_64.png b/docs/img/logo_64.png