Update reference-spec.md

This commit is contained in:
Robert Wallach
2018-03-14 13:19:03 -05:00
committed by GitHub
parent 3baf13bdd4
commit 901da1746a

View File

@@ -4,7 +4,7 @@
## What
Referencing another specification allows for cleaner and more organized code. Some use cases are as follows...
Referencing another specification allows for cleaner and more organized code. Some use cases are as follows:
* Generate API documentaion in Hubs
* Deduplicate common structures like responses or shared parameters in Modeling
@@ -13,25 +13,25 @@ Referencing another specification allows for cleaner and more organized code. So
## How
1. Choose the **source**.
1. Choose the **source**
* This File
* This Project
* Select a **file**.
* Select a **file**
* Shared/Common
* External URL
* Enter a valid **URL** to an existing specification.
* Enter a valid **URL** to an existing specification
2. Select a **target**, if required.
2. Select a **target**, if required
3. Confirm your choice. (Only required if there is a confirm button)
4. View the referenced specification by clicking the book icon.
4. View the referenced specification by clicking the book icon
## Related Links