Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HL API integration #101

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

HL API integration #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
142cf1b
Bump actions/checkout from 3 to 4
dependabot[bot] Oct 1, 2023
a77fc34
start new api integration
cconard96 Oct 12, 2023
5d9ce12
fixes
cconard96 Oct 13, 2023
8724426
schema fixes
cconard96 Oct 14, 2023
d4e1b87
wrong parent schema
cconard96 Oct 14, 2023
5f04d98
rename props
cconard96 Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
run: |
echo "tag_name=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
- name: "Checkout"
uses: "actions/checkout@v3"
uses: "actions/checkout@v4"
- name: "Build package"
id: "build-package"
uses: "glpi-project/tools/github-actions/[email protected]"
Expand Down
155 changes: 155 additions & 0 deletions hook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
* -------------------------------------------------------------------------
*/

use Glpi\Api\HL\Controller\AbstractController;
use Glpi\Api\HL\Doc\Schema;

/**
* Plugin install process
*
Expand Down Expand Up @@ -135,3 +138,155 @@ function plugin_credit_get_datas(NotificationTargetTicket $target) {
];
}
}

function plugin_credit_redefine_api_schemas(array $data): array {
// Handle modifications to existing schemas
foreach ($data['schemas'] as &$schema) {
if (!isset($schema['x-itemtype'])) {
continue;
}
if ($schema['x-itemtype'] === Entity::class) {
$schema['properties']['credits'] = [
'type' => Schema::TYPE_ARRAY,
'items' => [
'type' => Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditEntity::class,
'x-full-schema' => 'Credit',
'x-join' => [
'table' => PluginCreditEntity::getTable(),
'fkey' => 'id',
'field' => 'entities_id',
'primary-property' => 'id'
],
'properties' => [
'id' => [
'type' => Schema::TYPE_INTEGER,
'format' => Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'name' => ['type' => Schema::TYPE_STRING],
'is_recursive' => ['type' => Schema::TYPE_BOOLEAN],
'is_active' => ['type' => Schema::TYPE_BOOLEAN],
'type' => AbstractController::getDropdownTypeSchema(class: PluginCreditType::class, full_schema: 'PluginCreditType'),
'date_begin' => [
'type' => Schema::TYPE_STRING,
'format' => Schema::FORMAT_STRING_DATE,
'x-field' => 'begin_date'
],
'date_end' => [
'type' => Schema::TYPE_STRING,
'format' => Schema::FORMAT_STRING_DATE,
'x-field' => 'end_date'
],
'quantity' => ['type' => Schema::TYPE_INTEGER],
'over_consumption_allowed' => [
'type' => Schema::TYPE_BOOLEAN,
'x-field' => 'overconsumption_allowed'
],
]
]
];
$schema['properties']['credits_config'] = [
'type' => Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditEntityConfig::class,
'x-full-schema' => 'CreditEntityConfig',
'x-join' => [
'table' => PluginCreditEntityConfig::getTable(),
'fkey' => 'id',
'field' => 'entities_id',
'primary-property' => 'id'
],
'properties' => [
'id' => [
'type' => Schema::TYPE_INTEGER,
'format' => Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'consume_for_followups' => ['type' => Schema::TYPE_BOOLEAN, 'x-field' => 'consume_voucher_for_followups'],
'consume_for_tasks' => ['type' => Schema::TYPE_BOOLEAN, 'x-field' => 'consume_voucher_for_tasks'],
'consume_for_solutions' => ['type' => Schema::TYPE_BOOLEAN, 'x-field' => 'consume_voucher_for_solutions'],
'followups_credit' => AbstractController::getDropdownTypeSchema(
class: PluginCreditEntity::class,
field: 'plugin_credit_entities_id_followups',
full_schema: 'Credit'
),
'tasks_credit' => AbstractController::getDropdownTypeSchema(
class: PluginCreditEntity::class,
field: 'plugin_credit_entities_id_tasks',
full_schema: 'Credit'
),
'solutions_credit' => AbstractController::getDropdownTypeSchema(
class: PluginCreditEntity::class,
field: 'plugin_credit_entities_id_solutions',
full_schema: 'Credit'
),
]
];
} else if ($schema['x-itemtype'] === Ticket::class) {
$schema['properties']['credits_consumed'] = [
'type' => Schema::TYPE_ARRAY,
'items' => [
'type' => Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditTicket::class,
'x-full-schema' => 'CreditConsumption',
'x-join' => [
'table' => PluginCreditTicket::getTable(),
'fkey' => 'id',
'field' => 'tickets_id',
'primary-property' => 'id'
],
'properties' => [
'id' => [
'type' => Schema::TYPE_INTEGER,
'format' => Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'credit' => [
'type' => Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditTicket::class,
'x-full-schema' => 'Credit',
'properties' => [
'id' => [
'type' => Schema::TYPE_INTEGER,
'format' => Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'name' => ['type' => Schema::TYPE_STRING],
]
],
'date_creation' => [
'type' => Schema::TYPE_STRING,
'format' => Schema::FORMAT_STRING_DATE_TIME,
'x-readonly' => true,
],
'consumed' => ['type' => Schema::TYPE_INTEGER],
'user' => AbstractController::getDropdownTypeSchema(class: User::class, full_schema: 'User'),
]
]
];
$schema['properties']['credits_config'] = [
'type' => Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditTicketConfig::class,
'x-full-schema' => 'CreditTicketConfig',
'x-join' => [
'table' => PluginCreditTicketConfig::getTable(),
'fkey' => 'id',
'field' => 'tickets_id',
'primary-property' => 'id'
],
'properties' => [
'id' => [
'type' => Schema::TYPE_INTEGER,
'format' => Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'followups_credit' => AbstractController::getDropdownTypeSchema(class: PluginCreditEntity::class, field: 'plugin_credit_entities_id_followups', full_schema: 'Credit'),
'tasks_credit' => AbstractController::getDropdownTypeSchema(class: PluginCreditEntity::class, field: 'plugin_credit_entities_id_tasks', full_schema: 'Credit'),
'solutions_credit' => AbstractController::getDropdownTypeSchema(class: PluginCreditEntity::class, field: 'plugin_credit_entities_id_solutions', full_schema: 'Credit'),
]
];
}
}

return $data;
}
182 changes: 182 additions & 0 deletions inc/apicontroller.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<?php

/**
* -------------------------------------------------------------------------
* Credit plugin for GLPI
* -------------------------------------------------------------------------
*
* LICENSE
*
* This file is part of Credit.
*
* Credit is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Credit is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Credit. If not, see <http://www.gnu.org/licenses/>.
* -------------------------------------------------------------------------
* @author François Legastelois
* @copyright Copyright (C) 2017-2023 by Credit plugin team.
* @license GPLv3 https://www.gnu.org/licenses/gpl-3.0.html
* @link https://github.com/pluginsGLPI/credit
* -------------------------------------------------------------------------
*/

use Glpi\Api\HL\Controller\AbstractController;
use Glpi\Api\HL\Doc as Doc;
use Glpi\Api\HL\Route;
use Glpi\Http\Request;
use Glpi\Http\Response;

#[Route(path: '/Credit', priority: 1, tags: ['Credit'])]
final class PluginCreditApicontroller extends AbstractController
{
protected static function getRawKnownSchemas(): array
{
$schemas = [];
$schemas['Credit'] = [
'type' => Doc\Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditEntity::class,
'properties' => [
'id' => [
'type' => Doc\Schema::TYPE_INTEGER,
'format' => Doc\Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'name' => ['type' => Doc\Schema::TYPE_STRING],
'entity' => AbstractController::getDropdownTypeSchema(class: Entity::class, full_schema: 'Entity'),
'is_recursive' => ['type' => Doc\Schema::TYPE_BOOLEAN],
'is_active' => ['type' => Doc\Schema::TYPE_BOOLEAN],
'type' => AbstractController::getDropdownTypeSchema(class: PluginCreditType::class, full_schema: 'PluginCreditType'),
'date_begin' => [
'type' => Doc\Schema::TYPE_STRING,
'format' => Doc\Schema::FORMAT_STRING_DATE,
'x-field' => 'begin_date'
],
'date_end' => [
'type' => Doc\Schema::TYPE_STRING,
'format' => Doc\Schema::FORMAT_STRING_DATE,
'x-field' => 'end_date'
],
'quantity' => ['type' => Doc\Schema::TYPE_INTEGER],
'over_consumption_allowed' => [
'type' => Doc\Schema::TYPE_BOOLEAN,
'x-field' => 'overconsumption_allowed'
],
]
];
$schemas['CreditType'] = [
'type' => Doc\Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditEntity::class,
'properties' => [
'id' => [
'type' => Doc\Schema::TYPE_INTEGER,
'format' => Doc\Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'name' => ['type' => Doc\Schema::TYPE_STRING],
'comment' => ['type' => Doc\Schema::TYPE_STRING],
'entity' => AbstractController::getDropdownTypeSchema(class: Entity::class, full_schema: 'Entity'),
'is_recursive' => ['type' => Doc\Schema::TYPE_BOOLEAN],
'parent' => AbstractController::getDropdownTypeSchema(class: PluginCreditType::class, full_schema: 'CreditType'),
'level' => ['type' => Doc\Schema::TYPE_INTEGER],
'date_creation' => [
'type' => Doc\Schema::TYPE_STRING,
'format' => Doc\Schema::FORMAT_STRING_DATE_TIME,
'x-readonly' => true,
],
'date_mod' => [
'type' => Doc\Schema::TYPE_STRING,
'format' => Doc\Schema::FORMAT_STRING_DATE_TIME,
'x-readonly' => true,
],
]
];
$schemas['CreditConsumption'] = [
'type' => Doc\Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditEntity::class,
'properties' => [
'id' => [
'type' => Doc\Schema::TYPE_INTEGER,
'format' => Doc\Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'ticket' => AbstractController::getDropdownTypeSchema(class: Ticket::class, full_schema: 'Ticket'),
'credit' => [
'type' => Doc\Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditTicket::class,
'x-full-schema' => 'Credit',
'properties' => [
'id' => [
'type' => Doc\Schema::TYPE_INTEGER,
'format' => Doc\Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'name' => ['type' => Doc\Schema::TYPE_STRING],
]
],
'date_creation' => [
'type' => Doc\Schema::TYPE_STRING,
'format' => Doc\Schema::FORMAT_STRING_DATE_TIME,
'x-readonly' => true,
],
'consumed' => ['type' => Doc\Schema::TYPE_INTEGER],
'user' => AbstractController::getDropdownTypeSchema(class: User::class, full_schema: 'User'),
]
];
$schemas['CreditEntityConfig'] = [
'type' => Doc\Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditEntityConfig::class,
'properties' => [
'id' => [
'type' => Doc\Schema::TYPE_INTEGER,
'format' => Doc\Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'entity' => AbstractController::getDropdownTypeSchema(class: Entity::class, full_schema: 'Entity'),
'consume_for_followups' => ['type' => Doc\Schema::TYPE_BOOLEAN, 'x-field' => 'consume_voucher_for_followups'],
'consume_for_tasks' => ['type' => Doc\Schema::TYPE_BOOLEAN, 'x-field' => 'consume_voucher_for_tasks'],
'consume_for_solutions' => ['type' => Doc\Schema::TYPE_BOOLEAN, 'x-field' => 'consume_voucher_for_solutions'],
'followups_credit' => AbstractController::getDropdownTypeSchema(
class: PluginCreditEntity::class,
field: 'plugin_credit_entities_id_followups',
full_schema: 'Credit'
),
'tasks_credit' => AbstractController::getDropdownTypeSchema(
class: PluginCreditEntity::class,
field: 'plugin_credit_entities_id_tasks',
full_schema: 'Credit'
),
'solutions_credit' => AbstractController::getDropdownTypeSchema(
class: PluginCreditEntity::class,
field: 'plugin_credit_entities_id_solutions',
full_schema: 'Credit'
),
]
];
$schemas['CreditTicketConfig'] = [
'type' => Doc\Schema::TYPE_OBJECT,
'x-itemtype' => PluginCreditTicketConfig::class,
'properties' => [
'id' => [
'type' => Doc\Schema::TYPE_INTEGER,
'format' => Doc\Schema::FORMAT_INTEGER_INT64,
'x-readonly' => true,
],
'ticket' => AbstractController::getDropdownTypeSchema(class: Ticket::class, full_schema: 'Ticket'),
'followups_credit' => AbstractController::getDropdownTypeSchema(class: PluginCreditEntity::class, full_schema: 'Credit'),
'tasks_credit' => AbstractController::getDropdownTypeSchema(class: PluginCreditEntity::class, full_schema: 'Credit'),
'solutions_credit' => AbstractController::getDropdownTypeSchema(class: PluginCreditEntity::class, full_schema: 'Credit'),
]
];
return $schemas;
}
}

Loading