-
Notifications
You must be signed in to change notification settings - Fork 6k
Vendor Extensions
Benjamin Gill edited this page Dec 23, 2017
·
6 revisions
Here is a list of vendor extensions used by different generators.
The list may not be up-to-date so the best way is to look for "x-" in the mustache templates.
(All examples are in YAML format)
To customize the method name, you can provide a different name in x-objc-operationId, e.g.
summary: Add a new pet to the store
description: ''
operationId: addPet
x-objc-operationId: CreateNewPet
A single Accepts
value as the Feign API client needs a single value for Accepts
header, e.g.
consumes:
- application/json
- application/xml
x-accepts: application/json
A single "Content-Type" value as the Feign API client needs a single value for Content-Type
header, e.g.
produces:
- application/xml
- application/json
x-content-type: application/json
Each response may specify a unique x-responseId
. rust-server
will use this to name the corresponding enum variant in the code. e.g.
paths:
/ping:
get:
responses:
200:
description: OK
x-responseId: Pong
would suggest when compiling to use flag to ignore tests. The tests requires extra dependencies and the compilation might fail due to that.