API Endpoints
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:
|
Name
|
Description
|
||||
|---|---|---|---|---|---|
| Name | Name of the POST API endpoint. | ||||
| Description | A description of the POST API endpoint. | ||||
| Request Body Input Type |
|
GET
Parameters:
|
Name
|
Description
|
|---|---|
| Name | Name 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 |
|
PUT
Parameters:
|
Name
|
Description
|
||||
|---|---|---|---|---|---|
| Name | Name of the PUT API endpoint. | ||||
| Description | A description of the PUT API endpoint. | ||||
| Request Body Input Type |
|
SET
Parameters:
|
Name
|
Description
|
|---|---|
| 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 |
|