This repository has been archived by the owner on Apr 16, 2020. It is now read-only.
Update search filter description #692
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2e3s
reviewed
May 10, 2019
spec/paths/search.yaml
Outdated
| @@ -14,7 +14,8 @@ get: | |||
| - description: | | |||
| The collection items filter requires a special format. | |||
| Use "," for multiple allowed values. Use ";" for multiple fields. | |||
| Use one or more of the listed filter fields. i.e. `is:customer email:bob@test.com` | |||
| Use one or more of the listed filter fields. i.e. `is:customer email:bob@test.com`. | |||
| The `date` value can be surrounded with quotes and accepts [any format that PHP's `strtotime` supports.](https://www.php.net/manual/en/function.strtotime.php) | |||
There was a problem hiding this comment.
It's better to describe the particular usage cases which we will certainly support whatever technology is used for this endpoint(s).
There was a problem hiding this comment.
It will make the description field very long. Can you suggest where else I could put it?
There was a problem hiding this comment.
How long? Do users need a zillion use cases, everyone with that std library function provides? I think putting here is okay.
There was a problem hiding this comment.
Okay, I'll add some and get rid of this link.
ashkarpetin
approved these changes
May 13, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the search filter description to explain
dateparameter.