README.md in rails_api_documentation-0.2.3 vs README.md in rails_api_documentation-0.3.0
- old
+ new
@@ -42,18 +42,19 @@
class AuthorsController < ApplicationController
has_scope :article_id, :name
# Define parameters with type and nested options
- parameter :age, type: Integer
- parameter :name, type: String, required: true
- parameter :articles, type: :model, model: Article do
- parameter :title, type: String
- parameter :body, type: String, required: true
+ # Article and Datum are usual ActiveRecord models
+ parameter :age, type: :integer
+ parameter :name, type: :string, required: true
+ parameter :articles_attributes, type: :ary_object, model: 'Article' do
+ parameter :title, type: :string
+ parameter :body, type: :string, required: true
parameter :rating, type: :enum, enum: [1, 2, 3]
- parameter :data, type: :model, model: Datum do
- parameter :creation_date, type: DateTime
- parameter :comment, type: String
+ parameter :data_attributes, type: :object, model: 'Datum' do
+ parameter :creation_date, type: :datetime
+ parameter :comment, type: :string
end
end
parameter :test, type: String, required: true
end