Mirrors/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-09 20:52:56 +01:00
Code Issues Releases Activity

Improved Swagger annotations

Browse Source
This commit is contained in:
Hillel Coren 2016-12-29 18:17:17 +02:00
parent fc528163d3
commit 75900c296e
9 changed files with 247 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
app/Http/Controllers/DocumentAPIController.php
View File

@ -33,7 +33,20 @@ class DocumentAPIController extends BaseAPIController
}
/**
* @return \Illuminate\Http\Response
* @SWG\Get(
* path="/documents",
* summary="List of document",
* tags={"document"},
* @SWG\Response(
* response=200,
* description="A list with documents",
* @SWG\Schema(type="array", @SWG\Items(ref="#/definitions/Document"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function index()
{
@ -59,9 +72,25 @@ class DocumentAPIController extends BaseAPIController
}
/**
* @param CreateDocumentRequest $request
*
* @return \Illuminate\Http\Response
* @SWG\Post(
* path="/documents",
* tags={"document"},
* summary="Create a document",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/Document")
* ),
* @SWG\Response(
* response=200,
* description="New document",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Document"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function store(CreateDocumentRequest $request)
{

59
app/Http/Controllers/ExpenseCategoryApiController.php
View File

@ -9,7 +9,6 @@ use App\Http\Requests\CreateExpenseCategoryRequest;
use App\Http\Requests\UpdateExpenseCategoryRequest;
use App\Ninja\Repositories\ExpenseCategoryRepository;
class ExpenseCategoryApiController extends BaseAPIController
{
protected $categoryRepo;
@ -24,18 +23,60 @@ class ExpenseCategoryApiController extends BaseAPIController
$this->categoryService = $categoryService;
}
/**
* @SWG\Post(
* path="/expense_categories",
* tags={"expense_category"},
* summary="Create an expense category",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/ExpenseCategory")
* ),
* @SWG\Response(
* response=200,
* description="New expense category",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/ExpenseCategory"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function store(CreateExpenseCategoryRequest $request)
{
$category = $this->categoryRepo->save($request->input());
return $this->itemResponse($category);
}
/**
* @SWG\Put(
* path="/expense_categories/{expense_category_id}",
* tags={"expense_category"},
* summary="Update an expense category",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/ExpenseCategory")
* ),
* @SWG\Response(
* response=200,
* description="Update expense category",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/ExpenseCategory"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function update(UpdateExpenseCategoryRequest $request)
{
$category = $this->categoryRepo->save($request->input(), $request->entity());
return $this->itemResponse($category);
}
public function store(CreateExpenseCategoryRequest $request)
{
$category = $this->categoryRepo->save($request->input());
return $this->itemResponse($category);
}
}

58
app/Http/Controllers/ProductApiController.php
View File

@ -33,7 +33,20 @@ class ProductApiController extends BaseAPIController
}
/**
* @return \Illuminate\Http\Response
* @SWG\Get(
* path="/products",
* summary="List of products",
* tags={"product"},
* @SWG\Response(
* response=200,
* description="A list with products",
* @SWG\Schema(type="array", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function index()
{
@ -45,8 +58,25 @@ class ProductApiController extends BaseAPIController
}
/**
* @param CreateProductRequest $request
* @return \Illuminate\Http\Response
* @SWG\Post(
* path="/products",
* tags={"product"},
* summary="Create a product",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/Product")
* ),
* @SWG\Response(
* response=200,
* description="New product",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function store(CreateProductRequest $request)
{
@ -56,9 +86,25 @@ class ProductApiController extends BaseAPIController
}
/**
* @param UpdateProductRequest $request
* @param $publicId
* @return \Illuminate\Http\Response
* @SWG\Put(
* path="/products/{product_id}",
* tags={"product"},
* summary="Update a product",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/Product")
* ),
* @SWG\Response(
* response=200,
* description="Update product",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function update(UpdateProductRequest $request, $publicId)
{

59
app/Http/Controllers/TaxRateApiController.php
View File

@ -28,6 +28,22 @@ class TaxRateApiController extends BaseAPIController
$this->taxRateRepo = $taxRateRepo;
}
/**
* @SWG\Get(
* path="/tax_rates",
* summary="List of tax rates",
* tags={"tax_rate"},
* @SWG\Response(
* response=200,
* description="A list with tax rates",
* @SWG\Schema(type="array", @SWG\Items(ref="#/definitions/TaxRate"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function index()
{
$taxRates = TaxRate::scope()
@ -37,6 +53,27 @@ class TaxRateApiController extends BaseAPIController
return $this->listResponse($taxRates);
}
/**
* @SWG\Post(
* path="/tax_rates",
* tags={"tax_rate"},
* summary="Create a tax rate",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/TaxRate")
* ),
* @SWG\Response(
* response=200,
* description="New tax rate",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/TaxRate"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function store(CreateTaxRateRequest $request)
{
$taxRate = $this->taxRateRepo->save($request->input());
@ -45,9 +82,25 @@ class TaxRateApiController extends BaseAPIController
}
/**
* @param UpdateTaxRateRequest $request
* @param $publicId
* @return \Illuminate\Http\Response
* @SWG\Put(
* path="/tax_rates/{tax_rate_id}",
* tags={"tax_rate"},
* summary="Update a tax rate",
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/TaxRate")
* ),
* @SWG\Response(
* response=200,
* description="Update tax rate",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/TaxRate"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function update(UpdateTaxRateRequest $request, $publicId)
{

11
app/Ninja/Transformers/DocumentTransformer.php
View File

@ -3,14 +3,19 @@
use App\Models\Document;
/**
* Class DocumentTransformer
* @SWG\Definition(definition="Document", @SWG\Xml(name="Document"))
*/
class DocumentTransformer extends EntityTransformer
{
/**
* @param Document $document
* @return array
* @SWG\Property(property="id", type="integer", example=1, readOnly=true)
* @SWG\Property(property="name", type="string", example="Test")
* @SWG\Property(property="type", type="string", example="CSV")
* @SWG\Property(property="invoice_id", type="integer", example=1)
* @SWG\Property(property="updated_at", type="timestamp", example=1451160233, readOnly=true)
* @SWG\Property(property="archived_at", type="timestamp", example=1451160233, readOnly=true)
*/
public function transform(Document $document)
{
return array_merge($this->getDefaults($document), [

11
app/Ninja/Transformers/ExpenseCategoryTransformer.php
View File

@ -2,9 +2,20 @@
use App\Models\ExpenseCategory;
/**
* @SWG\Definition(definition="ExpenseCategory", @SWG\Xml(name="ExpenseCategory"))
*/
class ExpenseCategoryTransformer extends EntityTransformer
{
/**
* @SWG\Property(property="id", type="integer", example=1, readOnly=true)
* @SWG\Property(property="name", type="string", example="Sample")
* @SWG\Property(property="updated_at", type="timestamp", example=1451160233, readOnly=true)
* @SWG\Property(property="archived_at", type="timestamp", example=1451160233, readOnly=true)
*/
public function transform(ExpenseCategory $expenseCategory)
{
return array_merge($this->getDefaults($expenseCategory), [

15
app/Ninja/Transformers/ProductTransformer.php
View File

@ -2,8 +2,23 @@
use App\Models\Product;
/**
* @SWG\Definition(definition="Product", @SWG\Xml(name="Product"))
*/
class ProductTransformer extends EntityTransformer
{
/**
* @SWG\Property(property="id", type="integer", example=1, readOnly=true)
* @SWG\Property(property="product_key", type="string", example="Item")
* @SWG\Property(property="notes", type="string", example="Notes...")
* @SWG\Property(property="cost", type="float", example=10.00)
* @SWG\Property(property="qty", type="float", example=1)
* @SWG\Property(property="default_tax_rate_id", type="integer", example=1)
* @SWG\Property(property="updated_at", type="timestamp", example=1451160233, readOnly=true)
* @SWG\Property(property="archived_at", type="timestamp", example=1451160233, readOnly=true)
*/
public function transform(Product $product)
{
return array_merge($this->getDefaults($product), [

13
app/Ninja/Transformers/ProjectTransformer.php
View File

@ -2,8 +2,21 @@
use App\Models\Project;
/**
* @SWG\Definition(definition="Project", @SWG\Xml(name="Project"))
*/
class ProjectTransformer extends EntityTransformer
{
/**
* @SWG\Property(property="id", type="integer", example=1, readOnly=true)
* @SWG\Property(property="name", type="string", example="Sample")
* @SWG\Property(property="client_id", type="integer", example=1)
* @SWG\Property(property="updated_at", type="timestamp", example=1451160233, readOnly=true)
* @SWG\Property(property="archived_at", type="timestamp", example=1451160233, readOnly=true)
* @SWG\Property(property="is_deleted", type="boolean", example=false, readOnly=true)
*/
public function transform(Project $project)
{
return array_merge($this->getDefaults($project), [

3
config/swaggervel.php
View File

@ -45,7 +45,8 @@ return array(
base_path()."/tests",
base_path()."/resources/views",
base_path()."/config",
base_path()."/vendor"
base_path()."/vendor",
base_path()."/app/Console/Commands/stubs"
),
/*