Table of Contents

Search

  1. Preface
  2. Introduction to REST V2 Connector
  3. REST V2 connections
  4. REST V2 operations
  5. Mappings and mapping tasks with REST V2 Connector
  6. Appendix A: Supported swagger objects

REST V2 Connector

REST V2 Connector

Supported swagger objects overview

Supported swagger objects overview

The following table lists swagger objects with field names supported by REST V2 Connector:
Object Category
Supported 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
If operation ID value is not defined, the value of summary field is treated as operation ID.
operationId
consumes
produces
parameters
responses
schemes
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}
Basic and apiKey are the supported security definitions types.
xml
name
Name works only when used with the wrapped object.
attribute
prefix
namespace
wrapped
Rest V2 Connector does not process unsupported objects and fields, if included, in the swagger definition.


Updated December 14, 2020