jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Release 2.35 (#5470)

Browse Source 
* open up API for plugins by removing internal
* use constants in entity column definition
* simplified entity management API
* bump packages
* allow installing assets and run database migrations independently
* bump to apidoc-bundle 5
* do not duplicate http method in API operationId
* new security entries in Open API definition
* changed API UI provider for Swagger to Stoplight, improved endpoint titles, hide internal endpoints
* deactivate swagger json endpoint
This commit is contained in:
Kevin Papst
2025-05-24 14:28:39 +02:00
committed by GitHub
parent 6e26a37c4d
commit 1e0fbf0b73
63 changed files with 518 additions and 529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/API/CustomerController.php
View File

@@ -52,7 +52,7 @@ final class CustomerController extends BaseApiController
}
/**
* Returns a collection of customers (which are visible to the user)
* Fetch collection of customers
*/
#[OA\Response(response: 200, description: 'Returns a collection of customers', content: new OA\JsonContent(type: 'array', items: new OA\Items(ref: '#/components/schemas/CustomerCollection')))]
#[Route(methods: ['GET'], path: '', name: 'get_customers')]
@@ -98,7 +98,7 @@ final class CustomerController extends BaseApiController
}
/**
* Returns one customer
* Fetch customer
*/
#[OA\Response(response: 200, description: 'Returns one customer entity', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))]
#[Route(methods: ['GET'], path: '/{id}', name: 'get_customer', requirements: ['id' => '\d+'])]
@@ -112,7 +112,7 @@ final class CustomerController extends BaseApiController
}
/**
* Creates a new customer
* Create customer
*/
#[OA\Post(description: 'Creates a new customer and returns it afterwards', responses: [new OA\Response(response: 200, description: 'Returns the new created customer', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))])]
#[OA\RequestBody(required: true, content: new OA\JsonContent(ref: '#/components/schemas/CustomerEditForm'))]
@@ -206,7 +206,7 @@ final class CustomerController extends BaseApiController
}
/**
* Sets the value of a meta-field for an existing customer
* Update customer custom-field
*/
#[IsGranted('edit', 'customer')]
#[OA\Response(response: 200, description: 'Sets the value of an existing/configured meta-field. You cannot create unknown meta-fields, if the given name is not a configured meta-field, this will return an exception.', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))]
@@ -237,7 +237,7 @@ final class CustomerController extends BaseApiController
}
/**
* Returns a collection of all rates for one customer
* Fetch all rates for one customer
*/
#[IsGranted('edit', 'customer')]
#[OA\Response(response: 200, description: 'Returns a collection of customer rate entities', content: new OA\JsonContent(type: 'array', items: new OA\Items(ref: '#/components/schemas/CustomerRate')))]
@@ -254,7 +254,7 @@ final class CustomerController extends BaseApiController
}
/**
* Deletes one rate for a customer
* Delete rate for customer
*/
#[IsGranted('edit', 'customer')]
#[OA\Delete(responses: [new OA\Response(response: 204, description: 'Returns no content: 204 on successful delete')])]
@@ -275,7 +275,7 @@ final class CustomerController extends BaseApiController
}
/**
* Adds a new rate to a customer
* Add rate for one customer
*/
#[IsGranted('edit', 'customer')]
#[OA\Post(responses: [new OA\Response(response: 200, description: 'Returns the new created rate', content: new OA\JsonContent(ref: '#/components/schemas/CustomerRate'))])]