Enhance API parameter documentation and introduce reusable component
- Added a new Blade component `<x-logistics.param-table>` for displaying API parameter tables across all Filament pages, ensuring consistent styling and reducing HTML duplication. - Integrated parameter tables for each endpoint in the Articles, Documents, Divers, Journaux, Tiers, and other pages, providing users with clear reference information. - Updated the documentation to reflect the new structure and details of API parameters, including required fields and descriptions. - Improved user experience by ensuring that endpoints without parameters do not display empty tables. - Overall, enhanced the clarity and usability of API interactions within the application.
This commit is contained in:
@@ -36,6 +36,18 @@ class Journaux extends Page
|
||||
|
||||
public bool $hasSearched = false;
|
||||
|
||||
/**
|
||||
* @return array<int, array{name: string, type: string, required: string, description: string}>
|
||||
*/
|
||||
public function paramTableJnlList(): array
|
||||
{
|
||||
return [
|
||||
['name' => 'TYPE', 'type' => 'string', 'required' => 'Oui', 'description' => 'Code de type de journal (1 ou 2 caracteres). Ex: C=Client, S=Fournisseur, K=Stock, CI=Facture client, CO=Commande.'],
|
||||
['name' => 'select', 'type' => 'string', 'required' => 'Non', 'description' => 'Colonnes a retourner, separees par des virgules (colonnes de la table jnl). Si omis, seule la colonne jnl est retournee.'],
|
||||
['name' => 'results', 'type' => 'string', 'required' => 'Non', 'description' => 'Nombre maximum de resultats. Doit etre au format string. Limite par defaut : 30.'],
|
||||
];
|
||||
}
|
||||
|
||||
public function searchJournaux(): void
|
||||
{
|
||||
$this->errorMessage = null;
|
||||
|
||||
Reference in New Issue
Block a user