Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/sched-java-client/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/sched-java-client/issues) or [closed](https://github.com/xdev-software/sched-java-client/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/sched-java-client/issues) or [closed](https://github.com/xdev-software/sched-java-client/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/sched-java-client/issues) or [closed](https://github.com/xdev-software/sched-java-client/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.run/Run Demo.run.xml

@@ -0,0 +1,42 @@
+# 1.2.2
+* Updated dependencies
+  * Updated to OpenAPI Generator 7.4
+
+# 1.2.1
+* ⚠️ GroupId changed from ``com.xdev-software`` to ``software.xdev``
+* Updated dependencies
+
+# 1.2.0
+* Add support for the ``/user/mod`` Sched API endpoint
+* Updated dependencies
+
+# 1.1.1
+* Removed unused dependency ``com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider``
+
+# 1.1.0
+* Add undocumented ``video_stream`` field for sessions.<br/>Affected endpoints are:
+  * ``/session/add``
+  * ``/session/mod``
+  * ``/session/export``
+
+# 1.0.2
+* Add all available fields to model returned by ``/user/list``
+* Updated dependencies
+
+# 1.0.1
+* Throw ``APIException`` instead ``ClassCastException`` when error is encountered #12
+* Updated dependencies
+
+# 1.0.0 
+
+* Initial release
+* Supports the following Sched API endpoints
+  * ``/session/add``
+  * ``/session/mod``
+  * ``/session/del``
+  * ``/session/list``
+  * ``/session/export``
+  * ``/user/list``
+  * ``/user/add``
+  * ``/role/add``
+  * ``/role/del``

CHANGELOG.md

@@ -34,10 +34,10 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/sched-java-client/release.yml?branch=master)](https://github.com/xdev-software/sched-java-client/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/sched-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

CONTRIBUTING.md

@@ -1,17 +1,83 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_template-placeholder&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_template-placeholder)
-[![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/template-placeholder/develop/openapi/openapi.yml)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/sched-java-client?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/sched-java-client)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/sched-java-client/check-build.yml?branch=develop)](https://github.com/xdev-software/sched-java-client/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_sched-java-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_sched-java-client)
+[![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/sched-java-client/develop/openapi/openapi.yml)
 
-# template-placeholder
+# <img src="https://i0.wp.com/sched.com/wp-content/uploads/2021/11/cropped-favicon.png?fit=28,28&ssl=1" height="28" /> [sched](https://sched.com/)-java-client
+Java client for the [Sched API](https://sched.com/api)
 
-This client [is generated](./template-placeholder/pom.xml) from an [``openapi.yml``](./openapi/openapi.yml) using [OpenAPI Generator](https://openapi-generator.tech/).
+> [!IMPORTANT]
+> An API-Key is required for using the API.<br/>
+> You can get a key - if you have a payed plan - at https://insertYourConferenceHERE.sched.com/editor/exports/api
+
+This client [is generated](./sched-java-client/pom.xml) from an [``openapi.yml``](./openapi/openapi.yml) using [OpenAPI Generator](https://openapi-generator.tech/).
+
+> [!NOTE]
+> The client may look/behave odd because the Sched API violates some well established standards.
+> <details><summary>List of violations</summary>
+> 
+> * Errors are (partially) returned with status code [``200 (OK)``](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200)
+> * ``text/html`` is used as [content type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#important_mime_types_for_web_developers) for plain text (should be ``text/plain``)
+> * ``boolean`` is handled as ``"Y"``/``"N"`` or as ``"0"``/``"1"``
+> * Numbers are (partially) handled as string
+> * Dates are not formatted according to [``RFC 3339``](https://datatracker.ietf.org/doc/html/rfc3339)
+> * Sometimes unix timestamps are used instead of dates
+> * Arrays are not handled as arrays and instead comma separated lists are used
+> * Some fields are not returned when using the 'Read-Only API Key' e.g. the ``id`` of users
+> * Incorrect [HTTP Request methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) are used. E.g. ``GET`` for  ``/api/session/del`` (should be ``DELETE``)
+> * Some endpoints don't return JSON by default
+> 
+> </details>
+
+#### API Support Status
+
+<details><summary>Supported endpoints</summary>
+
+* Site
+  * Sync
+* Session
+  * Add ✔️
+  * Modify ✔️
+  * Delete ✔️
+  * List ✔️
+  * Export ✔️
+  * Seats
+  * Count
+* User
+  * List ✔️
+  * Add ✔️
+  * Modify ✔️
+  * Get
+  * Active
+  * Avatar
+  * Sessions
+* Auth¹
+  * Login
+* Tag
+  * Add
+  * Modify
+  * Delete
+  * List
+* Going¹
+  * Add
+  * Delete
+  * Schedule
+  * All
+* Assets
+  * Banner
+* Role
+  * Add ✔️
+  * Delete ✔️
+  * Export
+
+¹ Handles `User Session Key`
+</details>
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/sched-java-client/releases/latest#Installation)
 
 ## Demo
-A minimal demo is also available [here](./template-placeholder-demo/src/main/java/software/xdev/Application.java).
+A minimal demo is also available [here](./sched-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).
@@ -20,4 +86,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/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/sched-java-client/dependencies)

README.md

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

SECURITY.md

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