You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Query parameters should be displayed either in the parameters tab or somewhere in the verb's documentation. Currently it's not displayed anywhere and the user should have the possibility to see that information.
yaml file
%TAG ! tag:raml.org,0.1:
title: Employees API
version: v0.2
baseUri: http://localhost:9091/api/
documentation:
- title: Employees
content: |
Welcome to the Employees API Documentation. The Employees API
allows you to view a complete list of your employees. You may also
add or delete employees to keep the list up to date.
- title: Contact
content: |
If you need support, please contact asr@mulesoft.com.
- title: More info
content: !include more_info.txt
/employees:
name: Employees
get:
summary: Get a list of employees.
description: |
The employees returned will display the following data: First Name,
Last Name and Birth Date.
queryParameters:
firstName:
description: |
First Name of the employee. This value is not required.
type: string
required: no
example: "Joseph"
lastName:
description: |
First Name of the employee. This value is not required.
type: string
required: no
example: "Joseph"
responses:
200:
body:
application/json: !!null
text/xml: !!null
404:
description: Resource not found.
405:
description: Method not allowed.
415:
description: Unsupported media type.
406:
description: Not acceptable.
400:
description: Bad request.
The text was updated successfully, but these errors were encountered:
Query parameters should be displayed either in the parameters tab or somewhere in the verb's documentation. Currently it's not displayed anywhere and the user should have the possibility to see that information.
yaml file
%TAG ! tag:raml.org,0.1:
title: Employees API
version: v0.2
baseUri: http://localhost:9091/api/
documentation:
- title: Employees
content: |
Welcome to the Employees API Documentation. The Employees API
allows you to view a complete list of your employees. You may also
add or delete employees to keep the list up to date.
- title: Contact
content: |
If you need support, please contact asr@mulesoft.com.
- title: More info
content: !include more_info.txt
/employees:
name: Employees
get:
summary: Get a list of employees.
description: |
The employees returned will display the following data: First Name,
Last Name and Birth Date.
queryParameters:
firstName:
description: |
First Name of the employee. This value is not required.
type: string
required: no
example: "Joseph"
lastName:
description: |
First Name of the employee. This value is not required.
type: string
required: no
example: "Joseph"
responses:
200:
body:
application/json: !!null
text/xml: !!null
404:
description: Resource not found.
405:
description: Method not allowed.
415:
description: Unsupported media type.
406:
description: Not acceptable.
400:
description: Bad request.
The text was updated successfully, but these errors were encountered: