Compare commits

..

243 Commits

Author SHA1 Message Date
Tom Pytleski
e5a449b0f3 Merge branch 'develop' into articles/prism/validation.md
* develop: (79 commits)
  Update security-schemes.md
  Update api-operations.md
  Add Spec Validation (#117)
  Add File Validation (#116)
  Add Editor Configuration (#118)
  Update blocks.md
  Update subpages.md
  Update pages.md
  Update pages.md
  Update pages.md
  Update routing.md
  Update managing-headers-footers.md
  Update working-with-files.md
  Update sign-in.md
  Update edit-profile.md
  Update manage-password.md
  Update deactivate-account.md
  Update changing-your-email.md
  Update create-project.md
  Update sign-out.md
  ...

# Conflicts:
#	articles/prism/validation.md
2018-02-01 14:52:56 -06:00
Robert Wallach
eeb3150906 Update security-schemes.md 2018-02-01 14:38:06 -06:00
Robert Wallach
f9b5a1bf0f Update api-operations.md 2018-02-01 14:14:56 -06:00
Ross McDonald
3d17366009 Add Spec Validation (#117)
* Add first version of spec validation article.

* Update validate-spec.md

* Rename validate-spec -> openapi-validation. Update OAS -> OpenAPI. Add callout regarding v3 support. Add related section at bottom.

* use a blockquote + latest markdown annotation idea
2018-02-01 12:33:38 -06:00
Ross McDonald
9708c53ca7 Add File Validation (#116)
* Add first version of file validation article.

* Update file-validation.md

* File validation part two.

* Update file-validation.md

* Update OAS -> OpenAPI. Add blurb at end referencing the openapi-validation article.

* Add file ending to linked article.

* Update blurb

* Update file-validation.md
2018-02-01 12:23:57 -06:00
Ross McDonald
a2309b2dd3 Add Editor Configuration (#118)
* First pass at the editor configuration article.

* Update editor-configuration.md

* Update editor-configuration article.

* Update editor-configuration.md

* Update editor-configuration.md

* Correct capitalization in title. Add links to testing environment variables.

* Update editor-configuration.md
2018-02-01 12:08:28 -06:00
Robert Wallach
c472d02049 Update blocks.md 2018-01-30 17:19:23 -06:00
Robert Wallach
9d3ce47c7c Update subpages.md 2018-01-30 17:16:07 -06:00
Robert Wallach
cda809d369 Update pages.md 2018-01-30 17:12:55 -06:00
Robert Wallach
c0260f2a71 Update pages.md 2018-01-30 17:12:35 -06:00
Robert Wallach
678feabe91 Update pages.md 2018-01-30 17:12:02 -06:00
Robert Wallach
a78a0fc179 Update routing.md 2018-01-30 17:10:14 -06:00
Robert Wallach
c488d07f39 Update managing-headers-footers.md 2018-01-30 17:08:19 -06:00
Robert Wallach
d3a2fb1f06 Update working-with-files.md 2018-01-30 16:58:11 -06:00
Robert Wallach
6a540e45ee Update sign-in.md 2018-01-30 16:43:25 -06:00
Robert Wallach
0ce15301bf Update edit-profile.md 2018-01-30 16:41:20 -06:00
Robert Wallach
ca9e6f3e19 Update manage-password.md 2018-01-30 16:26:53 -06:00
Robert Wallach
64e1a77e15 Update deactivate-account.md 2018-01-30 16:23:37 -06:00
Robert Wallach
6df0dae372 Update changing-your-email.md 2018-01-30 16:17:38 -06:00
Robert Wallach
6aaf7aaec1 Update create-project.md 2018-01-30 16:15:42 -06:00
Robert Wallach
a2be7602f3 Update sign-out.md 2018-01-30 16:07:08 -06:00
Robert Wallach
816c9bb52f Update sign-out.md 2018-01-30 16:04:16 -06:00
Robert Wallach
46d5e2d87c Update invite-people-team.md 2018-01-30 16:02:37 -06:00
Robert Wallach
36ef5aec93 Update change-member-role.md 2018-01-30 15:52:56 -06:00
Marc MacLeod
ece3638968 Add files via upload 2018-01-30 12:01:35 -06:00
Marc MacLeod
d54a9ccb79 added some theoretical front matter 2018-01-30 12:00:28 -06:00
Robert Wallach
ef47e9c0e6 Update changing-your-username.md 2018-01-29 17:48:58 -06:00
Robert Wallach
eb082fec9d Update visibility.md 2018-01-29 17:47:37 -06:00
Robert Wallach
e4e36aae5c Update managing-people.md 2018-01-29 17:45:11 -06:00
Robert Wallach
e4ebb0b2af Update create-org.md 2018-01-29 17:43:06 -06:00
Robert Wallach
868b3eab6d Update roles.md 2018-01-29 17:39:04 -06:00
Robert Wallach
368ac085be Update remove-people.md 2018-01-29 17:36:02 -06:00
Robert Wallach
9fe2691e7f Update transferring-ownership.md 2018-01-29 17:33:49 -06:00
Robert Wallach
a6e7a87519 Update customize-org.md 2018-01-29 17:32:12 -06:00
Robert Wallach
2d8401f236 Update delete-org.md 2018-01-29 17:21:43 -06:00
Robert Wallach
74d5a3c372 Update create-team.md 2018-01-29 17:20:12 -06:00
Robert Wallach
28dcd32d76 Update remove-people.md 2018-01-29 17:17:56 -06:00
Robert Wallach
fda0fd56ee Update add-people.md 2018-01-29 17:15:49 -06:00
Robert Wallach
bbadc7acd7 Update member-roles.md 2018-01-29 17:11:44 -06:00
Robert Wallach
5a1db4f155 Update customize-team.md 2018-01-29 17:02:27 -06:00
Robert Wallach
e8faaf0de9 Update transfer-ownership.md 2018-01-29 16:59:45 -06:00
Robert Wallach
bc79e38a0f Create run-test-url.md 2018-01-29 16:11:26 -06:00
Robert Wallach
7bbe0d9c3c Create run-test-terminal.md 2018-01-29 16:11:12 -06:00
Robert Wallach
4b33f42e34 Create run-test-stoplight.md 2018-01-29 16:10:57 -06:00
Robert Wallach
775f7190a4 Create variables-context.md 2018-01-29 16:10:33 -06:00
Robert Wallach
1b6644205f Delete using-variables.md 2018-01-29 16:10:10 -06:00
Robert Wallach
386552357e Update environments.md 2018-01-29 16:08:39 -06:00
Robert Wallach
a0107403ff Create variables-environment.md 2018-01-29 16:07:59 -06:00
Robert Wallach
1c6c872f3d Delete run-tests.md 2018-01-29 16:06:50 -06:00
Robert Wallach
52142e978b Create variables-overview.md 2018-01-29 16:06:33 -06:00
Marc MacLeod
4695685285 cleanup initial faqs 2018-01-28 17:00:03 -06:00
Robert Wallach
2933c31698 Uploaded by https://stackedit.io/ 2018-01-26 16:37:19 -06:00
Robert Wallach
2947b5c9b0 Uploaded by https://stackedit.io/ 2018-01-26 16:36:36 -06:00
Robert Wallach
580783553d Uploaded by https://stackedit.io/ 2018-01-26 16:34:35 -06:00
Robert Wallach
50447580b5 Uploaded by https://stackedit.io/ 2018-01-26 16:31:32 -06:00
Robert Wallach
f2dc5c6cc5 Uploaded by https://stackedit.io/ 2018-01-26 16:30:31 -06:00
Robert Wallach
c41dba8cf9 Uploaded by https://stackedit.io/ 2018-01-26 16:29:29 -06:00
Robert Wallach
8b88f0b48a Uploaded by https://stackedit.io/ 2018-01-26 16:28:28 -06:00
Robert Wallach
cedfb797b7 Uploaded by https://stackedit.io/ 2018-01-26 16:27:27 -06:00
Robert Wallach
ebad136d66 Uploaded by https://stackedit.io/ 2018-01-26 16:22:45 -06:00
Robert Wallach
fbe4ec8182 Uploaded by https://stackedit.io/ 2018-01-26 16:22:43 -06:00
Robert Wallach
85c77a7206 Uploaded by https://stackedit.io/ 2018-01-26 16:22:42 -06:00
Robert Wallach
5112b4fde7 Uploaded by https://stackedit.io/ 2018-01-26 16:21:40 -06:00
Robert Wallach
d04ec87521 Uploaded by https://stackedit.io/ 2018-01-26 16:20:39 -06:00
Robert Wallach
363e543cf0 Uploaded by https://stackedit.io/ 2018-01-26 16:19:37 -06:00
Robert Wallach
3c49e1700a Uploaded by https://stackedit.io/ 2018-01-26 16:18:36 -06:00
Robert Wallach
cfd22a0e52 Uploaded by https://stackedit.io/ 2018-01-26 16:17:35 -06:00
Robert Wallach
2ab496d1a7 Uploaded by https://stackedit.io/ 2018-01-26 16:16:33 -06:00
Robert Wallach
acf3e3dee4 Uploaded by https://stackedit.io/ 2018-01-26 16:15:32 -06:00
Robert Wallach
e3310db0cc Uploaded by https://stackedit.io/ 2018-01-26 16:14:30 -06:00
Robert Wallach
b7565f52de Uploaded by https://stackedit.io/ 2018-01-26 16:13:29 -06:00
Robert Wallach
ffee7f7acd Uploaded by https://stackedit.io/ 2018-01-26 16:09:25 -06:00
Robert Wallach
7e322986cf Uploaded by https://stackedit.io/ 2018-01-26 16:08:24 -06:00
Robert Wallach
a2879cd706 Uploaded by https://stackedit.io/ 2018-01-26 16:07:22 -06:00
Robert Wallach
07bbf40901 Uploaded by https://stackedit.io/ 2018-01-26 16:06:21 -06:00
Robert Wallach
a530b3c44f Uploaded by https://stackedit.io/ 2018-01-26 16:01:44 -06:00
Robert Wallach
408680ab64 Uploaded by https://stackedit.io/ 2018-01-26 16:01:42 -06:00
Robert Wallach
5abf65427c Uploaded by https://stackedit.io/ 2018-01-26 16:00:41 -06:00
Robert Wallach
cc8c70c8b8 Delete validation.md 2018-01-26 16:00:37 -06:00
Robert Wallach
b8d3b3bee9 Uploaded by https://stackedit.io/ 2018-01-26 15:59:41 -06:00
Robert Wallach
44b16dbfbb Uploaded by https://stackedit.io/ 2018-01-26 15:59:17 -06:00
Robert Wallach
91c560d07e Uploaded by https://stackedit.io/ 2018-01-26 15:57:39 -06:00
Robert Wallach
58bce9a9ee Uploaded by https://stackedit.io/ 2018-01-26 15:57:38 -06:00
Robert Wallach
963186c49f Uploaded by https://stackedit.io/ 2018-01-26 15:51:19 -06:00
Robert Wallach
6bd767f92c Update validation.md 2018-01-26 15:49:56 -06:00
Robert Wallach
02e2b83540 Update overview.md 2018-01-26 14:57:01 -06:00
Robert Wallach
15ca8e6d55 Update overview.md 2018-01-25 13:13:34 -06:00
Robert Wallach
762e293204 Update delete-team.md 2018-01-25 13:05:26 -06:00
Robert Wallach
2240e0f773 Update delete-team.md 2018-01-25 13:03:57 -06:00
Robert Wallach
61b346fd99 Update delete-team.md 2018-01-25 13:02:51 -06:00
Robert Wallach
12b6bcfd8e Update subpages.md 2018-01-25 12:45:30 -06:00
Robert Wallach
6dd795e74d Update routing.md 2018-01-25 12:43:57 -06:00
Robert Wallach
eb4302902f Update ref-other-sources-hubs.md 2018-01-25 12:42:49 -06:00
Robert Wallach
43406ebf16 Update pages.md 2018-01-25 12:39:56 -06:00
Robert Wallach
caefcb2e24 Update managing-headers-footers.md 2018-01-25 12:38:35 -06:00
Robert Wallach
933e64b73b Delete Create-Pages.gif 2018-01-25 12:37:37 -06:00
Robert Wallach
24abeb43ee Delete Ref-Other-Sources-Hubs.gif 2018-01-25 12:37:26 -06:00
Robert Wallach
32e285d922 Delete Creat-Subpages.gif 2018-01-25 12:37:15 -06:00
Robert Wallach
a045df44c7 Add files via upload 2018-01-25 12:36:44 -06:00
Robert Wallach
d1f10999bb Delete Managing Headers and Footers.gif 2018-01-25 12:34:28 -06:00
Robert Wallach
cc6bd4a837 Update managing-headers-footers.md 2018-01-25 12:31:36 -06:00
Robert Wallach
53de836f65 Update blocks.md 2018-01-25 12:30:00 -06:00
Robert Wallach
aa6b01b334 Update what-is-stoplight.md 2018-01-25 12:20:47 -06:00
Robert Wallach
0fd0ec347d Add files via upload 2018-01-25 12:19:01 -06:00
Robert Wallach
d5956b2c53 Add files via upload 2018-01-25 12:16:51 -06:00
Tom Pytleski
3b66566ebe Update image links
finishes #67
2018-01-25 12:11:08 -06:00
Tom Pytleski
58ae124c82 Prism validation article 2018-01-25 11:48:11 -06:00
Ross McDonald
4cf982b04c Create continuous-integration-travis.md (#109) 2018-01-24 16:16:26 -06:00
Robert Wallach
7b13e7f568 Update tutorial.md 2018-01-24 15:55:51 -06:00
Marc MacLeod
42becd564b Create specification.md 2018-01-24 15:37:00 -06:00
Robert Wallach
27992ef3d6 Update faq.md 2018-01-24 15:34:49 -06:00
Marc MacLeod
860cd5cabe Create run-prism-local.md 2018-01-24 15:33:25 -06:00
Robert Wallach
27c6f4ce6b Update overview.md 2018-01-24 15:32:48 -06:00
Robert Wallach
f0840669f6 Create delete-team.md 2018-01-24 15:31:10 -06:00
Robert Wallach
00f2d6a35e Create transfer-ownership.md 2018-01-24 15:28:13 -06:00
Robert Wallach
956dde826c Create customize-team.md 2018-01-24 15:25:06 -06:00
Robert Wallach
4712aeb6b7 Update tutorial.md 2018-01-24 15:22:32 -06:00
Robert Wallach
968d885c7f Update tutorial.md 2018-01-24 15:21:52 -06:00
Robert Wallach
2b7e32f7ab Create member-roles.md 2018-01-24 15:17:35 -06:00
Robert Wallach
67fd6e9f4a Create remove-people.md 2018-01-24 15:14:18 -06:00
Robert Wallach
70d7256026 Create add-people.md 2018-01-24 15:11:30 -06:00
Robert Wallach
d4ef5515f5 Update create-team.md 2018-01-24 15:02:46 -06:00
Robert Wallach
7b7eb4a903 Create create-team.md 2018-01-24 15:01:30 -06:00
Robert Wallach
868a9909a9 Create delete-org.md 2018-01-24 14:59:22 -06:00
Robert Wallach
60dacf29a2 Update transferring-ownership.md 2018-01-24 14:56:20 -06:00
Robert Wallach
f2e54794ff Create customize-org.md 2018-01-24 14:49:53 -06:00
Robert Wallach
0c8c5951a3 Update roles.md 2018-01-24 14:47:30 -06:00
Robert Wallach
18ef0da760 Create remove-people.md 2018-01-24 14:43:25 -06:00
Robert Wallach
706e7a2d34 Update managing-people.md 2018-01-24 14:40:31 -06:00
Robert Wallach
de83098575 Create create-org.md 2018-01-24 14:34:38 -06:00
Robert Wallach
56eb6dfe8d Update visibility.md 2018-01-24 12:54:37 -06:00
Robert Wallach
5d6772598a Create change-member-role.md 2018-01-24 12:52:09 -06:00
Robert Wallach
9dbd5b536c Update create-project.md 2018-01-24 12:48:09 -06:00
Robert Wallach
df09bad74a Create invite-people-team.md 2018-01-24 12:45:42 -06:00
Robert Wallach
dadbe4e7ad Create create-project.md 2018-01-24 12:42:32 -06:00
Robert Wallach
315d2db9fa Create deactivate-account.md 2018-01-24 12:34:07 -06:00
Robert Wallach
09c3b75729 Create sign-out.md 2018-01-24 12:31:24 -06:00
Robert Wallach
5558f8c4ef Update changing-your-email.md 2018-01-24 12:29:11 -06:00
Robert Wallach
fc9da7e625 Update changing-your-username.md 2018-01-24 12:26:46 -06:00
Robert Wallach
1e921d5c25 Update changing-your-username.md 2018-01-24 12:26:31 -06:00
Robert Wallach
3b097cdc76 Delete profile-management.md 2018-01-24 12:25:00 -06:00
Robert Wallach
f0f714cf1a Delete password-management.md 2018-01-24 12:24:41 -06:00
Robert Wallach
9d23defd10 Create manage-password.md 2018-01-24 12:23:15 -06:00
Robert Wallach
ba66e2c316 Create edit-profile.md 2018-01-24 12:20:20 -06:00
Robert Wallach
f7dee501ab Create sign-in.md 2018-01-24 12:17:11 -06:00
Robert Wallach
7409299aba Delete onboard-organization.md 2018-01-24 12:14:33 -06:00
Robert Wallach
6a7f0f7eb3 Create organization-owner-introduction.md 2018-01-24 12:11:44 -06:00
Robert Wallach
06a7f4755b Create new-user-introduction.md 2018-01-24 12:00:07 -06:00
Robert Wallach
f762167c80 Update what-is-stoplight.md 2018-01-24 11:51:27 -06:00
Robert Wallach
fb7f97932f Update visual-code-view.md 2018-01-24 11:37:33 -06:00
Robert Wallach
359821b73d Create visual-code-view.md 2018-01-24 11:34:20 -06:00
Robert Wallach
eb4cf5f133 Update ref-other-sources-hubs.md 2018-01-24 11:25:58 -06:00
Robert Wallach
5c0a69e385 Update blocks.md 2018-01-24 11:25:22 -06:00
Robert Wallach
ece5140d47 Update subpages.md 2018-01-24 11:24:46 -06:00
Robert Wallach
784bf2c8ea Update pages.md 2018-01-24 11:24:07 -06:00
Robert Wallach
326c398ed2 Update routing.md 2018-01-24 11:23:25 -06:00
Robert Wallach
3cbd0d33ec Update managing-headers-footers.md 2018-01-24 11:22:38 -06:00
Marc MacLeod
d1b15e1738 Rename articles/modeling/leverage-openapi.md to articles/testing/leverage-openapi.md 2018-01-23 17:30:12 -06:00
Marc MacLeod
63ea8aa991 Create overview.md 2018-01-23 17:20:48 -06:00
Robert Wallach
b6a037e39b Rename articles/editor/validate-spec.md to articles/modeling/validate-spec.md 2018-01-23 16:12:17 -06:00
Robert Wallach
8b676277ef Rename articles/editor/using-variables.md to articles/testing/using-variables.md 2018-01-23 16:11:28 -06:00
Robert Wallach
879f955225 Rename articles/editor/themes.md to articles/hubs/themes.md 2018-01-23 16:11:00 -06:00
Robert Wallach
076143db8d Rename articles/editor/subpages.md to articles/hubs/subpages.md 2018-01-23 16:10:44 -06:00
Robert Wallach
03b3498174 Rename articles/editor/shared-params-responses.md to articles/modeling/shared-params-responses.md 2018-01-23 16:10:25 -06:00
Robert Wallach
52ff953b87 Rename articles/editor/send-http-requests.md to articles/testing/send-http-requests.md 2018-01-23 16:09:50 -06:00
Robert Wallach
e9e3630655 Rename articles/editor/sending-http-requests.md to articles/modeling/sending-http-requests.md 2018-01-23 16:09:33 -06:00
Robert Wallach
58b38bb9c4 Rename articles/editor/security-schemes.md to articles/modeling/security-schemes.md 2018-01-23 16:08:35 -06:00
Robert Wallach
553cf66c40 Rename articles/editor/scripting.md to articles/testing/scripting.md 2018-01-23 16:08:06 -06:00
Robert Wallach
804dfd8175 Rename articles/editor/scenarios-introduction.md to articles/testing/scenarios-introduction.md 2018-01-23 16:07:31 -06:00
Robert Wallach
2a4ad4766e Rename articles/editor/scenario-spec.md to articles/testing/scenario-spec.md 2018-01-23 16:07:08 -06:00
Robert Wallach
2c14d8605f Rename articles/editor/run-tests.md to articles/testing/run-tests.md 2018-01-23 16:06:43 -06:00
Robert Wallach
afe1b5afbb Rename articles/editor/routing.md to articles/hubs/routing.md 2018-01-23 16:06:17 -06:00
Robert Wallach
d9f9c33beb Rename articles/editor/reference-spec.md to articles/modeling/reference-spec.md 2018-01-23 16:05:52 -06:00
Robert Wallach
d5078ee70f Rename articles/editor/ref-other-sources-hubs.md to articles/hubs/ref-other-sources-hubs.md 2018-01-23 16:05:25 -06:00
Robert Wallach
419046ffb0 Rename articles/editor/ref-other-scenarios.md to articles/testing/ref-other-scenarios.md 2018-01-23 16:05:02 -06:00
Robert Wallach
05d706a65a Rename articles/editor/publishing.md to articles/hubs/publishing.md 2018-01-23 16:04:35 -06:00
Robert Wallach
aef90544ff Rename articles/editor/polymorphic-objects.md to articles/modeling/polymorphic-objects.md 2018-01-23 16:03:57 -06:00
Robert Wallach
94aa79c7a3 Rename articles/editor/pass-data-steps.md to articles/testing/pass-data-steps.md 2018-01-23 16:03:19 -06:00
Robert Wallach
b6230ec679 Rename articles/editor/pages.md to articles/hubs/pages.md 2018-01-23 16:02:58 -06:00
Robert Wallach
0ac9bb3f81 Rename articles/editor/open-ended-objects.md to articles/modeling/open-ended-objects.md 2018-01-23 16:02:37 -06:00
Robert Wallach
4ecb7a9a91 Rename articles/editor/object-inheritance.md to articles/modeling/object-inheritance.md 2018-01-23 16:02:12 -06:00
Robert Wallach
2356443475 Rename articles/editor/modeling-introduction.md to articles/modeling/modeling-introduction.md 2018-01-23 16:01:51 -06:00
Robert Wallach
7681b625f8 Rename articles/editor/managing-headers-footers.md to articles/hubs/managing-headers-footers.md 2018-01-23 16:01:30 -06:00
Robert Wallach
0bd36067d7 Rename articles/editor/leverage-openapi.md to articles/modeling/leverage-openapi.md 2018-01-23 16:01:03 -06:00
Robert Wallach
f50a3d5426 Rename articles/editor/json-introduction.md to articles/modeling/json-introduction.md 2018-01-23 16:00:10 -06:00
Robert Wallach
d70623d305 Rename articles/editor/hubs-introduction.md to articles/hubs/hubs-introduction.md 2018-01-23 15:59:44 -06:00
Robert Wallach
8634736f7b Rename articles/editor/generating-schemas.md to articles/modeling/generating-schemas.md 2018-01-23 15:59:12 -06:00
Robert Wallach
9a061beb06 Rename articles/editor/duplication-refs.md to articles/modeling/duplication-refs.md 2018-01-23 15:58:03 -06:00
Marc MacLeod
113e0758a3 re-organize editor articles, add issues overview 2018-01-23 15:50:48 -06:00
Robert Wallach
fa0e42a971 Create subpages.md 2018-01-23 13:31:39 -06:00
rowa97
09449d687d Create publishing.md 2018-01-22 10:55:03 -06:00
rowa97
4611a85b73 Create themes.md 2018-01-22 10:54:46 -06:00
rowa97
8ea5c3d7a9 Create ref-other-sources-hubs.md 2018-01-22 10:54:30 -06:00
rowa97
27793ffddc Create blocks.md 2018-01-22 10:54:00 -06:00
rowa97
669c45a46f Create pages.md 2018-01-22 10:53:10 -06:00
rowa97
2a84239ddd Create managing-headers-footers.md 2018-01-22 10:52:34 -06:00
rowa97
b9438183f3 Create routing.md 2018-01-22 10:52:12 -06:00
rowa97
61642fb61a Create hubs-introduction.md 2018-01-22 10:51:35 -06:00
rowa97
71c73546e2 Create continuous-integration.md 2018-01-19 18:24:13 -06:00
rowa97
00ba0c5114 Create leverage-openapi.md 2018-01-19 18:23:49 -06:00
rowa97
ce6fc78151 Create ref-other-scenarios.md 2018-01-19 18:23:31 -06:00
rowa97
e996fbd118 Create scripting.md 2018-01-19 18:23:16 -06:00
rowa97
545eb86103 Create sending-http-requests.md 2018-01-19 18:22:53 -06:00
rowa97
5506f33e0b Create using-variables.md 2018-01-19 18:22:38 -06:00
rowa97
1adf971e2c Create pass-data-steps.md 2018-01-19 18:22:27 -06:00
rowa97
64298bbbb6 Create run-tests.md 2018-01-19 18:22:10 -06:00
rowa97
d6691b8f35 Create scenario-spec.md 2018-01-19 18:21:47 -06:00
rowa97
eb822d4052 Create scenarios-introduction.md 2018-01-19 18:20:38 -06:00
rowa97
cfb5af43b7 Create generating-schemas.md 2018-01-19 18:08:41 -06:00
rowa97
13fcf7d748 Create duplication-refs.md 2018-01-19 18:08:16 -06:00
rowa97
27e6da3379 Create adding-validations.md 2018-01-19 18:07:53 -06:00
rowa97
6106e43fb7 Create object-inheritance.md 2018-01-19 18:07:27 -06:00
rowa97
adbcbef660 Create polymorphic-objects.md 2018-01-19 18:07:07 -06:00
rowa97
bc058733c5 Create open-ended-objects.md 2018-01-19 18:06:38 -06:00
rowa97
98c5bc1292 Create json-introduction.md 2018-01-19 18:06:09 -06:00
rowa97
209deae586 Rename introduction.md to modeling-introduction.md 2018-01-19 18:00:28 -06:00
rowa97
ff97a4253b Create validate-spec.md 2018-01-19 17:55:18 -06:00
rowa97
d6fe7273ac Create send-http-requests.md 2018-01-19 17:54:59 -06:00
rowa97
2ed37b57aa Create reference-spec.md 2018-01-19 17:54:35 -06:00
rowa97
c21ae72a7b Create shared-params-responses.md 2018-01-19 17:54:17 -06:00
rowa97
20a7e62fac Create security-schemes.md 2018-01-19 17:53:52 -06:00
rowa97
0b3954a7d2 Create api-models.md 2018-01-19 17:53:33 -06:00
rowa97
e12d0650eb Create api-operations.md 2018-01-19 17:53:17 -06:00
rowa97
9ae1c94fcb Create crud-builder.md 2018-01-19 17:52:54 -06:00
rowa97
9689a4cf03 Rename introduction to introduction.md 2018-01-19 17:52:30 -06:00
rowa97
d17d37aaa6 Create build-api-library.md 2018-01-19 17:52:08 -06:00
rowa97
2c6e719cf0 Create introduction 2018-01-19 17:51:29 -06:00
rowa97
62a9c8a670 Create mention-people.md 2018-01-19 17:40:58 -06:00
rowa97
f07efc3d2e Create attaching-issues-to-files.md 2018-01-19 17:40:34 -06:00
rowa97
32a57d5f14 Create closing-issues.md 2018-01-19 17:40:10 -06:00
rowa97
08e33a9a08 Create replying-to-issues.md 2018-01-19 17:38:59 -06:00
rowa97
41a549c4a5 Create creating-issues.md 2018-01-19 17:34:38 -06:00
rowa97
084e67cc2a Create editor-configuration.md 2018-01-19 17:29:37 -06:00
rowa97
e25d827dfc Create environments.md 2018-01-19 17:29:11 -06:00
rowa97
a932203830 Create file-validation.md 2018-01-19 17:28:49 -06:00
rowa97
346db7f494 Create view-history-changes.md 2018-01-19 17:28:26 -06:00
rowa97
85cb178794 Create faq.md 2018-01-19 17:26:08 -06:00
rowa97
2508a37e08 Rename onboard-organization to onboard-organization.md 2018-01-19 17:15:23 -06:00
rowa97
ac2ad71424 Create onboard-organization 2018-01-19 17:14:42 -06:00
Marc MacLeod
b8fc3b43af added file explorer gif 2018-01-19 16:07:30 -06:00
Marc MacLeod
a3098cdf07 Merge branch 'develop' of https://github.com/stoplightio/docs into develop
# Conflicts:
#	articles/editor/working-with-files.md
2018-01-19 16:01:29 -06:00
Marc MacLeod
46d408c71f add initial images 2018-01-19 16:00:13 -06:00
rowa97
32f5bce856 Create working-with-files.md 2018-01-19 15:49:19 -06:00
136 changed files with 1298 additions and 6 deletions

13
TOC.md
View File

@@ -1,4 +1,12 @@
* Platform
---
title: Stoplight Help
description: 'Bout time.
theme: ./theme.css
javascript: ./global.js
nav: [['Platform'], [], ['Editor']]
---
* ![Platform](./logo.png "Platform")
* Getting Started
* [What is Stoplight?](./articles/getting-started/what-is-stoplight.md)
* Getting started for new users
@@ -129,9 +137,6 @@
* Pages
* Subpages
* Blocks
* Overview
* Text
* ...
* Referencing / Embedding Other Data Sources
* Overview
* OpenAPI Specifications

View File

@@ -0,0 +1,13 @@
# Change your Email Address
![](/assets/gifs/account-info.gif)
## What
Changing your email address is easy as pie
## How
1. Click on your **username** in the top right
2. Click on the **Account** button.
3. In the **Basic Info** section, replace the email listed with one you would like to change to
4. Click **Save** and youre all done

View File

@@ -0,0 +1,12 @@
# Change Your Username
![](../../assets/gifs/account-info.gif)
## What
You can change your username at any time
## How
1. Click on your current **username** in the top right
2. Click on **Account**
3. Under **Basic Info** input a new username
4. Click **Save**

View File

@@ -0,0 +1,8 @@
# Deactivate Your Stoplight Account
## What
* We're sorry to see you leave. Come back soon!
## How
1. Email [support@stoplight.io](mailto:support@stoplight.io) with your deactivation request
2. We'll take care of the rest

View File

@@ -0,0 +1,22 @@
# Edit your Profile
![](../../assets/gifs/account-info.gif)
## What
* In your profile you can edit things like:
* Basic Info
* Username
* Name
* Email
* Upload a profile image
* Change Password
## How
1. Select your **Username** in the top right corner
2. Click **Account**
3. Make your edits in **Basic Info** then click **Save**
* You can also click **Reset** if you would like to start from scratch
4. Upload a profile image
5. Make your edits in Change Password then click **Change Password**
* Password must be at least 6 characters

View File

@@ -0,0 +1,14 @@
# Manage Your Password
![](../../assets/gifs/account-info.gif)
## What
* If youve forgotten the password you use to sign in to Stoplight; you can easily reset it at any time
## What
1. At the login page select **Forgot Password?**
2. Input your email in the space provided
3. Click **Send Email Link**
4. An email will be sent with a link to your email address
5. Click on the link and you will be sent to an email reset page
6. Choose a new password and Voila

View File

@@ -0,0 +1,25 @@
# Sign In To Stoplight
## What
* There are two separate options for creating your snazzy new Stoplight account:
* Login with GitHub
* Create a new account
## How
### Login with Github
1. Click **Login with Github**
2. A window will popup asking you to authorize access to your Github account
3. Click **Authorize stoplightio**
### To Create a New Account
1. Click on **Join**
2. Fill in your **Name**
3. Create a **Username**
4. Input the **Email** you want associated with this account
5. Create a **Password**
* Password must be more than 6 characters
6. Click **Join Stoplight**

View File

@@ -0,0 +1,11 @@
# Sign Out of Stoplight
![](../../assets/gifs/sign-out.gif)
## What
* By default, Stoplight remains open. If you wish to sign out follow these quick and easy steps
## How
1. Click on your **username** in the top right corner
2. In the dropdown menu select **Sign Out**
3. All set, come back soon!

View File

@@ -0,0 +1,33 @@
# Web & Desktop App
Stoplight has a desktop app! Download the appropriate version [here](https://stoplight.io/download) .
## Web or Local?
The main difference between the Stoplight desktop app and the web app is that the desktop app can store requests and test data offline. The desktop app can also connect with APIs that are behind firewalls or otherwise not available on the public internet (localhost as well).
## Local Prism
When you start the Stoplight desktop app, it will start an instance of Prism on http://localhost:4010. The desktop Prism instance is identical to the downloadable Prism binary run manually from your terminal. When you run local tests in the desktop app, it automatically calls a local Prism instance with the correct arguments and spec files.
## Local Save
* The Stoplight desktop app can read/write specification files on your local file system. This is perfect for generating specification outside of Stoplight (like from code), want to use version control systems like Git, or want to use your favorite IDE to work on a spec.
* This feature is **NOT** available in the web app
the web app
<!--stackedit_data:
eyJoaXN0b3J5IjpbMTU3NDc5MjY0XX0=
-->

View File

@@ -0,0 +1,35 @@
# Configuration with the `.stoplight.yml` File
This document describes the usage of `.stoplight.yml`, the file that is used by the Stoplight editor to manage its configuration.
It is placed in the root of your project and allows you to configure editor settings and environments that will apply to **all** users of the project. This allows you to share commonly-used settings between members of your team directly.
You can make changes to the `.stoplight.yml` file by opening it:
![](../../assets/images/editor-configuration.png)
### Editor Configuration
- **defaultFile**: The `defaultFile` setting allows you to control which file is displayed to read-only users when they navigate to the project. This can be useful to show them a particular markdown or hub on first load.
### Environments
![](../../assets/images/editor-configuration2.png)
Environments make it easy to auto-populate variables (hostnames, ports, passwords, etc.) used by specifications and scenarios. Read more about them [here](../testing/variables-environment.md).
The environments and variables defined in the `.stoplight.yml` are shared amongst all users, which makes this a good place to define common or shared variables, such as the url host for a particular API + environment.
There are three environments included with a new project:
* __Default__ - The __Default__ environment is used by the Stoplight editor when first logging in and if no other environment has been selected. This is commonly used for variables needed for development and prototyping.
* __Staging__ - The __Staging__ environment is automatically created for the storing of"staging" or "pre-production" variables and settings.
* __Production__ - The __Production__ environment is automatically created for the storing of production variables and settings.
These environments can be customized by editing the `environments` key of the `.stoplight.yml` file. To add a new environment, simply add a new key to the `environments` property, and set the value to an empty object or an object with default variables to share amongst your team.
***
**Related**
* [Testing Environment Variables](../testing/variables-environment.md)

View File

@@ -0,0 +1,25 @@
# Environments
![](../../assets/gifs/editor-configuration.gif)
The Stoplight editor includes an embedded configuration system that can be used to auto-populate environment information and other variables (hostnames, ports, passwords, etc.) utilized by specifications, scenarios, or collections. To setup the editor configuration, click the icon towards the top right of the editor screen immediately to the left of your username.
![](../../assets/images/editor-configuration.png)
## Private Variables
The left-half of the configuration window is dedicated to "Private Variables", which are variables that are _only_ stored locally on your system and are never sent to Stoplight. Private Variables should be reserved for secrets specific to you, such as user-specific passwords, API keys, and other pieces of sensitive data.
## Resolved Variables
The right-half of the configuration window displays "Resolved Variables", which is a read-only view of the variables currently exposed to your editor based on your current environment. These variables are stored in the `.stoplight` file included in your project (under "Config" in the File Explorer). To update the default or environment-specific variables stored in Stoplight, click the "Manage Environments" button under the configuration window.
![](../../assets/gifs/editor-configuration2.gif)
Variables stored in your configuration are in JSON, and can be referenced using the following format:
```
{$$.env.myVariable}
```
Where `myVariable` is the name of the variable in your configuration.

View File

@@ -0,0 +1,27 @@
# File Validation
![](../../assets/gifs/file-validation-OpenAPI-spec.gif)
File validation is the process of checking a file's syntax and structure to make sure it meets specific requirements. Stoplight's validation ensures file edits are in the correct format. This is especially helpful while editing structured file formats (e.g. OpenAPI documents) so that any errors can be resolved quickly and efficiently.
File validation is run after every file edit to make sure no errors were introduced. A notification will appear if validation errors were introduced so that they can be resolved before attempting to save. If a validation error is detected, an alert will appear with an explanation of the issue and where it occurred.
![](../../assets/images/file-validation-error-overview.png)
Validation failures come in two levels:
* __Warnings__ - A warning is generated if the validation process found a non-critical issue that did not interrupt the processing of the document. As an example, inclusion of non-standard fields in an OpenAPI document will display as a warning.
* __Errors__ - An error is generated if the validation process found a critical issue that prevented the processing of the document. As an example, not including the correct fields in an OpenAPI document will display as an error.
Different types of file validations are used throughout the Stoplight platform. At a high level, file validations aim to identify the following two groups of errors:
* __Syntax__ - Most files stored in Stoplight are either JSON or YAML format, so they must always adhere to the JSON/YAML formatting standards. If anything typed into the editor does not meet the format criteria, it will be rejected with a notification pointing to where the syntax error occurred. _Syntax errors will prevent the file from being saved until all errors are resolved._
* __Correctness__ - Certain files stored within Stoplight must adhere to high-level specifications to ensure they are able to be read and processed correctly. The OAS/Swagger specification is one such standard. It is critical that every OAS document stored in Stoplight meet these standards. If an error is detected in any document, either an error or warning will be generated with a description of the issue.
***
**Related**
* [OpenAPI Validation](../modeling/openapi-validation.md)

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,7 @@
# Visual & Code Views
![](../../assets/gifs/editor-visual-toggle.gif)
Stoplight NEXT now has a toggle for switching between our visual editor and our code editor. If you prefer working with code, need to paste in some OAS, or just want to make changes manually, switch over to the code editor. This new feature is included in all our editors including Hubs, Modeling, and Scenarios.
<callout> New Feature! Any changes made in the code editor will automatically populate the visual editor. </>

View File

@@ -1 +1,24 @@
# Working with Files
![](../../assets/gifs/fileexplorer.gif)
As part of our effort to make the Stoplight platform more flexible and familiar we added a file explorer to Stoplight NEXT. You can now see all your files sorted by filetype in one central location within Projects. File types include:
* .hub (Hub/Docs Files)
* .oas2 (Modeling Files)
* .scenarios (Scenario/Testing FIles)
* .prism (Prism Files)
* .md (Markdown Files)
## File Explorer
Within the file explorer you can:
* **Search for Files**
* Search for files using the **search bar** at the top of the file explorer
* **Create Files**
* Hover to the right of the filetype headers and click the **+** to create a new file
* **Export Files**
* Hover to the right of a file and click the **arrow** to export files into OAS
* **Delete Files**
* Hover to the right of a file and click the **trash can** to delete files

View File

@@ -0,0 +1,51 @@
# FAQs
## General
**Is Stoplight v2 being discontinued?**
Stoplight Classic (v2) will persist, but new feature development will only occur on Stoplight v3. Major bugs in Stoplight v2 will continue to be addressed. We encourage all our Stoplight Classic (v2) users to move onto our new platform. Read more about migrating from v2 to v3 [here](LINK).
**Can I save my files locally?**
Yes, but only on the desktop app. Click [here](LINK) to learn more about the Stoplight desktop app.
**Is there a way to manage multiple APIs in a single Project**
Yes. In Stoplight v3 you can manage unlimited APIs in a single Project. To learn more click [here](LINK).
**What are the differences between Stoplight Classic (v2) and Stoplight v3?**
Stoplight Classic is our original platform. Stoplight v3 is the next generation of platform, including all the features and tools from Stoplight Classic and much more. To learn more, click [here](LINK).
**Can I transfer Account ownership?**
Yes, you can [transfer ownership of an Organization](https://next.stoplight.io/stoplight/stoplight-next-docs/blob/master/Stoplight%20Platform.hub.yml?edit=%23%2Fpages%2F~1%2Fdata%2Fchildren%2F2%2Fdata%2Fchildren%2F5) or [make changes to your personal account](https://next.stoplight.io/stoplight/stoplight-next-docs/blob/master/Stoplight%20Platform.hub.yml?edit=%23%2Fpages%2F~1%2Fdata%2Fchildren%2F0%2Fdata%2Fchildren%2F1)
**Is there a way to edit my OpenAPI (Swagger) directly?**
Yes. In Stoplight v3 you can switch between the GUI editor and the source code via a TAB in the editor.For more information click [here](LINK).
**Does Stoplight offer monitoring solutions?**
Not at the moment, however, scheduling scenarios + alerting (monitoring) is on our roadmap.
**Does Stoplight support SSO?**
Yes. The business and enterprise plans support SSO. For more information, click [here](LINK).
**I am looking for a secure solution for hosting my API and restricting access, what do you recommend for hosting?**
Stoplight offers an on-premise installation option that will meet most security needs. For more information, click [here](LINK).
**Does Stoplight support OpenAPI 3?**
Currently we support OpenAPI 2 (Swagger 2). OpenAPI 3 support on our short term roadmap.
**My sign-up token has expired, how do I generate a new one?**
On the login page, go to forgot password and reset it using your email. This will renew your token.
**Can I remove the Stoplight branding from my API docs?**
Yes! In Stoplight v3 all paid users have access to the underlying CSS, and can customize it to remove or change any of the visual elements on the page. Click [here](LINK) for more information on themeing.

View File

@@ -0,0 +1,24 @@
# Welcome to Stoplight NEXT!
![](../../assets/images/stoplight-crew.jpg)
Now that you have the basics on what the [Stoplight NEXT Platform](../what-is-stoplight.md) is, we can go over how to get started.
First things first, are you using it for Personal Projects or as part of an Organization?
## Personal Projects
1. Create an Account (link)
2. Create a Project (link)
## Organization
1. Create an Account (link)
2. Create an Organization (link)
3. Invite Members (link)
4. Accept an Organization Invite
5. Create a Project (link)
## Web App or Download
* You can log in to the Web App at [next.stoplight.io](http://next.stoplight.io) or
* You can download the platform here (link)
If you have any questions you can reach out to us through Intercom or email us at [support@stoplight.io](support@stoplight.io) otherwise... **Full Steam Ahead!**

View File

@@ -0,0 +1,37 @@
# Organization Owner Introduction
![](/assets/gifs/org-create.gif)
## Welcome to Stoplight NEXT!
If you are trying to create a new Organization then you are in the right place. Stoplight NEXT was designed with large scale collaboration and governance as a central principle. The following guide will take you through the process of creating and populating an Organization, and offer an overview of the governance tools within Stoplight NEXT.
## Organization
Organizations function as a shared space for you and your co-workers. Members of an Organization have access to a centralized Activity Feed, Project Repository, and an Issues (link) discussion tool. Organization Owners can also assign varying levels of Permissions to other members of the Organization.
* Create an Organization (link)
* Invite People to Organization (link)
* Remove People from your Organization (link)
* Member Roles and Permissions (link)
* Customize your Organization (link)
* Transfer Primary Ownership (link)
* Delete an Organization (link)
## Teams
If you are managing a large Organization with multiple teams you can use Teams to group Organization members together.
* Create a Team (link)
* Add People to a Team (link)
* Remove People from a Team (link)
* Member Roles and Permissions (link)
* Customize a Team (link)
* Transfer Primary Ownership (link)
* Delete a Team (link)
## Projects
Projects are the workspaces you can create for your Organization.
* Creating a Project (link)
* Invite People & Teams to a Project (link)
* Change a Project Members Role (link)
* Make Your Project Private/Public (link)

View File

@@ -1 +1,36 @@
# What is Stoplight?
# The Stoplight Platform
The Stoplight platform provides a suite of products that cover the entire pre-production API lifecycle. Here is an overview of the platform:
![](../../assets/images/platform-overview.png)
Stoplight promotes a design-first philosophy. Developing good design-first practices at your organization will minimize future cost, speed up your time to market, and lead to more consistent, higher quality APIs.
## API Modeling & Design
At Stoplight, everything starts with design. Our visual designer makes it easy for anybody in your organization to model and document APIs, no matter the complexity.
Whether you have an existing OpenAPI (Swagger) or are creating a new API design from scratch, we've got you covered.
![](../../assets/images/modeling-editor.png)
## API Testing
Once you have your API design / documentation, how do you make sure that it remains accurate over time? Stoplight contract testing, powered by Prism, makes it trivial to create a full suite of tests that apply your API documentation (your contract) to your API. Run these tests from the Stoplight app, and standalone in your CI process or elsewhere.
![](../../assets/images/scenarios-editor.png)
## Hosted Documentation
You have your API designed and documented privately in the Stoplight app, and now you want to share all or part of it with 3rd parties (developers, customers, clients, etc). Stoplight makes it easy to publish your documentation to the world, with a single click.
![](../../assets/images/HubsPreview.png)
## Mock Server
Stoplight provides a complete mock server for every API described in the app. Run tests against this mock server, build consumers (like mobile apps, SDKS, etc) before the final API is ready, and more.
Spinning up your own mock server is as simple as:
# install prism on macOS
curl https://raw.githubusercontent.com/stoplightio/prism/master/install.sh | sh
# run a fake petstore api on http://localhost:4010
prism run --mock --list --spec http://petstore.swagger.io/v2/swagger.json

33
articles/hubs/blocks.md Normal file
View File

@@ -0,0 +1,33 @@
# Blocks
![](../../assets/gifs/Blocks.gif)
## What
Blocks are the micro-level building blocks of Hubs. They house multiple forms of content and allow for simple restructuring and modification.
<callout> Hovering over a Block reveals additional tooling including: Preview, Cut, Copy, Reference External Source, and Delete </>
## Block Types
### Text Block
* A markup editor for adding any textual elements to your Hub
### JSON Schema
* A block for describing the structure of a JSON object
### HTTP Request Maker
* A block for making HTTP requests
### Code
* A block for inserting code snippets
### Image
* A block for inserting images
### Tabs
* An upper level block for organizing text within tabs
### Callout
* A text block with color for emphasis
### Hero
* A large stylized text block with additional functionality typically found on landing pages
### Bar List
* A navigational block composed of bars with buttons
### Card List
* A navigational block composed of cards with text, buttons, and optional images
### HTML
* Include arbitrary HTML in your hubs when the other base block types don't quite do the trick

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,32 @@
# Managing Headers and Footers
![](../../assets/gifs/headers-footers.gif)
## What
You can customize the headers and footers of your Hub to add additional navigation to your documentation. You can modify a header and footer:
- **Location on Page**: Drag and drop along the header and footer to the desired location
- **Type**: Page, External Link, Image
- **Title**: What text is displayed on page
- **Path to Page**: Specify path to page
- **Image URL**: If you want to display an image instead of text for the link input image URL
## How
### Modify Existing Header and Footer
1. Select the Hub you wish to modify
2. Click on the **Editing toggle**
3. By default, there will already be three headers (Home, API Reference, Help) and a footer (Home)
1. Hover over one of the headers or footers and click on the **gear icon** to modify
2. Drag the header or footer to another location to change its location
### Create New Header and Footer
1. Select the Hub you wish to modify
2. Click on the **Editing toggle**
3. Hover over the left or right edge of the header or footer
1. Click on the **+** button

30
articles/hubs/pages.md Normal file
View File

@@ -0,0 +1,30 @@
# Pages
![](../../assets/gifs/create-pages.gif)
## What
Pages are the macro level building blocks of a Hub. They function as the canvas on which all other Hubs objects reside. They are commonly used as a way to separate information based on the broadest topics.
### Hubs Architecture from Top Down
- Pages
- Subpages
- Blocks
- Header and Footer
- Blocks
## How
### Create a New Page
1. Select the Hub you wish to modify
2. Click on **Toggle Editor**
3. Select **+** Page in the editor toolbar
1. Input a **Page Title**
2. Input a **Page Route** (optional)
3. **Power the Page** with an External Data Source (optional)
<callout> Did you know? After creating a new page; a header link will automatically be generated </>
<callout> To add content to a page you must add a subpage or a content block </>

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,32 @@
# Reference Other Sources
![](../../assets/gifs/ref-other-sources-hubs.gif)
## What
Hubs allows you to reference other sources to automatically populate your Hub with content. We call this “powering” a building block. You can power a building block with a file from the current file, a file from the current project, a file from another project, or a file from an external source.
### What can I Power
- Pages
- Subpages
- Text Blocks
## How
### Power a Subpage
1. Select the Hub you wish to modify
2. Select (or create a new) Subpage
3. Click on the gear icon in the center of the editor toolbar (If new, this window automatically opens)
1. Select Power this Subpage with an External Data Source
2. Select the data source from the drop-down menu
3. Input the specific data source or select from the drop-down menu
4. Input an inner data source (optional)
4. Click Confirm
<callout> Try it Out! Power a Subpage with an API Spec from the same project </>

37
articles/hubs/routing.md Normal file
View File

@@ -0,0 +1,37 @@
# Routing
![](../../assets/gifs/routing-hubs.gif)
## What
Stoplights Hubs features an easy to use routing system to make sure your docs have identifiable and friendly URLs. The routing system allows customization of the following objects:
- Your Hub
- Pages within a Hub (link)
- Subpages within a Hub (link)
- Headers + Footers (link)
- Links
<callout>Tips for Friendly URLs
Friendly URLs are links that are easily readable, rememberable, and relevant to the content.
Take a look at the URL for this page. Instead of something like https://help.stoplight.io/docs/fnIenof/123, it is https://help.stoplight.io/docs/hosted-documentation/create-friendly-urls, which is much nicer. </>
## How
### Pages & Subpages
1. Select the Hub you wish to modify
2. Add a new page or subpage (link)
a. Select a page title to auto-fill the Page Route or
b. Input a custom page route
3. Select an existing page or subpage
4. Select the gear icon at the top of the Hub in the center of the page or subpage you wish to modify
a. Input a new URL under Page Route
### Headers & Footers
1. Select the Hub you wish to modify
2. Add a new header or footer (link) or
3. Hover over an existing header or footer and click the gear icon
a. Input a Path to Page or image URL

30
articles/hubs/subpages.md Normal file
View File

@@ -0,0 +1,30 @@
# Subpages
![](../../assets/gifs/create-subpages.gif)
## What
Subpages are the second tier macro building blocks of Hubs. They function as a canvas for blocks. They are commonly used to house content based on a specific topic. Subpages can have more subpages nested underneath them, which gives you lots of flexibility to organize your Hub as you see fit. If a subpage has subpages nested inside of it, it will be displayed as a collapsible group in the left sidebar.
### Hubs Architecture Top Down
- Pages
- Subpages
- Blocks
- Header and Footer
- Blocks
## How
### Create a New Subpage
1. Select the Hub you wish to modify
2. Click on **Toggle Editor**
3. Select **+ Subpage** in the editor toolbar
1. Input a **Subpage Name**
2. Modify the **Subpage Route** (optional)
3. Give the Subpage a **Sidebar Token** (optional)
4. **Power the Subpage** with an External Data Source (optional)
<callout> Subpages populate the navigational sidebar of a page. </>
<callout> Just like pages, subpages can have blocks. Any blocks added to a subpage will be displayed when a reader navigates to that subpage in your hub</>

1
articles/hubs/themes.md Normal file
View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,90 @@
# API Operations
## Introduction
API operations describe the way you define how an API is exposed to a user. Properly defined operations are fundamental to the API development life cycle and the outcome is a final product that is easy to understand and use. Creating a properly designed RESTful API requires research, analysis, and planning. It is the API developers responsibility to ensure that the API design, resources, and connected operations are easy to understand by consumers. The following characteristics are true of well-designed APIs:
- Comprehensive, yet succinct
- Understandable and easy to use
- Supports delta (incremental) development
- Expedites and simplifies the API documentation process
## Key Terms
- A **resource** is an entity or object that has data linked to it, relationships to other objects or entities, and a set of methods that operate on it to access, use, or manipulate the associated data. When resources are grouped together, it is called a collection.
- A **Uniform Resource Locator (URL)** is used to indicate and identify the location of an API resource and perform some actions to it. Note that the base URL is the constant part of this location.
- **GET** method requests data from a resource and the body of the response message holds the information requested.
- **PUT** method requests the server to update the resource or create it (if it does not exist) and the body of the request message indicates the resource to be updated or created.
- **PATCH** method performs a partial update on a resource and the body of the request message indicates the change to be applied. This can occasionally be more efficient than PUT because the client forwards changes required and not the entire details about the resource.
- **POST** creates a new resource and the body of the request message indicates the details of the new resource to be created. This method can be used to activate operations that will not create a resource.
- **DELETE** method requests that the specified resource be removed.
## Best Practices
### Resource URL should be based on nouns and not verbs
For example, to retrieve pet details for a pet store which has different kinds of pets:
- /pets (Good)
- /getAllPets (Bad)
<!-- theme: info -->
> A good resource URL contains resources (nouns) and not actions or verbs. Ensure that the resource is in the plural form at the API endpoint.
### Use HTTP methods to operate on resources
To add, delete, or update information, use the HTTP methods GET, POST, DELETE, PUT, and PATCH (also known as verbs). For example:
- GET /pets (returns the list of all pets)
- GET /pets/5 (returns details of pet 5)
<!-- theme: info -->
> A successful GET method normally returns a HTTP status code of 200 (OK) and 404 (Not found) if the resource cannot be located.
| GET | PUT/PATCH | POST | DELETE | Resource |
|---------------------------------------|-----------------------------------------------|-------------------------------------|---------------------------------------------|------------------------|
| Return list of all pets | Update all pets | Add a new pet | Remove all pets | path/pets |
| Return details of treatment for pet 5 | Update all treatment for pet 5 | Add new treatment details for pet 5 | Remove all treatments associated with pet 5 | path/pets/5/treatments |
| Returns details for pet 5 | Updates details for pet 5 assuming it exists | Error (Not permitted) | Deletes pet 5 details | path/pets/5 |
### Make use of a Query String (?) for complex parameter optional parameters
When you need to add more complexity and dynamics to the request, add parameters to the query string. For example:
- GET /pets?type=feline&age=5 (Good)
- getFelinePets (Bad)
### Utilize HTTP Status Codes
A user should know the status of request made through an API. This might include failed, passed, or invalid responses. The table below summarizes the codes.
| 2xx Success | 3xx Redirect | 4xx Client Error | 5xx Server Error |
|-------------------------------------------------------------------------|-----------------------|------------------|---------------------------|
| 200 Ok (Success for GET, PUT, or POST) | 301 Moved Permanently | 400 Bad Request | 550 Internal Server Error |
| 201 Created | 304 Not Modified | 401 Unauthorized | |
| 204 No Content (Request successfully processed but returns not content) | | 403 Forbidden | |
| | | 404 Not Found | |
- Be wary of using too many status codes and confusing the API user.
- It is good to provide an additional description of the status code in the body of the HTTP Response. For example:
- Request: method GET /pets?type=feline
- Response:
```
//This is an invalid request.
{
"message": "Invalid Pet Type please enter a valid pet category",
}
```
### Executing search, sort, filter and pagination operations
- When you need to perform these actions, you can append the query parameters to the GET method and the API endpoint. For example, to carry out a **search** operation for a particular pet:
- GET /pets?search=Blaze (This will search for a pet named Blaze)
- **Pagination** helps you to manage the amount of resources you return and it is advisable to use the parameters offset and limit as shown in the example below:
- GET /pets?offset=10&limit=20 (Return pets between 10 to 20)
- To **sort** the list of resources we can use multiple sort parameters in the query string. For example:
- GET /pets?sort=age_desc (Would sort the age in descending order.)
- For **filtering** we can use one or more parameters in the query string. For example:
- GET /pets?type=canine&age=7
<!-- theme: info -->
>If too many query parameters are used in GET methods and the URL becomes too long, the server may return a 414 URL too long HTTP status. Parameters might be passed to the request body of a POST request as a solution to this challenge.
### Versioning
It is good practice to version an API to describe the available features and resources it exposes. When this is properly done, the application consuming the API can submit explicit requests to a specific version of a feature or resource. For example, you can specify the version of the resource by means of a parameter within the query string affixed to the HTTP request: http://api.yourdomain.com/v2/pets/10/

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,14 @@
# OpenAPI Validation
![](../../assets/gifs/file-validation-oas-spec.gif)
OpenAPI validation is the process of verifying the underlying OpenAPI file syntax by making sure it conforms to the [OpenAPI Specification requirements](https://github.com/OAI/OpenAPI-Specification#the-openapi-specification) provided by the [OpenAPI Initiative](https://www.openapis.org/). Stoplight immediately validates any changes done to a spec to ensure they are in the correct format prior to being saved.
<!-- theme: info -->
> Stoplight currently supports the OpenAPI v2 specification. We are working on support for OpenAPI v3, and should have more information in the coming months.
***
**Related**
* [File Validation](../editor/file-validation.md)

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,54 @@
# API Security Schemes
API security schemes protect your API resources by authenticating apps or users that consume your API. There are a number of standard authentication protocols you can pick from and each has their own strengths and weaknesses. To help you get started, the section below outlines some common schemes in use.
## Authentication Schemes
### Basic API Authentication
- Easy to implement
- Entails sending encoded username and password details
- Usually bundled with standard framework or language library
- Used with HTTPS, TLS or SSL
- Can be combined with other security methods
- **Note**: this method is susceptible to hijacks and man-in-the-middle attacks
### OAuth1.0 (Digest Scheme)
- Popular, tested, secure, signature driven, protocol
- Uses cryptographic signature, which is a mix of token secret, nonce, and other request based information.
- Can be used with or without SSL
### OAuth2 (Bearer Token Scheme)
- The current OAuth2 specification eliminates need for cryptographic signatures, passwords, and usernames.
- OAuth2 works with authentication scenarios called flows, these flows include:
- Authorization Code flow
- Implicit flow
- Resource Owner Password flow
- Client Credentials flow
- The OAuth 2.0 server will distribute access tokens that a client application will use to access protected resources.
- [Additional Information on OAuth2.0](https://tools.ietf.org/html/rfc6749)
### OpenID Connect Discovery
- OpenID Connect Discovery (OIDC) is based on the OAuth 2.0 protocol.
- Uses a sign-in flow that permits user authentication and information access by a client app.
- The user information is encoded via a secure JSON Web Token (JWT).
- [Additional Information on OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html)
## Best Practices
### Implementing IDs
Unique User IDs should be distinctive but not easy to decipher.
- Example: using a12bc3 is weak when compared to an ID that reads 09dgf659sjf038eyr3367dhrt34j5. Avoid using auto increment for your Unique User IDs to reduce the likelihood of a security breach.
### Sensitive Information in HTTP Request
Ensure that your API will not expose important information such as password, API keys, and security tokens in the URL. For example, this URL is bad because it contains an API key:
- /baseurl/<uid>q=?apiKey=2123223223
### API Keys
Reduce the likelihood of exposing your API keys by keeping them in a file or storage mechanism that is accessible by the owner.
- **Note**: API Keys can be duplicated or lost so it is important to use other security measures apart from API keys. Consider encryption to make your API keys more secure.
### Validation
It is beneficial to validate your inputs and access to resources using robust parsers. Parsing requests can help verify the validity of user requests. API designers can perform an implicit input validation to ensure the user inputs data with permitted characters, right syntax and character length. Using regular expressions can also help validate string inputs. If a request exceeds the defined limit, you can return a 413 Request Entity Too Large response code.
### Audit log
Create audit logs before and after security related events. You can also log validation errors to detect patterns or potential attacks.
### HTTP Status Codes
Use status codes and proper error handling techniques for incoming requests to identify probable security risks.
- [Additional Information on HTTP Status and Error Codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,18 @@
# Create An Organization
![](../../assets/gifs/org-create.gif)
## What
* Organizations are great for grouping people, data, and billing together in one convenient location
## Who
* Only the Billing **Owner** or Organization **Administrator** can create Organizations
## How
1. Click on **+ New** to the right of Organizations
2. Fill in **Name**
* We recommend using your companys name
3. Choose the path for your Organization (optional)
4. Add member by email (optional)
* Input email accounts to add other members to your organization
* You can also do this later

View File

@@ -0,0 +1,22 @@
# Customize Your Organization
![](../../assets/gifs/org-settings.gif)
## What
* Want to modify your Organization? In Stoplight you can modify your Organization's:
* Name
* Org Path
* Add a Description
* Add an Org Image
## Who
* Only an Organization **Owner** or **Administrator** can modify Organizations
## How
1. From the homepage, select the **Organization** you would like to modify
2. Select the **Settings** tab
3. Input a **Name**
4. Input a **Path**
5. Input a quick sentence about your organization
6. Select an **image** file for your Org

View File

@@ -0,0 +1,15 @@
# Delete an Organization
![](../../assets/gifs/org-settings.gif)
## What
* Deleting an organization is easy peasy, but once you delete an Org, there is no going back. Please be certain.
## Who
* Only the Organizations **Owner**
## How
1. From the homepage, select the **Organization** you would like to delete
2. Select the **Settings** tab
3. Scroll to the bottom of the page to the **Danger Zone**
4. Click on **Delete this Org**
5. Confirm the deletion by clicking okay on the proceeding popup
6. Wipe the tears from your eyes and say goodbye

View File

@@ -1 +1,17 @@
# Invite People to an Organization
![](../../assets/gifs/people-invite.gif)
## What
* Adding people to your Organization is the first step towards collaboration within Stoplight
## Who
* Only an Organization **Owner** or **Administrator** can invite people to an Organization
## How
1. From the Stoplight homepage, select the **Organization** you would like to invite people to
2. Select the **People** tab from the tabs bar
3. Click **Invite Member**
4. In the popup that appears input email addresses or usernames
5. Hit **enter** to add them to your list
6. Once completed, click the **Invite** button

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,17 @@
# Remove People From Your Organization
![](../../assets/gifs/org-member-remove.gif)
## What
* Removing a person for your organization is as easy as 123...4...5...6
## Who
* Only an Organization **Owner** or **Administrator** can modify
## How
1. From the homepage, select the **Organization** you would like to modify
2. Select the **People** tab from the tab bar
3. Find the person you would like to remove from the list
4. To the right of the persons name, click on the **dropdown arrow** to the left of the persons role
5. In the dropdown menu that appears, select **Remove Member**
6. Click **Okay** in the popup prompt

View File

@@ -0,0 +1,23 @@
# Organization Member Roles and Permissions
![](/assets/gifs/people-invite.gif)
## What
* Roles and Permissions for members of Organizations can be managed and modified within Stoplight to control access to the Organization's functions and features
* There are 3 Roles:
* **Owner**
* Owners can update the org, its connections, and its members
* Has access to Billing and Organization Settings
* **Administrator**
* Admins can update the org, its connections, and its members
* **Member**
* Members can update the org and its connections. They can view its members
## Who
* Only an Organization **Owner** or **Administrator** can modify roles and permissions
## How
1. From the homepage, select the **Organization** you would like to modify
2. Select the **People** tab from the tab bar
3. Find the person you would like modify
4. To the right of their name click on the **down carrot** button to the left of the persons role
5. In the dropdown menu select the desired role with accompanying permissions

View File

@@ -0,0 +1,17 @@
# Transfer Primary Ownership of Your Organization
![](/assets/gifs/org-transfer.gif)
## What
* You can promote another Member of your Organization to the role of Owner
* You can only transfer ownership to a Member of the Organization
## Who
* Only the Organization **Owner** can transfer ownership of an Organization
## How
1. From the homepage select the **Organization** you wish to modify
2. Select **People** from the tabs bar
3. Find the Member you would like to modify from the list
4. To the right of the Members name, click on the **down carrot** next to the Members current role
5. From the dropdown menu that expands, select **Owner**
6. You will then be asked to confirm your selection in a popup window
7. Click **Ok**

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,100 @@
# Setting up a Hosted Prism Contract Server
Contract servers are a powerful tool in a developer's toolbox. They use your OAS (Swagger 2) and JSON Schema definitions to validate HTTP traffic passing through your API. You can use them to:
1. **Add Contract Tests to an Existing Test Suite**
- Already have a test suite? No problem! Point your tests at the contract test server, and it can annotate responses with the contract test results. Your test suite just has to check for these response headers and fail appropriately.
2. **Monitor Traffic for Anomalies**
- Know _when_ your implementation breaks instantly, and _why_. By sending all your traffic through your contract server, you can flag that 1 in 1000 request anomaly.
3. **Detect Changes in 3rd Party APIs**
- APIs (particularly microservices) usually make calls to other APIs. These dependencies can be disconcerting because you have no control over when they change. With contract servers positioned between you (the consumer) and the external API, you can be alerted when the external API changes.
> **Real World Use Case** - Still not convinced, then head on over to Sendgrid and learn how they used contract servers to power their [integration tests](https://sendgrid.com/blog/stoplight-io-to-test-api-endpoints) for their 7 SDKs.
If you aren't familiar with JSON Schema, we highly recommend you head [here](https://spacetelescope.github.io/understanding-json-schema/) first.
If you are coming from Stoplight Classic (v2), you will notice that there is a little bit more setup involved, but only a couple steps.
## Hosted Contract Server Steps
_Note: We plan to introduce templates to the Stoplight editor file creation process soon. This feature will automate most of the steps below and turn mock server creation into a one-click solution._
_For this article we will validate a service that already exists. It is just a simple API representing a todos list manager that is running at http://todos.stoplight.io. We have created an OAS Specification for it already and you can download it [here](https://exporter.stoplight.io/3351/master/todos.oas2.yml)._
1. Let's create a new project, create a new spec, name it `todos.oas2`, and paste the JSON from the spec above in the code editor.
![](../../assets/gifs/validation-todos-contract-guide.gif)
2. Create a new **Prism instance file** in the project. Name it `todos.contract.prism`.
3. Prism instances are made up of APIs and Rules, you can learn more about them here. Add an API to the Prism instance and connect the `todos.oas2` specification that you created earlier. Also, let's change the `id` to `todos` and set the _Upstream URL_ to _http://todos.stoplight.io_. The Upstream URL is where the contract server will forward incoming requests.
![](../../assets/gifs/validation-todos-prism-api.gif)
4. Next, add a **new rule** that you will setup to power the validation. Rules simply apply scenarios to HTTP traffic passing through the Prism instance.
5. Once you have created a new rule, you need to connect it to the API we added earlier. To do that, click on the `apis` dropdown input and select the previously created API. Connecting the rule to the API you defined earlier makes the OAS file available to scenarios in the rule.
6. Lastly, you need to add a **scenario** that will actually perform the validation. We have an official Stoplight validate scenario [here](https://next.stoplight.io/stoplight/prism?edit=%23%2Fscenarios%2validate), which makes it easy to get started.
1. Add a scenario to the `after` section of your rule.
2. Select `another project` in the first dropdown.
3. Search for `prism`.
1. The file you are looking for within that project is `helpers.prism.yml` and the specific scenario is called `validate`.
This validate scenario should suit most of your needs. It will check the request/response headers, request/response body, request path parameters, and query strings. It will also add response headers to the HTTP request on the way back to the consumer with the results of the validation. For advanced use cases, please send us a [message](). We would love to help out!
![](../../assets/gifs/validation-todos-prism-rule.gif)
7. Save and let's verify that your contract server is working. Click on Home and let's Send a Test Request to `GET /todos`.
_Stoplight's visual editior makes it really easy to debug reqeust/response. If look at the response headers, specifically `Sl-Valid` , it should be `false`. This signifies that (according to your API specification) the request/response isn't valid, aka the contract test failed. You can find out why by inspecting the `Sl-Validation-Messages`. For the purpose of this article, the messages are below, and it looks like user is a required property and it is missing._
```js
// Sl-Validation-Messages
[
{
response: {
message: "The document is not valid. see errors",
error:
"user: user is required\n0: Must validate all the schemas (allOf)\nuser: user is required\n1: Must validate all the schemas (allOf)\nuser: user is required\n2: Must validate all the schemas (allOf)\nuser: user is required\n3: Must validate all the schemas (allOf)\nuser: user is required\n4: Must validate all the schemas (allOf)\nuser: user is required\n5: Must validate all the schemas (allOf)\nuser: user is required\n6: Must validate all the schemas (allOf)\nuser: user is required\n7: Must validate all the schemas (allOf)\nuser: user is required\n8: Must validate all the schemas (allOf)\nuser: user is required\n9: Must validate all the schemas (allOf)\n"
}
}
];
```
![](../../assets/gifs/validation-todos-prism-verify.gif)
8. Let's get rid of this validation error. We don't have control over the API implementation so we have to update our specification.
9. Navigate to the `todos.oas2` file, update the `Todo Full` by deleting the user property, and hit save.
10. Let's resend a request to `GET /todos` and inspect the results. This time `Sl-Valid` is `true`. Awesome, we now have a valid spec and API.
![](../../assets/gifs/validation-todos-prism-done.gif)
# Running your Prism Server Locally
In the previous section, you learned how to create a simple Prism instance that is hosted with Stoplight. It is a powerful, accessible tool that allows your frontend and backend teams to work simultaneously. But, the hosted prism instance might not work behind your company firewall or you might want to run Prism locally on your desktop. Well, you are in luck, Prism is easy to install and run.
## Local Contract Server Steps
1. Install [Prism](https://github.com/stoplightio/prism). Make sure to install Prism Next, the version should be >= `2.0.0-beta.x`.
2. Open up your terminal, log into Stoplight Next with the `prism login` command, and enter your Stoplight Next credentials. Once you are logged in, you will have access to your private and all public projects.
3. Get the export link for the prism mock instance you created above.
![](../../assets/gifs/prism-install.gif)
4. Run `prism serve {export-link} --debug` and open this [link](http://localhost:4010/todos). You can inspect the results by opening the developer console for your browser.
![](../../assets/gifs/validation-todos-prism-local.gif)
# Validating Mock Servers
Validating an existing service is powerful, but what happens if you are still implementing your API and all you have is a mock server? How do you keep the examples valid?
_Note: If you don't have an existing mock server, check out [this](https://next.stoplight.io/stoplight/stoplight-next-docs/blob/master/prism.mock.server.md) article first and then continue reading._
## Steps
1. Repeat step 7 above. That is it. Now you will know when your examples are out of date. Not only will your mock server be accurate, but it will help you catch any errors in examples in your documentation that you provide to users.
# Recap
You now have a fully functional Prism contract server. We have created a public project full of useful Prism resources. We encourage you to explore the other Prism helpers which are located [here](https://next.stoplight.io/stoplight/prism/blob/master/helpers.scenarios.yml). Let us know what you think. We are excited to see what you do!
For the more experienced Prism user, we have set up some advanced Prism instances in the official Stoplight Next [Prism Project](https://next.stoplight.io/stoplight/prism).

View File

@@ -0,0 +1,30 @@
# Change a Project Member's Role
![](/assets/gifs/project-member-invite.gif)
## What
* You can invite people to a Project to grant them read or read/write permissions
* There are three tiers of read/write permissions
* **Admin Access**: Upper level permissions that allow you to:
* Read/Write
* Invite and Manage Members and Teams
* Manage Project Settings
* Delete the project
* **Write Access**: Mid-level permissions that allow you to:
* Read/Write
* **Read Access**: Low-level permissions that allow you to:
* Read
## Who
* Only the Organization **Owner** and Org and/or Project **Administrators** can modify member roles
## How
1. From the Stoplight homepage select the **Project** you wish to modify
2. By deafult, all members of the Organization the Project is associated with will have Read permission
3. To invite a single member, select the **Member icon** from the far left sidebar
* Input their username in the search bar at the top of the Member sidebar
* Once located, press enter
4. To invite a team, select the **Team icon** from the far left sidebar
* Input the Team name in the search bar at the top of the Team sidebar
* Once located, press enter

View File

@@ -0,0 +1,34 @@
# Creating a Project
![](../../assets/gifs/project-create-personal.gif)
## What
Projects are the workspace of the Stoplight Platform. Projects contain:
* File Explorer
* Project Governance
* Documentation Editor (Hubs)
* Modeling Editor
* Testing (Scenarios)
* Mocking (Prism)
* Markdown Editor
<callout>Single Point of Truth All editors are now contained within a Project </>
## Who
Individual users can create Personal Projects. Organizations can create Org Projects.
## How
### Personal Project
1. From the homepage select the **Personal Project** tab
### Organization Project
1. From the homepage select the **Organization** you want to create a Project within
* By default you will land on Organization Projects
### Create a Project
2. Input a **Project Name**
3. Input a custom **Project Path** (optional)
4. Input a **Project Description** (optional)
5. Select **Public** or **Private**
6. Select **Create Project** once complete

View File

@@ -0,0 +1,31 @@
# Invite People & Teams to a Project
![](../../assets/gifs/project-member-invite.gif)
## What
* You can invite people to a Project to grant them read or read/write permissions
* There are three tiers of read/write permissions
* **Admin Access**: Upper level permissions that allow you to:
* Read/Write
* Invite and Manage Members and Teams
* Manage Project Settings
* Delete the project
* **Write Access**: Mid-level permissions that allow you to:
* Read/Write
* **Read Access**: Low-level permissions that allow you to:
* Read
<callout>You can only invite people and Teams to a Project associated with an Organization</>
## Who
* Only the Organization **Owner** and Org and/or Project **Administrators** have invite privileges
## How
1. From your Organization's homepage, select the **Project** you wish to modify
2. By deafult, all members of the Organization the Project is associated with will have Read permission
3. To invite a single member, select the **Member icon** from the far left sidebar
* Input their username in the search bar at the top of the Member sidebar
* Once located, press enter
4. To invite a team, select the **Team icon** from the far left sidebar
* Input the Team name in the search bar at the top of the Team sidebar
* Once located, press enter

View File

@@ -1 +1,14 @@
## Making Your Project Private/Public
## Making Your Project Private & Public
![](../../assets/gifs/project-privacy.gif)
## What
* You can choose to make your Project Public or Private
* **Private**: Only designated collaborators will be able to read it. Additionally, connections from ALL dependent entities outside of this Organization will be removed
* **Public**: Anyone can read it
## Who
* Only the Organization **Owner** and Org and/or Project **Administrator** can modify
## How
1. Select the **Project** you wish to modify
2. Select the **gear icon** on the left hand sidebar
3. Under **Danger Zone** Select **Public** or **Private**

View File

@@ -0,0 +1,21 @@
# Add People to a Team
![](../../assets/gifs/team-member-remove.gif)
## What
* Adding people to a team lets you collaborate on projects while allowing an additional level of control over permissions.
## Who
* Team **Owners**, **Administrators**, and **Members** can add people to a team
## How
1. From the homepage select the **Organization** associated with the team
2. Select **Teams** on the tab bar
3. Select the team that you would like to add people to.
4. Click the **Invite Members** button
5. Input the persons email or Stoplight username in the textarea and press enter
* Note: you can add more than one person at a time
6. Once completed, click on the **Invite** button

View File

@@ -0,0 +1,21 @@
# Create a Team
![](../../assets/gifs/team-create.gif)
## What
* Teams makes it easier for Organization Members to collaborate and allows additional control over permissions
## Who
* Only an Organization **Owner** or **Administrator** can create a Team
## How
1. From the homepage, select the **Organization** you would like to make a team for
2. Select the **Teams** tab from the tabs bar
3. Create Your First Team
* Input a **Team Name**(A department, project group, etc.)
* Input a **Description** (What does this team do?)
* Input **Members** (email or username)
* Send email notifications to invited members? (optional)
* If the invited member does not already have a Stoplight account, an email will be sent with instructions on how to complete the account creation process
4. Click **Create Team** once finished

View File

@@ -0,0 +1,21 @@
# Customize a Team
![](../../assets/gifs/teamcustom.gif)
## What
* You can customize the Team Name, Path, and Team Description
## Who
* Only Team **Owner** or **Administrator** can customize a Team
## How
1. From the homepage select the **Organization** associated with the Team you wish to modify
2. Select **Teams** from the tab bar
3. From the Teams homepage select the Team you wish to customize
* Then select **Team Settings** from the tab bar
* Input a new Team Name in the textarea under **Team Name**
* Input a new Team URL in the textarea under **Path**
* Input a new Team Description in the textarea under **Description**

View File

@@ -0,0 +1,14 @@
# Delete a Team
![](../../assets/gifs/teamcustom.gif)
## What
* Want to disband your team? Here's how:
## Who
* Only the Organization **Owner** or a Team **Owner** or **Administrator** can delete a team
## How
1. Select the **Organization** associated with the team you wish to modify
2. Select **Teams** from the tab bar
3. Click on the **red X icon** located to the right of the team you wish to delete
4. A popup will appear asking if you are sure you want to delete this team
5. Click **Ok**

View File

@@ -0,0 +1,24 @@
# Team Member Roles and Permissions
![](/assets/gifs/team-member-remove.gif)
## What
* Roles and Permissions for Team members can be managed and modified within Stoplight to control access to the Teams functions and features
* There are 3 Roles:
* **Owner**
* Owners can update the Team, its connections, and its collaborators. They can also update the team's settings and delete the team.
* **Administrator**
* Admins can update the Team, its connections, and its collaborators.
* **Member**
* Members can view and create projects. They can view the Team's members.
## Who
* Only the Team **Owner** or **Administrator** can modify Roles and Permissions
## How
1. From the homepage, select the **Organization** associated with the Team you would like to modify
2. Select the **Teams** tab from the tab bar
3. Select the Team you would like modify
4. To the right of the members name click on the **down carrot** button to the left of the persons role
5. In the dropdown menu select the desired role with accompanying permissions

View File

@@ -0,0 +1,22 @@
# Remove People from a Team
![](../../assets/gifs/team-member-remove.gif)
## What
* Want to bench a member of your team? Here's how:
## Who
* Only the Team **Owner** or **Administrator** can remove people from a Team
## How
1. From the homepage select the **Organization** associated with the Team you wish to modify
2. Select **Teams** from the tab bar
3. Select the Team you wish to modify from the list
4. Find the member of the team you wish to remove
5. To the right the members name click the **down carrot**
6. In the dropdown menu select **Remove Member**
7. A popup window will ask you to confirm your removal
* Click Ok

View File

@@ -0,0 +1,16 @@
# Transfer Primary Ownership of a Team
![](../../assets/gifs/team-transfer.gif)
## What
* You can transfer Ownership of a Team to another member of the Team
## Who
* Only the Team **Owner** can transfer Ownership of a Team
## How
1. From the homepage select the **Organization** that is associated with the Team you wish to modify
2. Select **Teams** from the tab bar
3. Select the Team you wish to modify
4. Find the Member of the Team you wish to transfer ownership to
5. Click on the **down carrot** to the right of the Members name
6. Select **Owner** from the dropdown menu
7. Click **Ok** in the proceeding popup

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

BIN
assets/gifs/Blocks.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 MiB

BIN
assets/gifs/file-delete.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 MiB

BIN
assets/gifs/file-export.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.2 MiB

BIN
assets/gifs/file-import.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 MiB

Some files were not shown because too many files have changed in this diff Show More