@extends('[% layout_name %]') @section('content')

[% model_plural %]

[% general_description %]

[% available_resources %]

GET /{{ Route::getRoutes()->getByName('[% index_route_name %]')->uri() }}

[% index_route_description %]

[% request_title %]

[% authorized_request_for_index %]

[% response_title %]

[% index_route_response_description %]

200 - Ok

[% request_was_successful %]

success [% boolean_title %] Was the request successful or not.
message [% string_title %] [% the_success_message %]
data [% array_title %] [% the_key_is_the_model_property_and_the_value_is_the_model_value %]
links [% array_title %]
[% key_title %] [% data_type_title %] [% description_title %]
first [% string_title %] [% link_to_retrieve_first_page %]
last [% string_title %] [% link_to_retrieve_last_page %]
prev [% string_title %] [% link_to_retrieve_previous_page %]
next [% string_title %] [% link_to_retrieve_next_page %]
meta [% array_title %]
[% key_title %] [% data_type_title %] [% description_title %]
current_page [% integer_title %] [% the_number_of_current_page %]
from [% integer_title %] [% the_index_of_the_first_retrieved_item %]
last_page [% integer_title %] [% the_number_of_the_last_page %]
Path [% string_title %] [% the_base_link_to_the_resource %]
per_page [% integer_title %] [% the_number_of_models_per_page %]
to [% integer_title %] [% the_index_of_the_last_retrieved_item %]
total [% integer_title %] [% the_total_of_available_pages %]
[% include_failed_authentication_for_authorized_request %]
POST /{{ Route::getRoutes()->getByName('[% store_route_name %]')->uri() }}

[% store_route_description %]

[% request_title %]

@include('[% path_to_view_home %]fields-list', [ 'withValidation' => true ])

[% response_title %]

[% store_route_response_description %]

@include('[% path_to_view_home %]retrieved') @include('[% path_to_view_home %]failed-to-retrieve') @include('[% path_to_view_home %]failed-validation') [% include_failed_authentication_for_authorized_request %]
POST /{{ Route::getRoutes()->getByName('[% update_route_name %]')->uri() }}

[% update_route_description %]

[% request_title %]

@include('[% path_to_view_home %]fields-list', [ 'withValidation' => true, 'withPathId' => true, ])

[% response_title %]

[% update_route_response_description %]

@include('[% path_to_view_home %]retrieved') @include('[% path_to_view_home %]failed-to-retrieve') @include('[% path_to_view_home %]failed-validation') [% include_failed_authentication_for_authorized_request %]
GET /{{ Route::getRoutes()->getByName('[% show_route_name %]')->uri() }}

[% show_route_description %]

[% request_title %]

[% include_parameter_for_authorized_request %]
[% parameter_name_title %] [% data_type_title %] [% parameter_type_title %] [% description_title %]
[% model_name %] [% integer_title %] [% path_title %] [% the_id_of_model_to_retrieve %]

[% response_title %]

[% show_route_response_description %]

@include('[% path_to_view_home %]retrieved') @include('[% path_to_view_home %]failed-to-retrieve') [% include_failed_authentication_for_authorized_request %]
DELETE /{{ Route::getRoutes()->getByName('[% destroy_route_name %]')->uri() }}

[% destroy_route_description %]

[% request_title %]

[% include_parameter_for_authorized_request %]
[% parameter_name_title %] [% data_type_title %] [% parameter_type_title %] [% description_title %]
[% model_name %] [% integer_title %] [% path_title %] [% the_id_of_model_to_delete %]

[% response_title %]

[% destroy_route_response_description %]

@include('[% path_to_view_home %]retrieved') @include('[% path_to_view_home %]failed-to-retrieve') [% include_failed_authentication_for_authorized_request %]

[% model_definition_title %]

[% model_name_title %]
[% fields_list_for_body %]
[% field_name_title %] [% field_type_title %] [% description_title %]
@endsection