Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update _tasks.md #145

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update _tasks.md #145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d227c88
Update _tasks.md
nick-clark84 Jul 22, 2022
357669d
Merge branch 'main' into nick-clark84-patch-1
cebjyre Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion source/includes/endpoints/_tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ This request supports the [pagination](#configuring-the-response-pagination) par
##### Additional Fields and Linked Objects
This request supports requesting additional fields and linked objects from the [task object](#the-task-object) using the [`_fields`](#configuring-the-response-fields) parameter. This request also supports [breadcrumbs](#configuring-the-response-breadcrumbs).

##### Basic Filters
##### Basics
Copy link
Member

Choose a reason for hiding this comment

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

@nick-clark84 Should this still be Basic Filters for consistency with other filters?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hi @Timothy-Edwards sorry I don't think I meant to make this change. I have a feeling I inadvertently remove Filters when Ictrl+fin the doc for Filters.

Can "cancel" this change.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
##### Basics
##### Basic Filters

This request supports [basic filters](#filters-basic-filters) over the following fields:

| Filter Name | Notes |
Expand Down Expand Up @@ -253,6 +253,7 @@ This request supports [date_filters](#filters-date-filters) over the following f
| date_completed |
| date_modified |
| date_due |
| started |
Copy link
Member

Choose a reason for hiding this comment

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

@nick-clark84 Looks like the started filter is already documented on line 250?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hi @Timothy-Edwards yep date_started is on line 250, I thought your comment here was suggesting that started should be its own unique filter

Copy link
Member

Choose a reason for hiding this comment

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

Not wanting to put words in Tim's mouth, but I suspect that comment was meant more as "if we are missing it from the update-able field list, we may also be missing it from the described filters list, so that might need to be added too" (and then he left off the "date_" part to confuse matters)

Suggested change
| started |

Copy link
Member

Choose a reason for hiding this comment

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

@nick-clark84 Yeah, sorry glenn is correct. date_started is the correct format for all the date filters. My bad I should have been clearer 🤦🏼


##### Range Filters
This request supports [range filters](#filters-range-filters) over the following fields:
Expand Down Expand Up @@ -562,6 +563,7 @@ The following fields from the [task object](#the-task-object) may be updated thr
| rate_charged |
| date_due |
| remaining |
| date_started |

#### Configuring the Response
This request supports requesting additional fields and linked resources from the [task object](#the-task-object) using the [`_fields`](#configuring-the-response-fields) parameter. This request also supports [breadcrumbs](#configuring-the-response-breadcrumbs).
Expand Down