mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-25 11:18:51 +02:00
Added first API endpoint
This commit is contained in:
parent
a43ee52086
commit
6d3b0261b3
14 changed files with 599 additions and 22 deletions
0
src/ApiResource/.gitignore
vendored
Normal file
0
src/ApiResource/.gitignore
vendored
Normal file
63
src/ApiResource/PartDBInfo.php
Normal file
63
src/ApiResource/PartDBInfo.php
Normal file
|
@ -0,0 +1,63 @@
|
|||
<?php
|
||||
/*
|
||||
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||
*
|
||||
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program 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 Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
|
||||
namespace App\ApiResource;
|
||||
|
||||
use ApiPlatform\Metadata\ApiResource;
|
||||
use ApiPlatform\Metadata\Get;
|
||||
use App\State\PartDBInfoProvider;
|
||||
|
||||
/**
|
||||
* This class is used to provide various information about the system.
|
||||
*/
|
||||
#[ApiResource(
|
||||
uriTemplate: '/info',
|
||||
description: 'Basic information about Part-DB like version, title, etc.',
|
||||
operations: [new Get()],
|
||||
provider: PartDBInfoProvider::class
|
||||
)]
|
||||
class PartDBInfo
|
||||
{
|
||||
public function __construct(
|
||||
/** The installed Part-DB version */
|
||||
public readonly string $version,
|
||||
/** The Git branch name of the Part-DB version (or null, if not installed via git) */
|
||||
public readonly string|null $git_branch,
|
||||
/** The Git branch commit of the Part-DB version (or null, if not installed via git) */
|
||||
public readonly string|null $git_commit,
|
||||
/** The name of this Part-DB instance */
|
||||
public readonly string $title,
|
||||
/** The banner, shown on homepage (markdown encoded) */
|
||||
public readonly string $banner,
|
||||
/** The configured default URI for Part-DB */
|
||||
public readonly string $default_uri,
|
||||
/** The global timezone of this Part-DB */
|
||||
public readonly string $global_timezone,
|
||||
/** The base currency of Part-DB, used as internal representation of monetary values */
|
||||
public readonly string $base_currency,
|
||||
/** The configured default language of Part-DB */
|
||||
public readonly string $global_locale,
|
||||
) {
|
||||
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue