Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
07c7559
docs: align doc-site with fix/backlog-lot1 + exemplify new features
fredbi Jun 14, 2026
1e07655
docs: align doc-site with new fix/backlog-lot1 commits (tags, externa…
fredbi Jun 15, 2026
2814587
docs: add Shaping pages for inline response bodies and forcing a format
fredbi Jun 15, 2026
8fe2403
docs: add Polymorphic models tutorial (discriminator + allOf subtypes)
fredbi Jun 15, 2026
b7d7f04
docs: document the $ref allOf-lift (decorating a $ref) in model defin…
fredbi Jun 15, 2026
6f51c32
docs: align doc-site with newer fix/backlog-lot1 commits (params/head…
fredbi Jun 15, 2026
50220bd
docs: align doc-site with newer fix/backlog-lot1 commits (security, P…
fredbi Jun 15, 2026
9f8d0f3
docs: align doc-site with newer fix/backlog-lot1 commits (markdown bu…
fredbi Jun 15, 2026
59e05fb
docs: add a dedicated Security tutorial
fredbi Jun 15, 2026
876b608
docs: reconcile doc-site with the F-series quirk fixes
fredbi Jun 15, 2026
d100ae9
docs: note swagger:operation security in the Security tutorial
fredbi Jun 15, 2026
a732567
docs: exemplify info x-logo (#1026) and note per-version scans (#3134)
fredbi Jun 15, 2026
97587ab
docs: reconcile F1/F2/F4 + #2038/#2547 quirk fixes; note the prose-to…
fredbi Jun 15, 2026
0d370bd
docs: note model-level Extensions in the vendor-extensions how-to
fredbi Jun 15, 2026
a2a06cb
docs: clarify pattern keeps backslash escapes verbatim (#2384)
fredbi Jun 15, 2026
a730b55
docs: note Security accepts the YAML dash-list form (#2403)
fredbi Jun 15, 2026
aba6846
docs: scaffold a draft "Resolving $ref name conflicts" Shaping section
fredbi Jun 16, 2026
401d1be
docs: document Security: [] public opt-out (#2479) and field-level sw…
fredbi Jun 16, 2026
a6591c1
docs: reinspect Security (now real YAML); document bracketed enum + n…
fredbi Jun 16, 2026
1cf91bd
docs: correct name:/swagger:name scope (they are complementary, not e…
fredbi Jun 16, 2026
c6efc27
docs: showcase the G1-fixed derived response description in inline-re…
fredbi Jun 16, 2026
7d6b4a1
docs: document generic-envelope responses via doc-only structs (go-sw…
fredbi Jun 17, 2026
347b729
docs: reframe name: as the universal field-naming keyword (quirk G2)
fredbi Jun 17, 2026
8d59bc0
docs: structured example on a $ref'd field + shared-model per-respons…
fredbi Jun 17, 2026
0911b86
docs: compose a response body from several models via swagger:allOf (…
fredbi Jun 17, 2026
f1b580b
docs: swagger:type override on parameter fields (go-swagger#1499)
fredbi Jun 17, 2026
a57a81b
docs: new 'Maps & free-form objects' tutorial with test-backed examples
fredbi Jun 17, 2026
0e44296
docs: reference entries for additionalProperties & patternProperties
fredbi Jun 17, 2026
0c38a26
docs: flip "Resolving $ref name conflicts" live with test-backed panes
fredbi Jun 17, 2026
77ce5ca
docs: document the EmitXGoType and SingleLineCommentAsDescription knobs
fredbi Jun 17, 2026
f46dc9c
docs: remove the stale duplicate usage/getting-started section
fredbi Jun 17, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/doc-site/annotation-index/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ tutorial that shows the annotation as runnable Go next to the spec it produces;
| `swagger:strfmt` | type declaration | `{type: string, format: …}` at every use | [example]({{% relref "/tutorials/model-definitions#swaggerstrfmt" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerstrfmt" %}}) |
| `swagger:enum` | named type | an `enum` array (+ `x-go-enum-desc`) | [example]({{% relref "/tutorials/model-definitions#swaggerenum" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerenum" %}}) |
| `swagger:allOf` | embedded field / struct | an `allOf` composition | [example]({{% relref "/tutorials/model-definitions#swaggerallof" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerallof" %}}) |
| `swagger:alias` | type alias | a `$ref` to the target (vs inline expansion) | [how-to]({{% relref "/shaping-the-output/alias-rendering" %}}) | [reference]({{% relref "/maintainers/annotations#swaggeralias" %}}) |
| `swagger:alias` *(deprecated)* | type alias | **no effect** — alias rendering is controlled by Go aliases + options | [how-to]({{% relref "/shaping-the-output/alias-rendering" %}}) | [reference]({{% relref "/maintainers/annotations#swaggeralias--deprecated" %}}) |
| `swagger:route` | func / var doc | a `paths` entry + operation | [example]({{% relref "/tutorials/routes-and-operations#swaggerroute" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerroute" %}}) |
| `swagger:operation` | func / var doc | a `paths` entry (YAML body) | [example]({{% relref "/tutorials/routes-and-operations#swaggeroperation" %}}) | [reference]({{% relref "/maintainers/annotations#swaggeroperation" %}}) |
| `swagger:parameters` | struct declaration | parameters on the named operation(s) | [example]({{% relref "/tutorials/routes-and-operations#swaggerparameters" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerparameters" %}}) |
| `swagger:response` | struct declaration | a `responses` entry | [example]({{% relref "/tutorials/routes-and-operations#swaggerresponse" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerresponse" %}}) |
| `swagger:ignore` | type / field doc | excludes the declaration | [example]({{% relref "/tutorials/model-definitions#swaggerignore" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerignore" %}}) |
| `swagger:name` | field / method doc | renames a JSON property | [example]({{% relref "/tutorials/model-definitions#swaggername" %}}) | [reference]({{% relref "/maintainers/annotations#swaggername" %}}) |
| `swagger:type` | type / field doc | overrides the inferred Swagger type | [example]({{% relref "/tutorials/model-definitions#swaggertype" %}}) | [reference]({{% relref "/maintainers/annotations#swaggertype" %}}) |
| `swagger:additionalProperties` | type doc | object `additionalProperties` (open / closed / typed) | [example]({{% relref "/tutorials/maps-and-free-form-objects#open--closed-objects" %}}) | [reference]({{% relref "/maintainers/annotations#swaggeradditionalproperties" %}}) |
| `swagger:patternProperties` | type doc | typed `patternProperties` (regex → value) | [example]({{% relref "/tutorials/maps-and-free-form-objects#pattern-properties" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerpatternproperties" %}}) |
| `swagger:file` | param / response field | `{type: file}` | [example]({{% relref "/tutorials/routes-and-operations#swaggerfile" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerfile" %}}) |
| `swagger:default` | value / field doc | a default-value anchor | [example]({{% relref "/tutorials/examples-and-defaults#swaggerdefault" %}}) | [reference]({{% relref "/maintainers/annotations#swaggerdefault" %}}) |

Expand Down
3 changes: 3 additions & 0 deletions docs/doc-site/getting-started/usage-as-a-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ an existing spec via `Options.InputSpec`.
| `BuildTags`, `Include`/`Exclude` | Scope control over what gets scanned. |
| `RefAliases`, `TransparentAliases`, `DescWithRef` | Alias-handling knobs. |
| `SkipExtensions` | Suppress `x-go-*` vendor extensions. |
| `SkipEnumDescriptions` | Keep the `swagger:enum` const→value mapping out of property/parameter descriptions (it still rides `x-go-enum-desc`). |
| `EmitXGoType` | Stamp `x-go-type` (the fully-qualified Go type) on every definition — see [Vendor extensions]({{% relref "/shaping-the-output/vendor-extensions#stamping-x-go-type" %}}). |
| `SingleLineCommentAsDescription` | Route single-line comments to `description` instead of `title`/`summary` — see [Single-line comments]({{% relref "/shaping-the-output/single-line-comments" %}}). |

See the [godoc][godoc] for the full list.

Expand Down
Loading
Loading