This repository has been archived by the owner on Nov 8, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #125 from apiaryio/pksunkara/1A7
Lazy Referencing for Resource Models. To be released with Snow Crash v0.16.0
- Loading branch information
Showing
3 changed files
with
7 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
--- | ||
|
||
Author: [email protected] | ||
Version: 1A6 | ||
Version: 1A7 | ||
|
||
--- | ||
|
||
# API Blueprint | ||
#### Format 1A revision 6 | ||
#### Format 1A revision 7 | ||
|
||
## [I. API Blueprint Language](#def-api-blueprint-language) | ||
1. [Introduction](#def-introduction) | ||
|
@@ -366,7 +366,7 @@ This section **should** include at least one following nested sections: | |
If there is no nested section the content of the payload section is considered as content of the [Body section](#def-body-section). | ||
|
||
#### Referencing | ||
Instead of providing a payload section content a previously defined [model payload section](#def-model-section) can be referenced using the Markdown implicit [reference syntax][]: | ||
Instead of providing a payload section content a [model payload section](#def-model-section) can be referenced using the Markdown implicit [reference syntax][]: | ||
|
||
[<identifier>][] | ||
|
||
|
@@ -613,7 +613,7 @@ Defined by the `Model` keyword followed by an optional media type: | |
A [resource manifestation](http://www.w3.org/TR/di-gloss/#def-resource-manifestation) - one exemplar representation of the resource in the form of a [payload](#def-payload-section). | ||
|
||
#### Referencing | ||
The payload defined in this section **may** be referenced later using parent section's identifier. You can refer to this payload in any of the following [Request](#def-request-section) or [Response](#def-response-section) payload sections using the Markdown implicit [reference syntax][]. | ||
The payload defined in this section **may** be referenced in any response or request section in the document using parent section's identifier. You can refer to this payload in any of the following [Request](#def-request-section) or [Response](#def-response-section) payload sections using the Markdown implicit [reference syntax][]. | ||
|
||
#### Example | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters