Skip to content

Commit

Permalink
docs: fix typo (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericlingit committed Aug 18, 2022
1 parent 0caa6c5 commit 1f5d47b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ The *OpenAPI* generator recognize some tags of the [go-playground/validator.v8](

The supported tags are: [len](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Length), [max](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Maximum), [min](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Mininum), [eq](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Equals), [gt](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Greater_Than), [gte](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Greater_Than_or_Equal), [lt](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Less_Than), [lte](https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Less_Than_or_Equal).

Based on the type of the field that carry the tag, the fields `maximum`, `minimum`, `minLength`, `maxLength`, `minIntems`, `maxItems`, `minProperties` and `maxProperties` of its **JSON Schema** will be filled accordingly.
Based on the type of the field that carry the tag, the fields `maximum`, `minimum`, `minLength`, `maxLength`, `minItems`, `maxItems`, `minProperties` and `maxProperties` of its **JSON Schema** will be filled accordingly.

## OpenAPI specification

Expand Down
2 changes: 1 addition & 1 deletion openapi/spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ func (eor *ExampleOrRef) MarshalYAML() (interface{}, error) {
return eor.Reference, nil
}

// Example represents the exanple of a media type.
// Example represents the example of a media type.
type Example struct {
Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Expand Down

0 comments on commit 1f5d47b

Please sign in to comment.