The Wayback Machine - https://web.archive.org/web/20260225021509/https://github.com/parse-community/parse-server/pull/5581
Skip to content

Comments

Add Docs for Server Config Definitions#5581

Merged
dplewis merged 4 commits intomasterfrom
document-definition
May 11, 2019
Merged

Add Docs for Server Config Definitions#5581
dplewis merged 4 commits intomasterfrom
document-definition

Conversation

@dplewis
Copy link
Member

@dplewis dplewis commented May 10, 2019

  • Add generated definitions to release cycle
  • Sort definitions alphabetically
  • Update ReadMe.MD
  • Update Contribution.MD
  • Fix protectedFields default
@dplewis dplewis requested review from TomWFox and acinader May 10, 2019 21:27
@codecov
Copy link

codecov bot commented May 10, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5581      +/-   ##
==========================================
+ Coverage   93.98%   94.06%   +0.07%     
==========================================
  Files         129      129              
  Lines        9194     9212      +18     
==========================================
+ Hits         8641     8665      +24     
+ Misses        553      547       -6
Impacted Files Coverage Δ
src/Options/index.js 100% <ø> (ø) ⬆️
src/Options/Definitions.js 100% <ø> (ø) ⬆️
src/Controllers/DatabaseController.js 95% <0%> (+0.1%) ⬆️
src/RestWrite.js 93.62% <0%> (+0.25%) ⬆️
src/ParseServer.js 97.08% <0%> (+3.64%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b4d915b...7750dcb. Read the comment docs.

Copy link
Contributor

@acinader acinader left a comment

Choose a reason for hiding this comment

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

one nit

super nice.

echo "<meta http-equiv='refresh' content='0; url=/parse-server/api/${DEST}'>" > "docs/api/index.html"
fi

npm run definitions
Copy link
Contributor

Choose a reason for hiding this comment

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

ok to leave, but not sure we need this, right. Since the output is committed.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added it here since people have been manually changing the file.


function doInterface(iface) {
return iface.body.properties
.sort((p1, p2) => p1.key.name > p2.key.name ? 1 : -1)
Copy link
Contributor

Choose a reason for hiding this comment

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

.sort((a, b) => a.localeCompare(b));

litteralValue = t.objectExpression(props);
literalValue = t.objectExpression(props);
}
if (type == 'ProtectedFields') {
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

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.

Minor wording suggestion

README.md Outdated
Parse Server can be configured using the following options. You may pass these as parameters when running a standalone `parse-server`, or by loading a configuration file in JSON format using `parse-server path/to/configuration.json`. If you're using Parse Server on Express, you may also pass these to the `ParseServer` object as options.

For the full list of available options, run `parse-server --help`.
For the full list of available options, run `parse-server --help` or [Parse Server Configurations](http://parseplatform.org/parse-server/api/master/ParseServerOptions.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For the full list of available options, run `parse-server --help` or [Parse Server Configurations](http://parseplatform.org/parse-server/api/master/ParseServerOptions.html).
For the full list of available options, run `parse-server --help` or take a look at [Parse Server Configurations](http://parseplatform.org/parse-server/api/master/ParseServerOptions.html).
@dplewis dplewis merged commit b9c936f into master May 11, 2019
@dplewis dplewis deleted the document-definition branch May 11, 2019 20:25
UnderratedDev pushed a commit to UnderratedDev/parse-server that referenced this pull request Mar 21, 2020
* Add Docs for Server Config Definitions

* protected field and sort alphabetically

* Add links

* nits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants