Merge pull request #2 from xdev-software/develop

Release

Author: AB-xdev

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
-    <module name="standard-maven-template-demo" />
+    <module name="sessionize-java-client-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0 
+
+* Initial release
+* Supports Sessionize API ``v2`` and the following endpoints
+  * ``/view/All``
+  * ``/view/Speakers``
+  * ``/view/Sessions``

CONTRIBUTING.md

@@ -1,19 +1,18 @@
 ## Contributing
 
-We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components.
+We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request and anything that you build and share using our components.
 
-### Get in touch with the team
+### Communication channels
+* Communication is primarily done using issues.
+* If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
+* As a last resort measure or on otherwise important matter you may also [contact us directly](https://xdev.software/en/about-us/contact).
 
-Twitter: https://twitter.com/xdevsoftware 
-<br/>
-Mail: [email protected]
+### Ways to help
+* **Report bugs**<br/>Create an issue or send a pull request
+* **Send pull requests**<br/>If you want to contribute code, check out the development instructions below.
+  * However when contributing new features, please first discuss the change you wish to make via issue with the owners of this repository before making a change. Otherwise your work might be rejected and your effort was pointless.
 
-### Some ways to help:
-
-- **Report bugs**: File issues on GitHub.
-- **Send pull requests**: If you want to contribute code, check out the development instructions below.
-
-We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
+We also encourage you to read the [contribution instructions by GitHub](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
 
 ## Developing
 
@@ -26,18 +25,18 @@ You should have the following things installed:
 ### Recommended setup
 * Install ``IntelliJ`` (Community Edition is sufficient)
   * Install the following plugins:
-    * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields
+    * [Save Actions](https://plugins.jetbrains.com/plugin/22113) - Provides save actions, like running the formatter or adding ``final`` to fields
     * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
     * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
   * Import the project
   * Ensure that everything is encoded in ``UTF-8``
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/release.yml?branch=master)](https://github.com/xdev-software/standard-maven-template/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/sessionize-java-client/release.yml?branch=master)](https://github.com/xdev-software/sessionize-java-client/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/standard-maven-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/sessionize-java-client/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 XDEV Software 
+   Copyright 2023 XDEV Software 
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,13 +1,22 @@
-[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/standard-maven-template)](https://mvnrepository.com/artifact/com.xdev-software/standard-maven-template)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/checkBuild.yml?branch=develop)](https://github.com/xdev-software/standard-maven-template/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_standard-maven-template&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_standard-maven-template)
+[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/sessionize-java-client?logo=apache%20maven)](https://mvnrepository.com/artifact/com.xdev-software/sessionize-java-client)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/sessionize-java-client/checkBuild.yml?branch=develop)](https://github.com/xdev-software/sessionize-java-client/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_sessionize-java-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_sessionize-java-client)
 
-# standard-maven-template
+# <img src="https://sessionize.com/landing/images/brand/logo/sessionize-avatar.svg" height="22" /> [sessionize](https://sessionize.com/)-java-client
+Java client for the [Sessionize API](https://sessionize.com/playbook/api)
 
+This client [is generated](./sessionize-java-client/pom.xml) from an [``openapi.yml``](./openapi/openapi.yml) using [OpenAPI Generator](https://openapi-generator.tech/).
+
+Currently this client supports Sessionize API ``v2`` and the following endpoints
+  * ``/view/All``
+  * ``/view/Speakers``
+  * ``/view/Sessions``
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/standard-maven-template/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/sessionize-java-client/releases/latest#Installation)
 
+## Demo
+A minimal demo is also available [here](./sessionize-java-client-demo/src/main/java/software/xdev/Application.java).
 
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
@@ -16,4 +25,4 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/standard-maven-template/dependencies/)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/sessionize-java-client/dependencies/)

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/standard-maven-template/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/sessionize-java-client/security/advisories/new).

openapi/INFO.md

@@ -0,0 +1,7 @@
+This ``openapi.yml`` was written manually as sessionize fails to provide an API schema or something similar.
+
+The Java API Client can be generated using ``mvn clean compile -P openapi-generator`` inside [``sessionize-java-client``](../sessionize-java-client/).
+
+Helpful links:
+* https://jsonformatter.org/json-to-jsonschema
+* https://swagger.io/specification/