Skip to content

Checked and updated geopoints cookbook#310

Merged
ksyhoo merged 6 commits into
masterfrom
chore/updated_geopoints_cookbook
Oct 31, 2018
Merged

Checked and updated geopoints cookbook#310
ksyhoo merged 6 commits into
masterfrom
chore/updated_geopoints_cookbook

Conversation

@ksyhoo

@ksyhoo ksyhoo commented Oct 30, 2018

Copy link
Copy Markdown
Contributor

Went through the cookbook and checked for errors, user should be able to re-product the cookbook outcome

@ksyhoo ksyhoo self-assigned this Oct 30, 2018
@ksyhoo ksyhoo requested review from mattlsp and mkucharz October 30, 2018 12:16
@codecov-io

codecov-io commented Oct 30, 2018

Copy link
Copy Markdown

Codecov Report

Merging #310 into master will increase coverage by 0.92%.
The diff coverage is n/a.

@@            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

Comment thread docs/cookbook/web/database/geopoints.md Outdated
name: geolocation
description: Intereact with geolocation data object
runtime: nodejs_v8
keywords:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Keywords should go to package.json

Comment thread docs/cookbook/web/database/geopoints.md Outdated
```YAML
name: geolocation
description: Intereact with geolocation data object
runtime: nodejs_v8

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Runtime is obsolete now. Please remove it.

Comment thread docs/cookbook/web/database/geopoints.md Outdated

```YAML
name: geolocation
description: Intereact with geolocation data object

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Description only in package.json

Comment thread docs/cookbook/web/database/geopoints.md Outdated
- name: user
type: reference
target: user
target: user

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You added there two spaces at the end of the line.

Comment thread docs/cookbook/web/database/geopoints.md Outdated
properties:
coordinates:
type: geopoint
description: latitude, longitude plus optional distance_in_kilometers or distance_in_miles

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We keep description starting with capital letter.

Comment thread docs/cookbook/web/database/geopoints.md Outdated
{
"message": Something went wrong!"
}
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Spaces..

Comment thread docs/cookbook/web/database/geopoints.md Outdated
})

return response.json({ message: 'location saved' }, status)
return response.json(createdGeoPoint, 200)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

200 is default, no need to add it to response.

Comment thread docs/cookbook/web/database/geopoints.md Outdated
exit_code: 200
description: returns a list of Data Objects matching the provided range
fail:
exit_code: 404

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Again, you have spaces here.

@ksyhoo ksyhoo added the DOCS label Oct 31, 2018
@ksyhoo ksyhoo merged commit 9ff9a2c into master Oct 31, 2018
@ksyhoo ksyhoo deleted the chore/updated_geopoints_cookbook branch October 31, 2018 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants