Compare commits

..

5 Commits

Author SHA1 Message Date
Robert Wallach
3b87411246 Update auth0-integration.md 2018-05-08 11:24:45 -05:00
Robert Wallach
a54073c148 Update auth0-integration.md 2018-05-08 11:02:54 -05:00
Robert Wallach
190ae8cf8b Update auth0-integration.md 2018-05-07 17:03:00 -05:00
Robert Wallach
34d440f60d Update auth0-integration.md 2018-05-07 16:11:00 -05:00
Robert Wallach
6e7497bf41 Create auth0-integration.md 2018-05-07 16:05:03 -05:00
17 changed files with 21 additions and 26 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: 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 - Documentation
- Modeling - Modeling
- Testing - Testing

View File

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

View File

@@ -4,25 +4,18 @@
> Requires a Pro Docs plan > Requires a Pro Docs plan
## What? ## What
If you would rather host your documentation outside of Stoplight's hosted servers, you can download a built version of your Hub. Downloading a build will produce a `.zip` containing all of the minified assets necessary to load your Hub. These assets will include HTML, JavaScript, CSS, and JSON files. You will need an HTTP File Server in order to properly view and navigate your downloaded Hub. Any authorizations (Auth0, SAML, etc) you have added will not work, since they require a backend server. If you would rather host your documentation outside of Stoplight's hosted servers, you can download a built version of your Hub. Downloading a build will produce a `.zip` containing all of the minified assets necessary to load your Hub. These assets will include HTML, JAvascript, CSS, and JSON files.
## How to download ## How to Download
1. Click the **Publish** icon on the far left toolbar 1. Click the **Publish** icon on the far left toolbar
2. Select or create a **domain** 2. Select or create a **domain**
3. Choose a **Hub** or **OAS** file 3. Choose a **Hub** or **OAS** file to create a build from
4. Click the **Build** button to start the build process 4. Click the **Build** button to start the build process.
> If this is your first build, it will also publish to your selected domain > If this is your first build, it will also publish to your selected domain
5. Once your **Hub** has finished building, it will appear in the **Builds** section. Click the download icon to the right of the build
6. Unzip the downloaded `.zip` to view all of the assets. It will most likely be located in your Downloads folder
## How to serve locally on your computer (Mac)
1. Open Terminal and `cd` into the root of your build folder
2. Start your favorite file server (Ex. `python -m SimpleHTTPServer`)
3. Open a web browser and navigate to the file server's local url (Ex `http://localhost:3000`)
5. Once your **Hub** has finished building, it will appear in the **Builds** section. Click the download icon to the right of the build
--- ---
**Related Articles** **Related Articles**
- [Documentation with Hubs](/documentation/introduction) - [Documentation with Hubs](/documentation/introduction)

View File

@@ -1,10 +1,10 @@
# OAuth 2.0 # OAuth for Hubs
## What ## 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 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 ## 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 1. Select the Hub you wish to modify
2. Select **Design** view 2. Select **Design** view
3. Select the **page** or **subpage** you wish to power 3. Click on **Page Settings & TOC** at the top of the page
4. Under Page Type, select **Markdown**(for markdown files) or **OpenAPI** (for JSON or YAML files) 1. Select the **page** or **subpage** you wish to power
5. Input the specific data source or select from the drop-down menu 2. Under Page Type, select **Markdown**(for markdown files) or **OpenAPI** (for JSON or YAML files)
6. Click **Confirm** 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. >Try it Out! Power a Subpage with an API Spec from the same project.

View File

@@ -20,13 +20,13 @@ Adding people to your Organization is the first step towards collaboration withi
### Magic Link ### 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 #### Generating and Sending Magic Link
1. Select the **Organization** you wish to invite people to 1. Select the **Organization** you wish to invite people to
2. Select the **People** tab 2. Select the **People** tab
3. Click **Invite Member** 3. Click **Invite Member**
4. Select a role, either **Contributor** or **Reader** 4. Select a role, either **Creator** or **Reader**
5. Click **Generate Link** 5. Click **Generate Link**
6. Send link to invitee 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** 1. Click on the **magic link**
2. If new to Stoplight, click **Register** 2. If new to Stoplight, click **Register**
3. If you already have an account, **Login** 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** **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 * Has access to Billing and Organization Settings
* **Administrator** * **Administrator**
* Admins can update the org, its connections, and its members * 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 * Creators can update the org and its connections. They can view its members
## Who ## 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