Skip to content

Commit 4044909

Browse files
committed
Add minor change
1 parent 6dc7626 commit 4044909

File tree

2 files changed

+3
-3
lines changed
  • Documentation.app/Contents/MacOS/Generation examples.playground/Pages/Documentation.xcplaygroundpage
  • Templates

2 files changed

+3
-3
lines changed

Documentation.app/Contents/MacOS/Generation examples.playground/Pages/Documentation.xcplaygroundpage/Contents.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
tags:
2121
- Product
2222
operationId: getProducts
23-
description: Obtains all products sold by the store.
23+
summary: Obtains all products sold by the store.
2424
parameters:
2525
- name: sortBy
2626
in: query
@@ -37,5 +37,5 @@
3737
$ref: '#/components/schemas/Products'
3838
```
3939

40-
The generator will take all the metadata in the fields named `description` and will use that information for documentation of the corresponding artifacts.
40+
The generator will take all the metadata in the fields named `summary` and `description` and will use that information for documentation of the corresponding artifacts.
4141
*/

Templates/api.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ extension {{classname}} {
4747
{{#allParams}}{{^isHeaderParam}}
4848
- Parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
4949
{{/isHeaderParam}}{{/allParams}}
50-
- Returns: An `EnvIO` to perform IO operations that produce errors of type `HTTPError` and values of type `{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}`, having access to an immutable environment of type `API.Config`. It can be seen as a Kleisli function `(API.Config) -> IO<API.HTTPError, {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}NoResponse{{/returnType}}>`.
50+
- Returns: An `EnvIO` to perform IO operations that produce errors of type `HTTPError` and values of type `{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}`, having access to an immutable environment of type `API.Config`.
5151
*/
5252
public func {{operationId}}({{#allParams}}{{^isHeaderParam}}, {{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{/isHeaderParam}}{{/allParams}}) -> EnvIO<API.Config, API.HTTPError, {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}NoResponse{{/returnType}}> {
5353
_{{operationId}}({{#allParams}}{{^isHeaderParam}}, {{paramName}}: {{paramName}}{{/isHeaderParam}}{{/allParams}})

0 commit comments

Comments
 (0)