Table of Contents

Search

  1. Preface
  2. Introduction to REST V2 Connector
  3. Connections for REST V2
  4. REST V2 operations
  5. Mappings and mapping tasks with REST V2 Connector
  6. Swagger File Generation
  7. Appendix A: Swagger objects
  8. OpenAPI objects

REST V2 Connector

REST V2 Connector

Appendix A: Swagger objects

Appendix A: Swagger objects

The following table lists swagger objects with field names honored by REST V2 Connector:
Object Category
Configurable Objects or Fields
Swagger
swagger
info
host
basepath
schemes
consumes
produces
paths
definitions
parameters
responses
Paths
/{path}
Path Item
$ref
get
put
post
delete
parameters
Operation
Summary
operationId
consumes
produces
parameters
responses
schemes
If operation ID value is not defined, the value of summary field is treated as operation ID.
Parameter Type
path
query
header
formData
cookie
body
Parameter Fields
name
In. If
in
is
body
, the supported field is schema. If
in
is any value other than
body
, the supported fields are type, format, and items.
required
default. Not applicable to the
body
and
securityDefinitions
parameters.
Items
type
format
items
Response
schema
Schema
$ref
format
type
items
properties
xml
Definitions
{name}
securityDefinitions
{name}
You can configure Basic and apiKey security definitions types.
xml
name. Works only when used with the wrapped object.
attribute
prefix
namespace
wrapped
Rest V2 Connector does not process objects and fields other than the listed above, in the swagger definition.

0 COMMENTS

We’d like to hear from you!