Checked and updated geopoints cookbook #310
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
Codecov Report
@@ Coverage Diff @@
## master #310 +/- ##
==========================================
+ Coverage 38.49% 39.42% +0.92%
==========================================
Files 99 87 -12
Lines 4159 2765 -1394
Branches 10 10
==========================================
- Hits 1601 1090 -511
+ Misses 2557 1674 -883
Partials 1 1 |
mkucharz
requested changes
Oct 30, 2018
| name: geolocation | ||
| description: Intereact with geolocation data object | ||
| runtime: nodejs_v8 | ||
| keywords: |
There was a problem hiding this comment.
Keywords should go to package.json
| @@ -21,41 +21,49 @@ In order to be able to use the GeoPoints functionality, you'll need a Data Class | |||
| To save the data, create a `save-location` endpoint. It will serve as a gateway for writing the coordinates to your `geolocation` class. | |||
|
|
|||
| ```YAML | |||
| name: geolocation | |||
| description: Intereact with geolocation data object | |||
| runtime: nodejs_v8 | |||
There was a problem hiding this comment.
Runtime is obsolete now. Please remove it.
| @@ -21,41 +21,49 @@ In order to be able to use the GeoPoints functionality, you'll need a Data Class | |||
| To save the data, create a `save-location` endpoint. It will serve as a gateway for writing the coordinates to your `geolocation` class. | |||
|
|
|||
| ```YAML | |||
| name: geolocation | |||
| description: Intereact with geolocation data object | |||
There was a problem hiding this comment.
Description only in package.json
| classes: | ||
| geolocation: | ||
| - name: coordinates | ||
| type: geopoint | ||
| filter_index: true | ||
| - name: user | ||
| type: reference | ||
| target: user | ||
| target: user |
There was a problem hiding this comment.
You added there two spaces at the end of the line.
|
|
||
| endpoints: | ||
| save-location: | ||
| description: User coordinates fetched from the browser | ||
| inputs: | ||
| properties: | ||
| coordinates: | ||
| type: geopoint | ||
| description: latitude, longitude plus optional distance_in_kilometers or distance_in_miles |
There was a problem hiding this comment.
We keep description starting with capital letter.
| { | ||
| "message": Something went wrong!" | ||
| } | ||
| } |
| }) | ||
|
|
||
| return response.json({ message: 'location saved' }, status) | ||
| return response.json(createdGeoPoint, 200) |
There was a problem hiding this comment.
200 is default, no need to add it to response.
mkucharz
requested changes
Oct 30, 2018
| exit_code: 200 | ||
| description: returns a list of Data Objects matching the provided range | ||
| fail: | ||
| exit_code: 404 |
mkucharz
approved these changes
Oct 31, 2018
mattlsp
approved these changes
Oct 31, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Went through the cookbook and checked for errors, user should be able to re-product the cookbook outcome