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.

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

Add keys and excludeKeys options to REST docs #649

Merged
merged 4 commits into from
Jul 28, 2019

Conversation

RaschidJFR
Copy link
Contributor

@RaschidJFR RaschidJFR commented Jul 25, 2019

Closes #632

Added example of Query.exclude() in `js/queries.md`
Closes parse-community#632
@TomWFox
Copy link
Contributor

TomWFox commented Jul 26, 2019

Thanks for doing that, I will review this tomorrow.

Copy link
Contributor

@TomWFox TomWFox left a comment

Choose a reason for hiding this comment

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

JS changes look good 👍

I don't think excludeKeys should be mentioned in the retrieving objects section in the REST guide. If you look at the query constraints section there is a part which would make more sense...

In addition to where, there are several parameters you can use to configure what types of results are returned by the query.

I think excludeKeys should be added in the table here after keys and an example added after the keys example.

Also:
* Added `excludKeys` to the parameter table
* Added padding to <td> elements in `_normalize.scss`
@RaschidJFR
Copy link
Contributor Author

You're right @TomWFox ! I let include deceive me. BTW I also added padding to td elements as tables started to look a bit tight.

Copy link
Contributor

@TomWFox TomWFox left a comment

Choose a reason for hiding this comment

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

Looks good, tables look much better!

@TomWFox
Copy link
Contributor

TomWFox commented Jul 28, 2019

@dplewis could you give the code samples a quick once over?

Copy link
Member

@dplewis dplewis left a comment

Choose a reason for hiding this comment

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

Looks good to me. Just a quick nit

_includes/rest/queries.md Outdated Show resolved Hide resolved
@TomWFox TomWFox merged commit 0c86bc0 into parse-community:gh-pages Jul 28, 2019
mtrezza added a commit to mtrezza/docs that referenced this pull request Sep 6, 2019
* commit 'e129790ed587819ecfcaed59fc7ff90ec6ffcfa1': (84 commits)
  Add `cascadeSave` option in ParseObject to JS docs (parse-community#664)
  Update apple sign in documentation (parse-community#662)
  Bump mixin-deep from 1.3.1 to 1.3.2 (parse-community#670)
  Update GraphQL docs with latest changes (parse-community#669)
  remove a bunch of parse cloud references (parse-community#654)
  docs: fixed examples for pipeline in aggregation (parse-community#661)
  Add beta notice to the GraphQL Guide (parse-community#659)
  iOS Documentation Revamp (parse-community#650)
  Fix doc for creating a subscription in javascript (parse-community#658)
  GraphQL Customisation (parse-community#652)
  added PhantAuth authData docs (parse-community#655)
  Fix typo in keys.md (parse-community#656)
  Fix typo in cloud-code.md (parse-community#657)
  add reference to afterFind, add more detail on predefined classes (parse-community#653)
  Add `keys` and `excludeKeys` options to REST docs (parse-community#649)
  document push type and priority keys for notifications (parse-community#639)
  Documentation for Sign In With Apple (parse-community#648)
  Documentation for isDataAvailable (parse-community#647)
  Remove line for 3.x (parse-community#646)
  Add documentation for query.withCount (parse-community#645)
  ...
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.

📕 Add documentation for query exclude keys
3 participants