Compare commits

..

2 Commits

Author SHA1 Message Date
Robert Wallach
0165c5c1b3 Update export-static-html.md 2018-05-08 12:33:50 -05:00
Chris Lott
88a6977ff8 How to serve locally on your computer 2018-05-02 13:58:55 -05:00
18 changed files with 14 additions and 76 deletions

View File

@@ -6,7 +6,7 @@
You can export any files in Stoplight to use as you see fit. Exported files are served up in a unique domain in its raw format. Current exported file formats include:
### JSON
### YAML
- Documentation
- Modeling
- Testing

View File

@@ -2,7 +2,7 @@
## Organizations
| **Organization Actions** | **Reader** | **Contributor** | **Administrator** | **Owner** |
| **Organization Actions** | **Reader** | **Creator** | **Administrator** | **Owner** |
|---------------------------------|:----------:|:-----------:|:-----------------:|:---------:|
| Read Public Projects | X | X | X | X |
| View Organization Collaborators | | X | X | X |

View File

@@ -1,48 +0,0 @@
# Auth0 Integration
## What
Auth0 allows you to add a login form with user access management to your documentation.
## How
1. Create an account or login to [Auth0](https://auth0.com/)
2. Select **Applications** in the Auth0 menu
![Auth0 Dashboard](https://github.com/stoplightio/docs/blob/develop/assets/images/auth0-dashboard.png?raw=true)
3. Click **+ Create Application**
![Create Application](https://github.com/stoplightio/docs/blob/develop/assets/images/create-application.png?raw=true)
4. Input a **Name** for your application
![Create Application Details](https://github.com/stoplightio/docs/blob/develop/assets/images/application-create.png?raw=true)
5. Select **Regular Web Applications**
6. Click **Create**
7. Select **Application Settings**
![Auth0 Settings](https://github.com/stoplightio/docs/blob/develop/assets/images/auth0-new-settings.png?raw=true)
8. Copy the **Domain** and paste it in **Hosted Login Page**
9. Input a **?client=** at the end of the pasted **Domain** from above
10. Copy the **Client ID** and paste it after the **?client=** in **Hosted Login Page** from above
> Example Hosted Login Page: robertwallach.auth0.com?client=XwYWVMLp7rJOkJ6iU51MwJHm2w2AAfGl
11. Copy the **Client Secret** and paste it in **Client Secrets** in Hubs
![Hubs Authorizations](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-authorization.png?raw=true)
12. Copy the **Callback URL** generated by Hubs in **Authorizations** and paste it in **Allowed Callback URLs** in Auth0
> Make sure the callbacks start with https instead of http and that they match
![Allowed Callback URL](https://github.com/stoplightio/docs/blob/develop/assets/images/callback-urls.png?raw=true)
13. Select **Hosted Pages** in the Auth0 menu
> Make sure **Customize Login Page** is turned on
14. Click on **Build** to start the Publishing process
> To login to your Hub with Auth0, make sure you add users in the Auth0 Dashboard

View File

@@ -1,10 +1,10 @@
# OAuth 2.0
# OAuth for Hubs
## What
OAuth provides a level of security to your documentation to restrict access to it. If your API is protected by OAuth, you will need to enable it for Try It Out. Enabling OAuth for Try It Out can be accomplished through two different methods: via Modeling or directly into the Hubs code.
> OAuth 2.0 works explicitly for accessCode workflow
> Stoplight supports OAuth 1.0 and 2.0
## How

View File

@@ -17,10 +17,12 @@ Hubs allows you to reference other sources to automatically populate your Hub wi
1. Select the Hub you wish to modify
2. Select **Design** view
3. Select the **page** or **subpage** you wish to power
4. Under Page Type, select **Markdown**(for markdown files) or **OpenAPI** (for JSON or YAML files)
5. Input the specific data source or select from the drop-down menu
6. Click **Confirm**
3. Click on **Page Settings & TOC** at the top of the page
1. Select the **page** or **subpage** you wish to power
2. Under Page Type, select **Markdown**(for markdown files) or **OpenAPI** (for JSON or YAML files)
3. Input the specific data source or select from the drop-down menu
4. Input an inner data source (optional)
4. Click **Confirm**
>Try it Out! Power a Subpage with an API Spec from the same project.

View File

@@ -1,16 +0,0 @@
# Grouping & Tagging Endpoints in OpenAPI
![Tagging and Grouping Endpoints](https://github.com/stoplightio/docs/blob/develop/assets/gifs/modeling-tagging.gif?raw=true)
## What
Use tags to group API endpoints and provide an additional layer of organization in your OpenAPI files. When rendering your OpenAPI in read view, Stoplight will group API endpoints by their first tag.
## How
1. Click **Tag** in the top Modeling toolbar
2. Input a **Name**
3. Input a **Tag description** (optional)
4. Select the endpoint you want to tag
5. Open the **tags** dropdown, and select the tag that you just created
6. Switch to read view and you should see the endpoint grouped under that tag in the sidebar

View File

@@ -20,13 +20,13 @@ Adding people to your Organization is the first step towards collaboration withi
### Magic Link
> Magic Link grants either Contributor or Reader Permissions. Set accordingly
> Magic Link grants either Creator or Reader Permissions. Set accordingly
#### Generating and Sending Magic Link
1. Select the **Organization** you wish to invite people to
2. Select the **People** tab
3. Click **Invite Member**
4. Select a role, either **Contributor** or **Reader**
4. Select a role, either **Creator** or **Reader**
5. Click **Generate Link**
6. Send link to invitee
@@ -34,7 +34,7 @@ Adding people to your Organization is the first step towards collaboration withi
1. Click on the **magic link**
2. If new to Stoplight, click **Register**
3. If you already have an account, **Login**
4. You now have Contributor or Reader access to that Organization
4. You now have Creator or Reader access to that Organization
---
**Related Articles**

View File

@@ -10,7 +10,7 @@ Roles and Permissions for members of Organizations can be managed and modified w
* Has access to Billing and Organization Settings
* **Administrator**
* Admins can update the org, its connections, and its members
* **Contributor**
* **Creator**
* Creators can update the org and its connections. They can view its members
## Who

Binary file not shown.

Before

Width:  |  Height:  |  Size: 989 KiB

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB