Compare commits

..

10 Commits

Author SHA1 Message Date
Taylor Barnett
ec74e0e88c Merge branch 'taylor-projects-git' of https://github.com/stoplightio/docs into taylor-projects-git 2018-04-10 17:00:51 -05:00
Taylor Barnett
e4448b79b5 fix conflict 2018-04-10 17:00:22 -05:00
Robert Wallach
53da0d12c1 Update git.md 2018-04-10 16:36:28 -05:00
Robert Wallach
78842d72f3 Update git.md 2018-04-10 15:01:51 -05:00
Taylor Barnett
bccbaa6598 add line clarifying what article does 2018-04-09 19:46:01 -05:00
Taylor Barnett
0b02a2e0ba remove double parentheses 2018-04-09 19:44:18 -05:00
Taylor Barnett
211c79848f add image URL 2018-04-09 19:42:39 -05:00
Taylor Barnett
2917e69874 copy fixes 2018-04-09 19:40:43 -05:00
Taylor Barnett
f5a58984ff WIP 2018-04-09 19:35:21 -05:00
Taylor Barnett
9b1f44ae10 WIP 2018-04-06 14:28:52 -05:00
22 changed files with 30 additions and 184 deletions

View File

@@ -1,11 +0,0 @@
# Fair Billing Policy
Stoplight's Fair Billing Policy means you will only be charged for active users in any given billing cycle. We adopted the Fair Billing Policy because we believe you should only pay for what you use. We also wanted to avoid setting strict user limits because it can lead to workflow bottlenecks and promotes poor engineering practices.
## Active User
To be considered an active user, you must perform one of the following actions:
- Push a commit
- Write or modify a file
- Publish documentation
> If you do not perform on of these actions durign a billing cycle, you will be considered inactive, and will not count towards your user count for that billing cycle.

View File

@@ -1,7 +1,7 @@
# Web & Desktop App # Web & Desktop App
Stoplight has a desktop app! Download the appropriate version [here](https://github.com/stoplightio/desktop/releases/latest). Stoplight has a desktop app! Download the appropriate version [here](https://stoplight.io/download) .
## Web or Local? ## Web or Local?

View File

@@ -22,4 +22,4 @@ Different types of file validations are used throughout the Stoplight platform.
**Related Articles** **Related Articles**
* [Validating Your API Spec](/modeling/modeling-with-openapi/validating-your-api-spec) * [Validating Your API Spec](/modeling/modeling-with-openapi/validating-your-api-sec)

View File

@@ -1,6 +1,6 @@
# Welcome to Stoplight Next! # Welcome to Stoplight Next!
Now that you have the basics on what the [Stoplight Next Platform](/platform/what-is-stoplight) is, we can go over how to get started. Now that you have the basics on what the [Stoplight Next Platform](/platform/introduction) is, we can go over how to get started.
First things first, are you using Stoplight for Personal Projects or as part of an Organization? First things first, are you using Stoplight for Personal Projects or as part of an Organization?

View File

@@ -1,6 +1,6 @@
# Blocks # Blocks
![Blocks](https://github.com/stoplightio/docs/blob/develop/assets/gifs/Blocks.gif?raw=true) ![Blocks](https://github.com/stoplightio/docs/blob/develop/assets/gifs/blocks.gif?raw=true)
## What ## What
Blocks are the micro-level building blocks of Hubs. They house multiple forms of content and allow for simple restructuring and modification. Blocks are the micro-level building blocks of Hubs. They house multiple forms of content and allow for simple restructuring and modification.
@@ -22,6 +22,12 @@ Blocks are the micro-level building blocks of Hubs. They house multiple forms of
* An upper level block for organizing text within tabs * An upper level block for organizing text within tabs
### Callout ### Callout
* A text block with color for emphasis * 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 ### HTML
* Include arbitrary HTML in your hubs when the other base block types don't quite do the trick * Include arbitrary HTML in your hubs when the other base block types don't quite do the trick
@@ -29,7 +35,7 @@ Blocks are the micro-level building blocks of Hubs. They house multiple forms of
**Related Articles** **Related Articles**
- [Documentation with Hubs](/documentation/introduction) - [Documentation with Hubs](/documentation/introduction)
- [Routing](/documentation/getting-started/routing) - [Routing](/documentation/getting-started/routing)
- [Headers](/documentation/getting-started/header-footer) - [Headers & Footers](/documentation/getting-started/header-footer)
- [Pages](/documentation/getting-started/pages) - [Pages](/documentation/getting-started/pages)
- [Subpages](/documentation/getting-started/subpages) - [Subpages](/documentation/getting-started/subpages)
- [Referencing Other Data Sources](/documentation/referencing-other-data-sources) - [Referencing Other Data Sources](/documentation/referencing-other-data-sources)

View File

@@ -1,56 +0,0 @@
# OAuth for Hubs
## What
OAuth provides a level of security to your documentation to restrict access to it. Enabling OAuth in Hubs can be accomplished through two different methods: via Modeling or directly into the Hubs code.
> Stoplight supports OAuth 1.0 and 2.0
## How
### Modeling
![OAuth in Modeling](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-oauth-modeling.png?raw=true)
1. Create a new Modeling file or select an existing one referenced by the Hub you wish to modify
> If you are creating a new Modeling file, make sure to reference it in your Hub
2. Next to **Security** in the left-middle toolbar, Add a Security Scheme by clicking the **+**
3. Input a **key**
4. Select oauth2 under **type**
5. Select **accessCode** under OAuth **flow**
6. Select an **authorization url**
7. Select a **token url**
8. **Add Scope** (optional)
9. Add a **Security scheme description** (optional)
### Hubs
![OAuth in Hubs](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-oauth-code.png?raw=true)
1. Select the Hub you wish to modify
2. Select **Code View**
3. Add the following lines of code to your Hub:
```
"config": {
"http": {
"oauth2": {
"credentials": {
"authorize_url": "insert authorize url here",
"access_token_url": "insert access token url here",
}
}
}
}
```
---
**Related Articles**
- [Digital Oceans: Introduction to OAuth2](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2)
- [Security Schemes](/modeling/modeling-with-openapi/security-schemes)

View File

@@ -1,54 +0,0 @@
# Stoplight Classic to Stoplight Next Migration Notes
## Platform
| | **Stoplight Classic (v2)** | **Stoplight Next (v3)** |
| :---------------------- | :---------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **File Types** | RAML and YAML | YAML |
| **Commits** | Basic Commit System | [Platform backed by Git, all files are Git Repos and have full Git commit support](/platform/projects/git-repo) |
| **Collaborative Space** | Workspaces | [Projects](/platform/projects/creating-a-project), [Organizations](/platform/organizations/create-org), and [Teams](/platform/organizations/teams/create-team) |
| **Billing** | Individual Billing | [Individual Billing](/platform/getting-started/billing/plans-overview), [Organization Billing](/platform/getting-started/billing/organization-plan-overview), and [Fair Billing Policy](/platform/getting-started/billing/fair-billing) |
| **Swagger Extensions** | Not supported | Supported |
| **Change History** | Basic Commit History | [Full Commit History Backed by Git](/platform/editor-basics/change-history) |
| **Project Visibility** | Private Projects | [Private and Public Organizations and Projects](/platform/projects/visibility) |
| **Guest Role** | Guests (read-only) count towards your team size | [50 Guest limit that doesn't count towards your team size](/platform/getting-started/billing/fair-billing) |
| **Ref Builder** | Not supported | [Supported](/documentation/referencing-other-data-sources) |
| **Access Tokens** | Not supported | Supported |
| **Code View** | Not supported | [Supported](/platform/editor-basics/read-design-code-view) |
## Modeling
| | **Stoplight Classic (v2)** | **Stoplight Next (v3)** |
| :----------------------- | :------------------------: | :---------------------------------------------------------------------------------------------: |
| **Shared Specification** | Traits | [Shared Models and Parameters](/modeling/modeling-with-openapi/shared-parameters-and-responses) |
| **Grouping** | Grouping | [Hubs Ref Builder](/documentation/referencing-other-data-sources) |
| **Documentation Design** | Modeling | [Hub](/documentation/introduction) |
| **API Discovery** | Supported | Coming Soon |
| **Bulk Editing** | Supported | [Code View Editor](/platform/editor-basics/read-design-code-view) |
## Hubs
| | **Stoplight Classic (v2)** | **Stoplight Next (v3)** |
| :------------------------- | :------------------------: | :------------------------------------------------------------------------------------------------------------------------------: |
| **Documentation Produced** | API Reference | API Reference, Supplementary Documentation, and Auxillary Documentation |
| **Linking** | SRN | Markdown |
| **Routes** | Slug | [Markdown](/documentation/getting-started/routing) |
| **Hiding Models** | Supported | Coming Soon |
| **Authentication** | Basic Auth and OAuth 2.0 | [Basic Auth, Auth0, OAuth 2.0, and SAML with multiple security scheme support](/modeling/modeling-with-openapi/security-schemes) |
| **Workflow** | Creation through Modeling | [Standalone Documentation Tool](/documentation/introduction) (Hubs) |
| **Custom Domain** | Email Support | Automated |
## Prism
| | **Stoplight Classic (v2)** | **Stoplight Next (v3)** |
| :--------------------- | :------------------------------------------------------------------: | :----------------------------------------------------------: |
| **HTTP Requests** | Logs HTTP Requests | Coming Soon |
| **Prism Instances** | Every version supported by Mock Server and Proxy Server | [Unlimited amount of Prism Instances](/mocking/introduction) |
| **Javascript Runtime** | [API](https://help.stoplight.io/prism/runtime-reference/api) | [API](/mocking/javascript-runtime) |
| **Prism Command Line** | [Commands](https://help.stoplight.io/prism/getting-started/commands) | Commands Changed |
## Scenarios
| | **Stoplight Classic (v2)** | **Stoplight Next (v3)** |
| :---------- | :------------------------: | :---------------------------------------------------: |
| **Testing** | Not Available | [Integrated into the platform](/testing/introduction) |

View File

@@ -43,7 +43,7 @@ There are many benefits to using JSON, some of which include:
be written in YAML, so either format can be used to write OpenAPI specifications be written in YAML, so either format can be used to write OpenAPI specifications
* It can be used to link files together through [JSON * It can be used to link files together through [JSON
references](/modeling/modeling-with-openapi/referencing-another-api-spec), making it easy to break up large documents references](/modeling/introduction/modeling-with-openapi/referencing-another-api-spec), making it easy to break up large documents
into smaller, more focused documents into smaller, more focused documents
Whether you are modeling an API, creating a Prism Collection, or writing Whether you are modeling an API, creating a Prism Collection, or writing

View File

@@ -30,4 +30,4 @@ There are a few ways to get started designing your API with the Stoplight design
- Create an API from scratch [Using the CRUD Builder](/modeling/modeling-with-openapi/using-the-crud-builder) - Create an API from scratch [Using the CRUD Builder](/modeling/modeling-with-openapi/using-the-crud-builder)
- [Reference another API Spec](/modeling/modeling-with-openapi/referencing-another-api-spec) - [Reference another API Spec](/modeling/modeling-with-openapi/referencing-another-api-spec)
- [Send HTTP Requests](/modeling/modeling-with-openapi/sending-http-requests) to an existing API Spec - [Send HTTP Requests](/modeling/modeling-with-openapi/sending-http-requests) to an existing API Spec
- [Validate your API Spec](/modeling/modeling-with-openapi/validating-your-api-spec) - [Validate your API Spec](/modeling/modeling-with-openapi/validating-your-api-sec)

View File

@@ -31,5 +31,4 @@ Use the HTTP Request Maker to send requests to the endpoints defined in your spe
--- ---
**Related Articles** **Related Articles**
[Using Environment Variables](/testing/using-variables/environment)
- [Using Environment Variables](/testing/using-variables/environment)

View File

@@ -1,43 +0,0 @@
# Technical Writer Playbook
Documenting an API is crucial to its success but can be extremely time consuming. Here at Stoplight, we believe documentation should be beautiful, clean, and robust while maintaining a streamlined turnaround time. Weve created a holistic documentation tool, Hubs, to address some of the problems our users were facing including:
- Documenting Endpoints
- Testing Endpoints
- Creating Non-Reference Documentation
- Managing Content
- External and Internal Referencing
- Design and Style
## Documenting Endpoints
The most key component to API Documentation are its endpoints. To that end, we created a reference builder that allows you to [“power pages”](/documentation/referencing-other-data-sources) with your specification as you see fit. When you power a page or subpage with your specification, the endpoints are automatically documented and styled for legibility and aesthetic design.
## Testing Endpoints
Testing endpoints is a valuable tool for anyone who wants to consume your API. Users want to know that your API functions properly before they commit to using it. To address this problem, we created [“Try it Out,” an HTTP Request Maker](/modeling/modeling-with-openapi/sending-http-requests). Try it Out allows you to send HTTP Requests to your API to test out its endpoints under any number of different conditions. You can customize Try it Out with security schemes, variables, headers, queries, and it even generates code in various programming languages.
## Creating Non-Reference Documentation
Great documentation is more than just API endpoints. Guides, tutorials, and other supplemental information enhance your users experience by providing them with all the information they need to access your API and your product. We broadened Hubs scope to accomodate all product documentation needs. You can easily build out your content within [Blocks](/documentation/blocks), a number of flexible content structures that can house a number of different forms of content including markdown, images, code snippets, and much more.
## Managing Content
Organizing a complex APIs endpoints and supplemental information can be a challenging task. Some specification can have hundreds of endpoints with supplemental information throughout. To assist with organizing content, we created an overview of all your pages, subpages, and their connections called “Table of Contents”. With a birds eye view of your content, you can easily organize and manage your content through drag drop functionality.
## External and Internal Referencing
To accomodate a larger variety of writing workflows, we expanded the capabilities of [Powering a Page](/documentation/referencing-other-data-sources) to allow for more files internally and externally to be referenced. You can now easily reference internal or external specifications, and Markdown, YAML, JSON, and Scenario files.
## Design and Style
We wanted to create a new, beautiful, minimalistic, efficient design for less design-oriented individuals while allowing for customization. Hubs was designed to display your documentation in a neat, efficient structure, designed specifically for displaying the real beauty, your API. On the other hand, we didnt want to stifle the creativity that goes into documentation design so we added in [theming](/documentation/design/theming) and [custom CSS](/documentation/design/custom-css). We also made it easier to add navigation, different kinds of content, and a more robust search.
---
Related Links
- [Documentation with Hubs](/documentation/introduction)
- [Routing](/documentation/getting-started/routing)
- [Headers](/documentation/getting-started/header-footer)
- [Pages](/documentation/getting-started/pages)
- [Subpages](/documentation/getting-started/subpages)
- [Blocks](/documentation/blocks)
- [Referencing Other Data Sources](/documentation/referencing-other-data-sources)
- [Publishing](/documentation/publishing)
- [Theming](/documentation/design/theming)
- [Custom CSS](/documentation/design/custom-css)

View File

View File

@@ -47,7 +47,8 @@ The [Prism Helpers](https://next.stoplight.io/stoplight/prism) project is a coll
**Related Articles** **Related Articles**
* [Javascript Runtime](/mocking/javascript-runtime) * [Javascript Runtime Refrence](/runtime.md)
* [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
* [Running Tests In Stoplight](/testing/running-tests/in-stoplight) * [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
* [Running Tests in the Terminal](/testing/running-tests/in-the-terminal) * [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
* [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url) * [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)
@@ -55,5 +56,6 @@ The [Prism Helpers](https://next.stoplight.io/stoplight/prism) project is a coll
* [$$.env (Environment)](/testing/using-variables/environment) * [$$.env (Environment)](/testing/using-variables/environment)
* [$.ctx(Context)](/testing/using-variables/context) * [$.ctx(Context)](/testing/using-variables/context)
* [Sending HTTP Requests](/testing/sending-http-requests/overview) * [Sending HTTP Requests](/testing/sending-http-requests/overview)
* [Referencing other Scenarios](/testing/referencing-other-scenarios/overview)
* [Contract Testing](/testing/leveraging-openapi/contract-testing) * [Contract Testing](/testing/leveraging-openapi/contract-testing)
* [Integrating in Continuous Integration](/testing/continuous-integration/overview) * [Integrating in Continuous Integration](/testing/continuous-integration/overview)

View File

@@ -120,11 +120,10 @@ var data = SL.schema.generate(contract);
#### Find Operation #### Find Operation
The code snippet below describes the Stoplight representation of an HTTP operation. It is loosely based on OAS 3. You can find more descriptions of some of the properties described below [here](https://swagger.io/specification/#operationObject).
```js ```js
/** /**
* *
* This describes the Stoplight representation of an HTTP operation. It is loosely based on OAS 3. You can find more descriptions of some of the properties described below here: https://swagger.io/specification/#operationObject.
* *
* @typedef {Object} Operation * @typedef {Object} Operation
* @property {string} method * @property {string} method

View File

@@ -1,4 +1,4 @@
# Making Your Project Private & Public ## Making Your Project Private & Public
![Project Visibility](https://github.com/stoplightio/docs/blob/develop/assets/images/project-make-public.png?raw=true) ![Project Visibility](https://github.com/stoplightio/docs/blob/develop/assets/images/project-make-public.png?raw=true)

View File

@@ -19,4 +19,4 @@
**Related Articles** **Related Articles**
- [Delete an Organization](/platform/organizations/delete-org) - [Delete an Organization](/platform/organizations/delete-org)
- [Transfer Ownership of a Team](/platform/organizations/teams/transfer-ownership) - [Transfer Ownership of a Team](/platform/organizations/teams/transfer-ownership)
- [Delete a Team](/platform/organizations/teams/delete)

View File

@@ -86,6 +86,7 @@ Any validation errors will automatically be added to the test results.
--- ---
**Related Articles** **Related Articles**
- [Testing Introduction](/testing/introduction) - [Testing Introduction](/testing/introduction)
- [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
- [Running Tests In Stoplight](/testing/running-tests/in-stoplight) - [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
- [Running Tests in the Terminal](/testing/running-tests/in-the-terminal) - [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
- [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url) - [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)
@@ -93,4 +94,4 @@ Any validation errors will automatically be added to the test results.
- [$$.env (Environment)](/testing/using-variables/environment) - [$$.env (Environment)](/testing/using-variables/environment)
- [$.ctx(Context)](/testing/using-variables/context) - [$.ctx(Context)](/testing/using-variables/context)
- [Sending HTTP Requests](/testing/sending-http-requests/overview) - [Sending HTTP Requests](/testing/sending-http-requests/overview)
- [Referencing other Scenarios](/testing/referencing-other-scenarios/overview)

View File

@@ -24,10 +24,11 @@ API tests provide insight into how your API behaves under certain scenarios and
Microservices and serverless architecture have made it easier than ever to iterate quickly. The downside of rapid development is an increase in bugs and technical debt, making projects harder to manage without a proper testing solution. It is critical to have a comprehensive test suite to allow teams to test the API during development. Microservices and serverless architecture have made it easier than ever to iterate quickly. The downside of rapid development is an increase in bugs and technical debt, making projects harder to manage without a proper testing solution. It is critical to have a comprehensive test suite to allow teams to test the API during development.
>Stoplight makes it easy to create a full suite of tests by providing [Environment](/testing/using-variables/environment) and [Context variables](/testing/using-variables/context), and the ability to reference other scenarios to accelerate test generation and reduce duplication. >Stoplight makes it easy to create a full suite of tests by providing [Environment](/testing/using-variables/environment) and [Context variables](/testing/using-variables/context), and the ability to [reference other scenarios](/testing/referencing-other-scenarios/overview) to accelerate test generation and reduce duplication.
--- ---
**Related Articles** **Related Articles**
- [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
- [Running Tests In Stoplight](/testing/running-tests/in-stoplight) - [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
- [Running Tests in the Terminal](/testing/running-tests/in-the-terminal) - [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
- [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url) - [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)
@@ -35,7 +36,8 @@ Microservices and serverless architecture have made it easier than ever to itera
- [$$.env (Environment)](/testing/using-variables/environment) - [$$.env (Environment)](/testing/using-variables/environment)
- [$.ctx(Context)](/testing/using-variables/context) - [$.ctx(Context)](/testing/using-variables/context)
- [Sending HTTP Requests](/testing/sending-http-requests/overview) - [Sending HTTP Requests](/testing/sending-http-requests/overview)
- [Contract Testing](/testing/leveraging-openapi/contract-testing) - [Referencing other Scenarios](/testing/referencing-other-scenarios/overview)
- [Contract Testing](testing/leveraging-openapi/contract-testing)
- [Integrating in Continuous Integration](/testing/continuous-integration/overview) - [Integrating in Continuous Integration](/testing/continuous-integration/overview)
- [Integrating with Jenkins](/testing/continuous-integration/jenkins) - [Integrating with Jenkins](/testing/continuous-integration/jenkins)
- [Integrating with Travis](/testing/continuous-integration/travis) - [Integrating with Travis](/testing/continuous-integration/travis)

View File

@@ -7,7 +7,7 @@ way is through the Stoplight editor.
> If you haven't created your first scenario yet, please [do so before > If you haven't created your first scenario yet, please [do so before
> continuing](/testing/introduction) > continuing](testing/introduction)
Scenarios in Stoplight are composed of three different levels: Scenarios in Stoplight are composed of three different levels:

View File

@@ -63,11 +63,11 @@ You can also run a contract test against a specific upstream URL with the
prism validate --spec /path/to/my/spec.json --upstream http://localhost:8080 prism validate --spec /path/to/my/spec.json --upstream http://localhost:8080
``` ```
For more information on contract testing and how it can be used, see [here](/testing/leveraging-openapi/contract-testing). For more information on contract testing and how it can be used, see [here](testing/leveraging-openapi/contract-testing).
--- ---
**Related Articles** **Related Articles**
- [Testing Introduction](/testing/introduction) - [Testing Introduction](/testing/introduction)
- [Contract Testing](/testing/leveraging-openapi/contract-testing) - [Contract Testing](testing/leveraging-openapi/contract-testing)
- [Integrating in Continuous Integration](/testing/continuous-integration/overview) - [Integrating in Continuous Integration](/testing/continuous-integration/overview)

View File

@@ -110,6 +110,7 @@ platforms.
--- ---
**Related Articles** **Related Articles**
- [Testing Introduction](/testing/introduction) - [Testing Introduction](/testing/introduction)
- [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
- [Running Tests In Stoplight](/testing/running-tests/in-stoplight) - [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
- [Running Tests in the Terminal](/testing/running-tests/in-the-terminal) - [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
- [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url) - [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB