Skip to content

Commit

Permalink
UDF #17 - Updating README.me to include documentation for adding routes
Browse files Browse the repository at this point in the history
  • Loading branch information
dleadbetter committed Sep 27, 2022
1 parent 971f25e commit b875791
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ class AddUserDefinedFieldsToMyModel < ActiveRecord::Migration[7.0]
end
```

### Routes
The user defined field routes can be added by mounting the engine in `routes.rb`:

```ruby
mount UserDefinedFields::Engine, at: '/user_defined_fields'
```

### Controllers
Each individual field can be configured to be searchable or non-searchable. A searchable field will be included in the query when a user provides the "search" parameter on the API request.

Expand Down

0 comments on commit b875791

Please sign in to comment.