diff --git a/README.md b/README.md index c4fb186..81103bf 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,48 @@ - - -[![Version](https://img.shields.io/badge/version-01.00.00-blue.svg?logo=v&logoColor=white)](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/stable) -[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green.svg?logo=gnu&logoColor=white)](LICENSE) -[![PHP](https://img.shields.io/badge/PHP-8.1%2B-777BB4.svg?logo=php&logoColor=white)](https://www.php.net) - # MokoDPCalendarAPI -A Joomla 5/6 Web Services plugin that exposes DPCalendar events, calendars, and locations through the Joomla REST API (`/api/index.php/v1`). +Joomla Web Services plugin exposing DPCalendar events, calendars, and locations via REST API -Enables AI assistants (via joomla-api-mcp) and external integrations to create, read, update, and delete DPCalendar content programmatically. +![Language](https://img.shields.io/badge/PHP-777BB4?style=flat-square&logo=php&logoColor=white) ![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green?style=flat-square) ![Wiki](https://img.shields.io/badge/wiki-MokoDPCalendarAPI-blue?style=flat-square) -## Table of Contents -- [Background](#background) -- [Install](#install) -- [API Endpoints](#api-endpoints) -- [Contributing](#contributing) -- [License](#license) +Joomla Web Services plugin exposing DPCalendar events, calendars, and locations via REST API -## Background +| Field | Value | +|---|---| +| **Language** | PHP | +| **License** | GPL-3.0-or-later | +| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI) | -DPCalendar does not ship with a Web Services plugin. This plugin fills that gap by registering REST API routes for: +--- -- **Events** — CRUD with date filtering, category scoping, and recurrence support -- **Calendars** — List and manage calendar categories -- **Locations** — List and manage event locations +## Guides -## Install +| Page | Description | +|---|---| +| [INSTALLATION](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/wiki/INSTALLATION) | - Joomla 5.x or 6.x | -1. Download the latest release ZIP -2. **System > Install > Extensions** in Joomla admin -3. Upload and install the ZIP -4. **System > Manage > Plugins** — enable **Web Services - DPCalendar** +--- -## API Endpoints +> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home) -All endpoints require `Authorization: Bearer `. +--- -### Events -| Method | Endpoint | Description | -|--------|----------|-------------| -| GET | `/v1/dpcalendar/events` | List events | -| GET | `/v1/dpcalendar/events/{id}` | Get event | -| POST | `/v1/dpcalendar/events` | Create event | -| PATCH | `/v1/dpcalendar/events/{id}` | Update event | -| DELETE | `/v1/dpcalendar/events/{id}` | Delete event | -### Calendars +--- -| Method | Endpoint | Description | -|--------|----------|-------------| -| GET | `/v1/dpcalendar/calendars` | List calendars | -| GET | `/v1/dpcalendar/calendars/{id}` | Get calendar | +## Documentation -### Locations +Full documentation is available on the [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/wiki). -| Method | Endpoint | Description | -|--------|----------|-------------| -| GET | `/v1/dpcalendar/locations` | List locations | -| GET | `/v1/dpcalendar/locations/{id}` | Get location | -| POST | `/v1/dpcalendar/locations` | Create location | -| PATCH | `/v1/dpcalendar/locations/{id}` | Update location | -| DELETE | `/v1/dpcalendar/locations/{id}` | Delete location | +## Contributing + +See the wiki for development guidelines and contribution instructions. ## License -GPL-3.0-or-later — see [LICENSE](LICENSE). +This project is licensed under the GNU General Public License v3.0 or later -- see the [LICENSE](LICENSE) file. -Copyright (C) 2026 Moko Consulting +--- -## Maintainers - -[@jmiller](https://git.mokoconsulting.tech/jmiller) - -## Revision History - -| Date | Version | Author | Notes | -| --- | --- | --- | --- | -| 2026-04-26 | 1.0.0 | jmiller | Initial Web Services plugin for DPCalendar | +*[Moko Consulting](https://mokoconsulting.tech) -- [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)* diff --git a/src/mokodpcalendarapi.xml b/src/mokodpcalendarapi.xml index ee208b5..cfa529c 100644 --- a/src/mokodpcalendarapi.xml +++ b/src/mokodpcalendarapi.xml @@ -8,12 +8,12 @@ Moko Web Services - DPCalendar API Moko Consulting - 2026-05-04 + 2026-05-10 Copyright (C) 2026 Moko Consulting GPL-3.0-or-later hello@mokoconsulting.tech https://mokoconsulting.tech - 03.01.00 + 03.02.00 Exposes DPCalendar events, calendars, and locations via the Joomla Web Services API Moko\Plugin\WebServices\MokoDPCalendarAPI diff --git a/updates.xml b/updates.xml index f582a42..b2256fa 100644 --- a/updates.xml +++ b/updates.xml @@ -1,23 +1,96 @@ - Web Services - DPCalendar API - Web Services - DPCalendar API update + Moko Web Services - DPCalendar API + Moko Web Services - DPCalendar API update mokodpcalendarapi plugin - 03.01.00 + 03.02.00 + site + webservices + development + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/stable + + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/download/stable/-03.02.00.zip + + 652b87468d39eb4a513b6b0aae3a563abf7662f0ee3b837b724ee3b6e19a08fb + + Moko Consulting + https://mokoconsulting.tech + + + Moko Web Services - DPCalendar API + Moko Web Services - DPCalendar API update + mokodpcalendarapi + plugin + 03.02.00 + site + webservices + alpha + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/stable + + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/download/stable/-03.02.00.zip + + 652b87468d39eb4a513b6b0aae3a563abf7662f0ee3b837b724ee3b6e19a08fb + + Moko Consulting + https://mokoconsulting.tech + + + Moko Web Services - DPCalendar API + Moko Web Services - DPCalendar API update + mokodpcalendarapi + plugin + 03.02.00 + site + webservices + beta + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/stable + + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/download/stable/-03.02.00.zip + + 652b87468d39eb4a513b6b0aae3a563abf7662f0ee3b837b724ee3b6e19a08fb + + Moko Consulting + https://mokoconsulting.tech + + + Moko Web Services - DPCalendar API + Moko Web Services - DPCalendar API update + mokodpcalendarapi + plugin + 03.02.00 + site + webservices + rc + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/stable + + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/download/stable/-03.02.00.zip + + 652b87468d39eb4a513b6b0aae3a563abf7662f0ee3b837b724ee3b6e19a08fb + + Moko Consulting + https://mokoconsulting.tech + + + Moko Web Services - DPCalendar API + Moko Web Services - DPCalendar API update + mokodpcalendarapi + plugin + 03.02.00 site webservices stable - https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/v03.01.00 + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/tag/stable - https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/download/v03.01.00/mokodpcalendarapi-03.01.00.zip + https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI/releases/download/stable/-03.02.00.zip + 652b87468d39eb4a513b6b0aae3a563abf7662f0ee3b837b724ee3b6e19a08fb Moko Consulting https://mokoconsulting.tech