Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

OAS documents come with API endpoints that can be comprised of either the POST, GET, PUT and DELETE HTTP methods.

Properties configuration

POST

Parameters:  

NameDescription
NameName

...

of the POST API endpoint.
Description

...

A description of the POST API endpoint.
Request Body Input Type

...

Payload

...

  • Request Body 
Input FIelds

...

  • Field Label
  • Default Value
  • Mode
    • Default 
    • Force Mandatory 
    • Hide Field

GET

Image RemovedImage Added

Parameters:  

NameDescription
NameName

...

of the GET API endpoint. 
Description

...

A description of the GET API endpoint.
Field Label

...

Specify a field label.
Default Value

...

Specify

...

a default value.
Mode

...

  • Default
  • Force Mandatory
  • Hide Field

PUT

Parameters:  

NameDescription
Name

...

Name of the

...

PUT API endpoint.
Description

...

A

...

description of the PUT API endpoint.
Request Body Input Type

...

Payload

...

  • Request Body 
Input FIelds

...

  • Field Label
  • Default Value
  • Mode

...

    • Default 
    • Force Mandatory 
    • Hide Field

SET

Parameters: 

NameDescription
Name

...

Name of the

...

SET API endpoint. 
Description

...

A

...

description of the

...

SET API endpoint.
Field Label

...

Specify

...

a field label.
Default Value

...

Specify

...

a default value.
Mode

...

  • Default
  • Force Mandatory
  • Hide Field