Skip to content

Update doc to address custom validation rules #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 6, 2018
Merged

Update doc to address custom validation rules #342

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c22d11
Update doc to address custom validation rules (#247)
shalvah Oct 6, 2018
1d5b871
Merge pull request #6 from mpociot/master
shalvah Oct 6, 2018
2f7e040
Merge remote-tracking branch 'origin/master'
shalvah Oct 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ class ExampleController extends Controller {

#### Form request validation rules

To display a list of valid parameters, your API methods accepts, this package uses Laravels [Form Requests Validation](https://laravel.com/docs/5.2/validation#form-request-validation).
To display a list of valid parameters, your API methods accepts, this package uses Laravel's [Form Requests Validation](https://laravel.com/docs/5.2/validation#form-request-validation).


```php
Expand All @@ -138,6 +138,9 @@ public function rules()

**Result:** ![Form Request](http://marcelpociot.de/documentarian/form_request.png)

### A note on custom validation rules
This package only supports custom rules defined as classes. You'll also need to define a `__toString()` method in the class, which should return the description that would be displayed in the generated doc.

#### Controller method doc block
It is possible to override the results for the response. This will also show the responses for other request methods then GET.

Expand Down