Class: SpecForge::Documentation::Document::Parameter

Inherits:
Object
  • Object
show all
Defined in:
lib/spec_forge/documentation/document/parameter.rb

Overview

Represents a parameter for an API operation

Parameters can appear in various locations (path, query, header) and have different types and validation rules.

Examples:

Path parameter

Parameter.new(name: "id", location: "path", type: "integer")

Query parameter

Parameter.new(name: "limit", location: "query", type: "integer")