Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit 4f53ed4

Browse files
committed
Merge pull request #13 from apiaryio/zdne/attributes-description
Attributes description
2 parents 8e015b7 + d99acfc commit 4f53ed4

File tree

3 files changed

+483
-764
lines changed

3 files changed

+483
-764
lines changed

Parse Result.md

Lines changed: 11 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ This document describes API Blueprint Serialized Parse Result Media Types – th
55

66
## Version
77

8-
+ **Version**: 2.0
8+
+ **Version**: 2.1
99
+ **Created**: 2014-06-09
10-
+ **Updated**: 2014-10-07
11-
+ **AST Serialization Media Types**: 2.1
10+
+ **Updated**: 2014-11-27
11+
+ **AST Serialization Media Types**: 3.0
1212

1313
---
1414

@@ -17,7 +17,6 @@ This document describes API Blueprint Serialized Parse Result Media Types – th
1717
+ [Parse Result Description](#parse-result-description)
1818
+ [Media Types](#media-types)
1919
+ [JSON serialization](#json-serialization)
20-
+ [YAML serialization](#yaml-serialization)
2120
+ [Keys description](#keys-description)
2221

2322
---
@@ -34,10 +33,10 @@ Following is the description of Parse Result media types using the [MSON](https:
3433
- `warnings` (array[[Warning](#warning)]) - Ordered array of warnings occurred during the parsing, if any
3534

3635
### AST
37-
This object is the [Blueprint](README.md#blueprint-object) object as defined in the [AST Blueprint serialization Media Type v2.1](https://github.com/apiaryio/api-blueprint-ast).
36+
This object is the [Blueprint](README.md#blueprint-object) object as defined in the [AST Blueprint serialization Media Type](https://github.com/apiaryio/api-blueprint-ast).
3837

3938
### Source Map
40-
This object is the [Blueprint Source Map](README.md#blueprint-source-map) object as defined in [AST Blueprint serialization Media Type v2.1](https://github.com/apiaryio/api-blueprint-ast).
39+
This object is the [Blueprint Source Map](README.md#blueprint-source-map) object as defined in [AST Blueprint serialization Media Type](https://github.com/apiaryio/api-blueprint-ast).
4140

4241
### Error
4342

@@ -55,7 +54,7 @@ Description of a warning from the parser.
5554

5655
#### Properties
5756

58-
+ `code` (number) - Warning [group code](https://github.com/apiaryio/snowcrash/blob/master/src/SourceAnnotation.h#L128)
57+
+ `code` (number) - Warning [group code](https://github.com/apiaryio/snowcrash/blob/master/src/SourceAnnotation.h#L115)
5958
+ `message` (string) - Warning message
6059
+ `location` ([Source Map](README.md#source-map)) – Warning source map
6160

@@ -77,19 +76,19 @@ Two supported, feature-equal serialization formats are JSON and YAML:
7776
Parser Result Media Types inherit from the respective [AST Serialization Type](README.md):
7877

7978
+ [`application/vnd.apiblueprint.ast.*+json`](#json-serialization)
80-
+ [`application/vnd.apiblueprint.ast.*+yaml`](#yaml-serialization)
79+
+ `application/vnd.apiblueprint.ast.*+yaml`
8180
+ [`application/vnd.apiblueprint.sourcemap+json`](#json-serialization)
82-
+ [`application/vnd.apiblueprint.sourcemap+yaml`](#yaml-serialization)
81+
+ `application/vnd.apiblueprint.sourcemap+yaml`
8382

8483
### JSON Serialization
8584

86-
`application/vnd.apiblueprint.parseresult.*+json; version=2.0`
85+
`application/vnd.apiblueprint.parseresult.*+json; version=2.1`
8786

8887
```json
8988
{
90-
"_version": "2.0",
89+
"_version": "2.1",
9190
"ast": {
92-
"_version": "2.1",
91+
"_version": "3.0",
9392

9493
...
9594
},
@@ -120,31 +119,3 @@ Parser Result Media Types inherit from the respective [AST Serialization Type](R
120119
]
121120
}
122121
```
123-
124-
### YAML Serialization
125-
126-
`application/vnd.apiblueprint.parseresult.*+yaml; version=2.0`
127-
128-
```yaml
129-
_version: "2.0"
130-
ast:
131-
_version: "2.1"
132-
133-
...
134-
sourcemap:
135-
...
136-
error:
137-
code: <error code>
138-
message: "<error message>"
139-
location:
140-
- index: <character index>
141-
length: <character count>
142-
143-
warnings:
144-
- code: <warning code>
145-
message: "<warning message>"
146-
location:
147-
- index: <character index>
148-
length: <character count>
149-
```
150-

0 commit comments

Comments
 (0)