Commit graph

1150 commits

Author SHA1 Message Date
Jesse Rosenberger
4b3bbafaf8 Editorial on "Best practices > Schema > Node Interface". 2018-04-29 19:44:02 +03:00
Jesse Rosenberger
fa0d70af73 Editorial on "Best Practices > Schema Design > Interfaces". 2018-04-29 18:51:42 +03:00
Jesse Rosenberger
0fa335ddc8 Change "Naming" to "Style conventions".
Keeping in mind that capitalization differences are not "naming"
conventions, and that there were no other recommendations for naming (e.g.
"begin each fetcher with "Get", etc.), I've changed this section to
"Style conventions".
2018-04-29 18:35:15 +03:00
Jesse Rosenberger
150423f53f
Rework Security Introspection. 2018-04-27 21:59:36 +03:00
Jesse Rosenberger
a212f5cb61
Rename page fragment to just 'introspection'. 2018-04-27 21:47:10 +03:00
Jesse Rosenberger
a4ae542e61
Re-work introduction to Security Best Practices.
While GraphQL is less susceptible to injection attacks, this introduction
made it sound like it wasn't possible, but the first paragraph then
demonstrated an injection attack and how to prevent it.
2018-04-27 21:42:04 +03:00
Jesse Rosenberger
d5fe357536
Re-work introduction on Best Practices > Performance. 2018-04-27 21:40:04 +03:00
Jesse Rosenberger
5091121228
Quick first pass, mostly spelling. 2018-04-27 19:16:00 +03:00
Jesse Rosenberger
e85fc6c347
Nits and editorial on earlier content in Schema 2018-04-27 18:18:11 +03:00
Jesse Rosenberger
02f5c467ac
Change apollo-engine title to be without grave accents. 2018-04-27 17:01:57 +03:00
Jesse Rosenberger
0482216a64
docs: API: Change "Apollo Engine" title to be apollo-engine. 2018-04-27 16:41:11 +03:00
Jesse Rosenberger
7ce3099158
Bump the hexo version, which keeps getting lowered, back to 3.7.1. 2018-04-26 23:04:38 +03:00
Evans Hauser
5f835cbbf1
docs: add short section to what's new about errors 2018-04-26 12:27:07 -07:00
Jesse Rosenberger
c09b352c95
docs: Add v2 to the versions property in _config.yml.
This should enable the dropdown box in the sidebar of the documentation.
Currently, that sidebar will be a terrible color, since it has never
appeared on Apollo documentation before and nobody has ever defined style on
it.  That'll have to be fixed in the theme itself[0].

[0]: https://github.com/meteor/meteor-theme-hexo
2018-04-26 14:35:53 +03:00
Evans Hauser
80e0c30782
docs: add missing ` in essentials/server 2018-04-25 15:25:07 -07:00
Jesse Rosenberger
b6bdfdbbad
docs: Add instruction for applyMiddleware. 2018-04-25 22:15:34 +03:00
Jesse Rosenberger
16e1286259
docs: Add color about app, and where it might be found in existing applications. 2018-04-25 14:05:27 +03:00
Jesse Rosenberger
c1744faec6
docs: Improve "apollo-server/<variant>" explanation. 2018-04-25 14:04:46 +03:00
Jesse Rosenberger
5317483a83
docs: Simplify explanation of graphql. 2018-04-25 14:04:04 +03:00
Jesse Rosenberger
6e98ba57ef
docs: Use gql template literal tag in all examples.
While the `gql` tag is not currently _required_, it does make it easier to
implement additional, development-friendly functionality in the future.

For example, it could avoid the need to question whether a string literal is
actually using Schema Definition Language (SDL) and avoid the need to
look for context clues.

By implementing these suggestions now, we can avoid the need to ask
developers to refactor in the future.
2018-04-25 14:00:33 +03:00
Jesse Rosenberger
8eaa998c43 docs: Essentials / Server (now, with middleware!) 2018-04-25 12:28:32 +03:00
Evans Hauser
cd88fbe695
add creating schema directives to advanced section 2018-04-24 15:16:11 -07:00
Jesse Rosenberger
4ff36d8575
docs: Sidebar: "Schema Development" > "Schema". (To fit on a single line.) 2018-04-24 18:00:19 +03:00
Jesse Rosenberger
88adbdbe86 Add "Next steps" for consistency with other sections. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
a2b926fbc0 Remove SCRATCHPAD. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
9145c5cc6c Fix typo in named operations. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
ed016762f7 Shorten operation name. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
f57cd6b34a docs: Variables as arguments. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
1b9d32ddb0 s/name/identifier/ for named operations. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
84c41ce21a docs: Respond to @evans feedback about programmatic introspection. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
096e86821d docs: Clarify arguments. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
9635b794fb docs: Draw attention to two of REST's downfalls: over-fetching and stiching. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
569c826470 TODO: Passing arguments as variables. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
d3ea5004f2 Essentials > Schema > Operation Names 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
937e7ff5d4 Essentials > Schema > Introspection. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
3cdbac47be Make it more clear that introspection is optional. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
11adbf5749 Variables section, WIP header 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
51b1f339e2 Essentials > Schema, Part 2 (Mostly Mutations) 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
a0c64e78c0 Essentials > Schema, Part one (mainly "Queries"). 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
b2fa5d0c7d
Merge branch 'master' into docs-overhaul 2018-04-24 16:59:22 +03:00
Jesse Rosenberger
5d7e281aa1
Pin npm to 5, at least for the time-being. (#984)
npm 6 deprecates support for Node.js 4, which is still LTS until the end of
the week.

It's probably best to take a moment and ensure that npm@6 is actually
working as we desire too, so this is just to make sure that we don't end up
with a bunch of PRs that need to be re-based/re-tested, which seems to
already be happening.
2018-04-24 16:55:52 +03:00
Jesse Rosenberger
32a83b3686
docs: Change GraphQL Subscriptions title to match package name for API. 2018-04-24 14:18:40 +03:00
Jesse Rosenberger
1e1c7fd6b2
docs: Mock out API > apollo-server. 2018-04-24 14:17:51 +03:00
Jesse Rosenberger
36a07bb3bb
docs: API reference: Link to graphql-tools. 2018-04-24 14:17:04 +03:00
David Glasser
e2df79d06c core: return PersistedQueryNotSupported for Apollo Persisted Queries (#982)
Apollo Persisted Queries is a standard for sending queries as short hashes
instead of full strings, designed to work well with GET requests. It is
implemented by servers including the Apollo Engine Proxy, and by the
apollo-link-persisted-query client.

A common configuration is to set up persisted queries on production servers but
not in development. It is still convenient to leave apollo-link-persisted-query
always on, though. While apollo-link-persisted-query can detect that servers
don't support PQs, it works better if the server actually says it doesn't
support the PQ, instead of trying to process a request without a query and
potentially printing a confusing stack trace.  This commit makes apollo-server
directly return PersistedQueryNotSupported instead of allowing confusing stack
traces to occur.
2018-04-24 06:29:07 -04:00
Evans Hauser
723b52845a
standardize organization of typeDefs using concat and fixed extend example 2018-04-23 22:46:43 -07:00
Jake Dawkins
4fae3da13e added some detail and fixed grammar (#981) 2018-04-23 22:04:15 +03:00
James Baxley
bdc2a82db8 docs: Best practices (#978)
* clean up some code examples

* add in some best practies
2018-04-23 22:01:54 +03:00
Jesse Rosenberger
e4977737e9
Rename slugs for "Essentials" pages to match other naming conventions.
Plus, slugs.

cc @JakeDawkins
2018-04-23 19:04:03 +03:00
Jesse Rosenberger
c65b7a57bf
Merge remote-tracking branch 'origin/master' into docs-overhaul 2018-04-23 15:28:29 +03:00