github-mirror/grocy
1
0
Fork 0
mirror of https://github.com/grocy/grocy.git synced 2026-03-30 09:39:26 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Replace generic object api in openapi schema with specific ones

Browse Source 
Change OpenApiController so it copies /objects/{entity} path for each
entity type ant removes {entity} parameter replacing it with a antity
name being path of the path.

Instead of a anyOf return type containing all possible entities each
endpoint has a type specific for this entity. Note: only for entities
that already had a schema defined for the return value.
This commit is contained in:
Jan Karwowski 2023-12-11 20:09:31 +01:00
parent 38eaaa6bc1
commit 6599da09e7
2 changed files with 62 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
controllers/OpenApiController.php
View File

@ -100,6 +100,68 @@ class OpenApiController extends BaseApiController
array_push($spec->components->schemas->ExposedEntity_NotIncludingNotListable->enum, $value);
}
}
$entity_types = array(
"products" => "Product",
"chores" => "Chore",
"product_barcodes" => "ProductBarcode",
"batteries" => "Battery",
"locations" => "Location",
"quantity_units" => "QuantityUnit",
// "quantity_unit_conversions" => ,
"shopping_list" => "ShoppingListItem",
// "shopping_lists" => ,
"shopping_locations" => "ShoppingLocation",
// "recipes" => ,
// "recipes_pos",
// "recipes_nestings",
"tasks" => "Task",
"task_categories" => "TaskCategory",
// "product_groups",
//"equipment",
"api_keys" => "ApiKey",
//"userfields",
//"userentities",
//"userobjects",
//"meal_plan",
"stock_log" => "StockLogEntry",
"stock" => "StockEntry",
/// "stock_current_locations" => ,
"chores_log" => "ChoreLogEntry"
//"meal_plan_sections",
//"products_last_purchased",
//"products_average_price",
//"quantity_unit_conversions_resolved",
//"recipes_pos_resolved"
);
// non-generic entity api
foreach(array_unique(array_merge($spec->components->schemas->ExposedEntity_NotIncludingNotListable->enum,
$spec->components->schemas->ExposedEntity_NotIncludingNotEditable->enum)) as $value) {
$listObjectsPath = unserialize(serialize(clone $spec->paths->{"/objects/{entity}"}));
$type = null;
if(array_key_exists((string)$value, $entity_types)) {
$type = (object) array('$ref' => "#/components/schemas/" . $entity_types[$value]);
} else {
$type = (object) array("type" => "object");
}
$listObjectsPath->get->responses->{"200"}->content->
{"application/json"}->schema->items = $type;
$listObjectsPath->post->requestBody->content->
{"application/json"}->schema = $type;
if(!in_array($value, $spec->components->schemas->ExposedEntity_NotIncludingNotListable->enum)) {
unset($listObjectsPath->get);
}
if(!in_array($value, $spec->components->schemas->ExposedEntity_NotIncludingNotEditable->enum)) {
unset($listObjectsPath->post);
}
// TODO: update summary
$spec->paths->{"/objects/" . $value} = $listObjectsPath;
}
unset($spec->paths->{"/objects/{entity}"});
sort($spec->components->schemas->ExposedEntity_NotIncludingNotListable->enum);
return $this->ApiResponse($response, $spec);

20
grocy.openapi.json
View File

@ -247,15 +247,6 @@
"Generic entity interactions"
],
"parameters": [
{
"in": "path",
"name": "entity",
"required": true,
"description": "A valid entity name",
"schema": {
"$ref": "#/components/schemas/ExposedEntity_NotIncludingNotListable"
}
},
{
"$ref": "#/components/parameters/query"
},
@ -335,17 +326,6 @@
"tags": [
"Generic entity interactions"
],
"parameters": [
{
"in": "path",
"name": "entity",
"required": true,
"description": "A valid entity name",
"schema": {
"$ref": "#/components/schemas/ExposedEntity_NotIncludingNotEditable"
}
}
],
"requestBody": {
"description": "A valid entity object of the entity specified in parameter *entity*",
"required": true,