+ Update swagger documentation

This commit is contained in:
Djery-Tom 2020-12-02 17:08:43 +01:00
parent d748a84dde
commit 55e4e0dccb
4 changed files with 4 additions and 403 deletions

View File

@ -519,89 +519,6 @@ INNER JOIN countries c ON oc.id_country = c.id INNER JOIN type_operators top ON
* )
*/
/**
* @OA\Schema(
* schema="user_link_bank_account_frame",
* title="User - Rattacher le compte bancaire à son wallet - Trame envoyé",
* @OA\Property(property="id_wallet_user",
* type="integer",
* example=9,
* description="ID du wallet de l'agent enregistré dans la base de données"
* ),
* @OA\Property(property="id_wallet_network",
* type="integer",
* example=101,
* description="ID du reseau enregistré dans la base de données auquel appartient le wallet"
* ),
* @OA\Property(property="iban",
* type="string",
* description="Identifiant bancaire"
* ),
* @OA\Property(property="id_bank",
* type="integer",
* example=4,
* description="ID de la banque enregistré dans la base de données"
* ),
* @OA\Property(property="lastname",
* type="string",
* description="Noms de l'emetteur"
* ),
* @OA\Property(property="firstname",
* type="string",
* description="Prenoms de l'emetteur"
* ),
* @OA\Property(property="email_emetteur",
* type="string",
* description="Email de l'emetteur"
* ),
* @OA\Property(property="type_document_emetteur",
* type="string",
* description="Type de document que l'emetteur a fourni pour son identification"
* ),
* @OA\Property(property="id_document_emetteur",
* type="string",
* description="ID de l'emetteur sur le document qu'il a fourni pour son identification"
* ),
* @OA\Property(property="nom_destinataire",
* type="string",
* description="Noms du destinataire"
* ),
* @OA\Property(property="prenom_destinataire",
* type="string",
* description="Prenoms du destinataire"
* ),
* @OA\Property(property="montant",
* type="number",
* example = 10000,
* description="Montant de la transaction"
* ),
* @OA\Property(property="frais",
* type="number",
* example = 100,
* description="Montant des frais de la transaction"
* ),
* @OA\Property(property="taxe",
* type="number",
* example = 50,
* description="Montant des taxes de la transaction"
* ),
* @OA\Property(property="commission_hyp",
* type="number",
* example = 25,
* description="Montant de la commission de l'hyperviseur du réseau sur la transaction"
* ),
* @OA\Property(property="commission_sup",
* type="number",
* example = 25,
* description="Montant de la commission du superviseur de l'agent du réseau sur la transaction"
* ),
* @OA\Property(property="commission_ag",
* type="number",
* example = 25,
* description="Montant de la commission de l'agent géolocalisé sur la transaction"
* ),
* )
*/
// Rattacher le compte bancaire au wallet
public function linkBankAccount(Request $request)
{
@ -651,11 +568,9 @@ INNER JOIN countries c ON oc.id_country = c.id INNER JOIN type_operators top ON
$user_banking_account_verif->id_network = $request->id_wallet_network;
$user_banking_account_verif->save();
$request->id_transaction = $user_banking_account_verif->id_transaction;
// Envoyer une requete vers la banque contant ses informations personnelles pour verfication du code iban
Log::info('-------------------------- User - Rattacher le compte bancaire au wallet ------------------------------------');
Log::info(array_merge($request->toArray(), $identification->toArray()));
Log::info(array_merge($request->toArray(), $identification->toArray(), ['id_transaction' => $user_banking_account_verif->id_transaction]));
Log::info('------------------------------------------------------------------------------------------------');
return $this->successResponse(trans('messages.successful_bank_account_attachment_taken'));

View File

@ -92,12 +92,7 @@ class iLinkTransactionController extends Controller
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* oneOf={
* @OA\Schema(ref="#/components/schemas/user_payement_of_operator_frame"),
* @OA\Schema(ref="#/components/schemas/user_remove_from_bank_to_wallet_frame"),
* @OA\Schema(ref="#/components/schemas/user_send_from_wallet_to_bank_frame"),
* @OA\Schema(ref="#/components/schemas/agent_send_from_cash_to_bank_frame"),
* }
* ref="#/components/schemas/ApiResponse",
* ),
* examples = {
* "user_payement_of_operator" : {
@ -511,78 +506,6 @@ class iLinkTransactionController extends Controller
* )
* )
*/
/**
* @OA\Schema(
* schema="user_send_from_wallet_to_bank_frame",
* title = "User - Envoi de wallet à banque - Trame envoyé",
* @OA\Property(property="type",
* type="integer",
* default = 4,
* description="Type de la transaction"
* ),
* * @OA\Property(property="id_wallet_user",
* type="integer",
* example=9,
* description="ID du wallet de l'utilisateur enregistré dans la base de données"
* ),
* @OA\Property(property="network_emetteur",
* type="integer",
* example=101,
* description="ID du reseau enregistré dans la base de données auquel appartient le wallet"
* ),
* @OA\Property(property="iban",
* type="string",
* example = "CM15UBAA412341234123412341233",
* description="ID bancaire de l'utilisateur"
* ),
* @OA\Property(property="id_bank",
* type="integer",
* example = 16,
* description="ID de la banque dans la base de données"
* ),
* @OA\Property(property="bank",
* type="string",
* default="UBA",
* description="Nom de la banque"
* ),
* @OA\Property(property="country",
* type="string",
* default="Cameroon",
* description="Pays où la transaction été éfféctuée"
* ),
* @OA\Property(property="montant",
* type="number",
* example = 10000,
* description="Montant de la transaction"
* ),
* @OA\Property(property="frais",
* type="number",
* example = 100,
* description="Montant des frais de la transaction"
* ),
* @OA\Property(property="taxe",
* type="number",
* example = 50,
* description="Montant des taxes de la transaction"
* ),
* @OA\Property(property="commission_hyp",
* type="number",
* example = 25,
* description="Montant de la commission de l'hyperviseur du réseau sur la transaction"
* ),
* @OA\Property(property="commission_banque",
* type="number",
* example = 25,
* description="Montant de la commission de la banque sur le réseau sur la transaction"
* ),
* @OA\Property(property="date",
* type="string",
* example = "2020-11-30T08:57:57.000000Z",
* description="Date à laquelle la transaction a été éffectuée"
* )
* )
*/
case 4: //User - Envoi de wallet à banque
$this->validate($request, [
@ -1362,94 +1285,6 @@ class iLinkTransactionController extends Controller
* )
*/
/**
* @OA\Schema(
* schema="agent_send_from_cash_to_bank_frame",
* title="Agent - Envoi de cash vers banque - Trame envoyé",
* @OA\Property(property="type",
* type="integer",
* default = 18,
* description="Type de la transaction"
* ),
* @OA\Property(property="id_wallet_user",
* type="integer",
* example=9,
* description="ID du wallet de l'agent enregistré dans la base de données"
* ),
* @OA\Property(property="id_wallet_network",
* type="integer",
* example=101,
* description="ID du reseau enregistré dans la base de données auquel appartient le wallet"
* ),
* @OA\Property(property="iban",
* type="string",
* description="Identifiant bancaire"
* ),
* @OA\Property(property="id_bank",
* type="integer",
* example=4,
* description="ID de la banque enregistré dans la base de données"
* ),
* @OA\Property(property="nom_emetteur",
* type="string",
* description="Noms de l'emetteur"
* ),
* @OA\Property(property="prenom_emetteur",
* type="string",
* description="Prenoms de l'emetteur"
* ),
* @OA\Property(property="email_emetteur",
* type="string",
* description="Email de l'emetteur"
* ),
* @OA\Property(property="type_document_emetteur",
* type="string",
* description="Type de document que l'emetteur a fourni pour son identification"
* ),
* @OA\Property(property="id_document_emetteur",
* type="string",
* description="ID de l'emetteur sur le document qu'il a fourni pour son identification"
* ),
* @OA\Property(property="nom_destinataire",
* type="string",
* description="Noms du destinataire"
* ),
* @OA\Property(property="prenom_destinataire",
* type="string",
* description="Prenoms du destinataire"
* ),
* @OA\Property(property="montant",
* type="number",
* example = 10000,
* description="Montant de la transaction"
* ),
* @OA\Property(property="frais",
* type="number",
* example = 100,
* description="Montant des frais de la transaction"
* ),
* @OA\Property(property="taxe",
* type="number",
* example = 50,
* description="Montant des taxes de la transaction"
* ),
* @OA\Property(property="commission_hyp",
* type="number",
* example = 25,
* description="Montant de la commission de l'hyperviseur du réseau sur la transaction"
* ),
* @OA\Property(property="commission_sup",
* type="number",
* example = 25,
* description="Montant de la commission du superviseur de l'agent du réseau sur la transaction"
* ),
* @OA\Property(property="commission_ag",
* type="number",
* example = 25,
* description="Montant de la commission de l'agent géolocalisé sur la transaction"
* ),
* )
*/
case 18: // Agent - Envoi de cash vers banque
$this->validate($request, [
'iban' => 'required',
@ -1570,84 +1405,6 @@ class iLinkTransactionController extends Controller
* )
* )
*/
/**
* @OA\Schema(
* schema="user_payement_of_operator_frame",
* title = "User - Payer une facture chez un operateur - Trame envoyé",
*
* @OA\Property(property="id_transaction",
* type="string",
* example = "PYHL8CCZYPCM",
* description="ID de la transaction généré dans la base de données"
* ),
* @OA\Property(property="type",
* type="integer",
* default = 19,
* description="Type de la transaction"
* ),
* @OA\Property(property="id_wallet_user",
* type="integer",
* example=9,
* description="ID du wallet de l'utilisateur enregistré dans la base de données"
* ),
* @OA\Property(property="network_emetteur",
* type="integer",
* example=101,
* description="ID du reseau enregistré dans la base de données auquel appartient le wallet"
* ),
* @OA\Property(property="country",
* type="string",
* example ="Cameroon",
* description="Pays où la transaction été éfféctuée"
* ),
* @OA\Property(property="no_facture",
* type="string",
* example ="ENEO1425533",
* description="Numero de la facture"
* ),
* @OA\Property(property="operator",
* type="string",
* default="ENEO",
* description="Nom de l'operateur"
* ),
* @OA\Property(property="type_operator",
* type="string",
* default="Opérateur d'électricité",
* description="Type d'operateur"
* ),
* @OA\Property(property="id_operator",
* type="integer",
* example = 16,
* description="ID de l'operateur"
* ),
* @OA\Property(property="montant",
* type="number",
* example = 10000,
* description="Montant de la transaction"
* ),
* @OA\Property(property="frais",
* type="number",
* example = 100,
* description="Montant des frais de la transaction"
* ),
* @OA\Property(property="taxe",
* type="number",
* example = 50,
* description="Montant des taxes de la transaction"
* ),
* @OA\Property(property="commission_hyp",
* type="number",
* example = 25,
* description="Montant de la commission de l'hyperviseur du réseau sur la transaction"
* ),
* @OA\Property(property="date",
* type="string",
* example = "2020-11-30T08:57:57.000000Z",
* description="Date à laquelle la transaction a été éffectuée"
* )
* )
*/
case 19: // User - Payer un operateur
$this->validate($request, [
'id_operator' => 'required|integer|min:0|not_in:0',
@ -1731,78 +1488,6 @@ class iLinkTransactionController extends Controller
* )
* )
*/
/**
* @OA\Schema(
* schema="user_remove_from_bank_to_wallet_frame",
* title="User - Retrait de la banque vers le wallet - Trame envoyé ",
* @OA\Property(property="type",
* type="integer",
* default = 20,
* description="Type de la transaction"
* ),
* @OA\Property(property="id_wallet_user",
* type="integer",
* example=9,
* description="ID du wallet de l'utilisateur enregistré dans la base de données"
* ),
* @OA\Property(property="network_emetteur",
* type="integer",
* example=101,
* description="ID du reseau enregistré dans la base de données auquel appartient le wallet"
* ),
* @OA\Property(property="iban",
* type="string",
* example = "CM15UBAA412341234123412341233",
* description="ID bancaire de l'utilisateur"
* ),
* @OA\Property(property="id_bank",
* type="integer",
* example = 16,
* description="ID de la banque dans la base de données"
* ),
* @OA\Property(property="bank",
* type="string",
* default="UBA",
* description="Nom de la banque"
* ),
* @OA\Property(property="country",
* type="string",
* default="Cameroon",
* description="Pays où la transaction été éfféctuée"
* ),
* @OA\Property(property="montant",
* type="number",
* example = 10000,
* description="Montant de la transaction"
* ),
* @OA\Property(property="frais",
* type="number",
* example = 100,
* description="Montant des frais de la transaction"
* ),
* @OA\Property(property="taxe",
* type="number",
* example = 50,
* description="Montant des taxes de la transaction"
* ),
* @OA\Property(property="commission_hyp",
* type="number",
* example = 25,
* description="Montant de la commission de l'hyperviseur du réseau sur la transaction"
* ),
* @OA\Property(property="commission_banque",
* type="number",
* example = 25,
* description="Montant de la commission de la banque sur le réseau sur la transaction"
* ),
* @OA\Property(property="date",
* type="string",
* example = "2020-11-30T08:57:57.000000Z",
* description="Date à laquelle la transaction a été éffectuée"
* )
* )
*/
case 20: //User - Retrait de la banque vers le wallet
// $this->validate($request, [

View File

@ -39,7 +39,7 @@ trait Helper
public function sendMail($email, $title, $messageText)
{
$recipients = [$email];
$recipients = [preg_replace("/\s+/", "", $email)]; // Supprimer les espaces dans le mail
Mail::mailer('smtp')->raw($messageText, function ($message) use ($recipients, $title) {
$message->subject($title);
$message->to($recipients);

View File

@ -39,6 +39,7 @@ $router->group(['prefix' => '', 'middleware' => 'auth'], function () use ($route
$router->get('agent/{id_wallet_agent}', 'iLinkTransactionController@lastAgentTransactions');
$router->post('check_retraits', 'iLinkTransactionController@getTransactionRetrait');
$router->delete('{id_transaction}', 'iLinkTransactionController@cancel');
// Recevoir le resultat du traitement dune transacion émise vers un réseau émetteur
$router->post('receive_request_processing_result', 'iLinkTransactionController@receiveRequestProcessingResult');
});
});