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

Commit d99acfc

Browse files
kylefpksunkara
authored andcommitted
Merge pull request #30 from apiaryio/pksunkara/drafter
Update snowcrash cli references to drafter
2 parents 5e0353a + 0077125 commit d99acfc

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Parse Result.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Description of a warning from the parser.
5454

5555
#### Properties
5656

57-
+ `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)
5858
+ `message` (string) - Warning message
5959
+ `location` ([Source Map](README.md#source-map)) – Warning source map
6060

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This document defines serialization formats for [API Blueprint](http://apibluepr
88

99
For the definition of API Blueprint AST Source Map see the [API Blueprint AST Source Map definition][Source Map Definition].
1010

11-
Converting API Blueprint to AST and its serialization is the task of API Blueprint Parser – [Snow Crash](https://github.com/apiaryio/snowcrash) or one of its [bindings](https://github.com/apiaryio/snowcrash#bindings). Reverse process from AST (serialization) to API Blueprint is also possible thanks to the [Matter Compiler](https://github.com/apiaryio/matter_compiler).
11+
Converting API Blueprint to AST and its serialization is the task of API Blueprint Parser – [Drafter](https://github.com/apiaryio/drafter) or one of its [bindings](https://github.com/apiaryio/drafter#bindings). Reverse process from AST (serialization) to API Blueprint is also possible thanks to the [Matter Compiler](https://github.com/apiaryio/matter_compiler).
1212

1313
## Don't like to design APIs in JSON or YAML?
1414
If you are looking for a way to describe your Web API without using JSON or YAML see [API Blueprint](https://github.com/apiaryio/api-blueprint).
@@ -29,7 +29,7 @@ towards unified document-structure based on the concept of DOM elements
2929
+ [Media Types](#media-types)
3030
+ [Keys description](#keys-description)
3131
+ [Example: JSON serialization](#example-json-serialization)
32-
+ [Serialization in Snow Crash](#serialization-in-snow-crash)
32+
+ [Serialization in Drafter](#serialization-in-drafter)
3333
+ [Serialized Parsing Result Media Types][parsing media types]
3434

3535
## AST Definition
@@ -496,8 +496,8 @@ Two supported, feature-equal serialization formats are JSON and YAML:
496496
## Related Media Types
497497
- [**Serialized Parsing Result Media Types**][Parsing media types] - Media types for the serialization of complete parsing results (including warnings and errors)
498498

499-
## Serialization in Snow Crash
500-
The `snowcrash` [command-line tool](https://github.com/apiaryio/snowcrash#snow-crash-command-line-tool) supports serialization of [API Blueprint AST](https://github.com/apiaryio/snowcrash/blob/master/src/Blueprint.h) via the `--format` option. Similarly, it also supports serialization of [API Blueprint Source Map](https://github.com/apiaryio/snowcrash/blob/master/src/BlueprintSourcemap.h) using the `--format` and `--sourcemap` option.
499+
## Serialization in Drafter
500+
The `drafter` [command-line tool](https://github.com/apiaryio/drafter#drafter-command-line-tool) supports serialization of [API Blueprint AST](https://github.com/apiaryio/snowcrash/blob/master/src/Blueprint.h) via the `--format` option. Similarly, it also supports serialization of [API Blueprint Source Map](https://github.com/apiaryio/snowcrash/blob/master/src/BlueprintSourcemap.h) using the `--format` and `--sourcemap` option.
501501

502502
## License
503503
MIT License. See the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)