Skip to content

DTC-705 Support additional RentCafe API parameter#395

Open
Jordan3900 wants to merge 1 commit into
masterfrom
DTC-705
Open

DTC-705 Support additional RentCafe API parameter#395
Jordan3900 wants to merge 1 commit into
masterfrom
DTC-705

Conversation

@Jordan3900
Copy link
Copy Markdown
Contributor

Copy link
Copy Markdown

@orca-security-us orca-security-us Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the RentCafe availability slots documentation by adding a description for the noOfDays parameter and updating the example request. Feedback was provided to improve consistency with other API documentation, including refining the terminology and adding an introductory sentence to the parameters section.

Comment on lines +15 to +19
### Parameters

| Parameter | Required | Description |
|---|---|---|
|`noOfDays`| No | The number of days in the future for which available appointment slots will be returned. For example, a value of `1` will return available appointments for today and tomorrow. Value cannot be greater than 90. If left blank, returns available timeslots for the next 90 days. If the property is configured to display fewer days than requested, the property's configured maximum will be used instead. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other API documentation files in this repository (e.g., _rentcafe_apartment_availability.md), consider adding an introductory sentence for the parameters section. Additionally, using "omitted" is more precise than "left blank" for optional API parameters, and using consistent terminology like "appointment slots" instead of mixing it with "timeslots" improves clarity.

Suggested change
### Parameters
| Parameter | Required | Description |
|---|---|---|
|`noOfDays`| No | The number of days in the future for which available appointment slots will be returned. For example, a value of `1` will return available appointments for today and tomorrow. Value cannot be greater than 90. If left blank, returns available timeslots for the next 90 days. If the property is configured to display fewer days than requested, the property's configured maximum will be used instead. |
### Parameters
When using the GET index method, the results will be filtered using these parameters:
| Parameter | Required | Description |
|---|---|---|
|`noOfDays`| No | The number of days in the future for which available appointment slots will be returned. For example, a value of `1` will return available appointment slots for today and tomorrow. The value cannot exceed 90. If omitted, the API returns available appointment slots for the next 90 days. If the property is configured to display fewer days than requested, the property's configured maximum will be used instead. |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants