# packSize(required) the size of the pack the dog is from # id(required) the identifier for the pet To support Swagger Polymorphism, use and # To then use your Model in your Controller documentation, add # pet(body) The pet object

# relatives(required) other Pets in its family # end_at_less Filters response to include only items with end_at ] the names for the pet # begin_at_less Filters response to include only items with begin_at = specified timestamp (e.g. # begin_at_greater Filters response to include only items with begin_at >= specified timestamp (e.g. # sort_descending Reverse order of sort_order sorting, make it descending. # This document describes the API for creating, reading, and deleting account ownerships.Ĭlass Accounts::OwnershipsController ] Filter by status. body/ query/ path/ formData: Indicates where the parameter is located.Įxample of using SwaggerYard in a Controller # Account ownership.Query string, e.g., param=a¶m=b¶m=c) multiple: indicates a parameter may appear multiple times (usually in a.nullable: indicates that JSON null is an allowed value for the property.required: indicates a required parameter or property.Parameter or property options are expressed inside parenthesis immediatelyįollowing the parameter or property name.Įxamples: # name(required) Name of the package JSON-Schema format attributes can be specified for basic types using.Structured data like objects, arrays, pairs, etc., definitions can also be nested E.g.,.An object definition can include the property definitions of its fields, and / or of an additional property for any remaining allowed fields.An enum of allowed string values is specified with.

An array of models or basic types is specified with.Basic types (integer, boolean, string, object, number, date, time, date-time,.Model references should be Capitalized or CamelCased by convention.Types of things (parameters or responses of an operation, properties of a model)Īre indicated inside square-brackets (e.g., ) as part of a YARD tag. api_base_path = ' ' end SwaggerYard Usage Types development? # where your actual api is hosted fromĬonfig. Install the gem with Bunder: bundle install Getting Started Place configuration in a rails initializer # config/initializers/swagger_yard.rb

Put SwaggerYard in your Gemfile: gem ' swagger_yard ' SwaggerYard is a gem to convert extended YARD syntax comments into the swagger spec compliant json format.

Gem install jekyll path not found