protagonist
Advanced tools
Comparing version 1.6.8 to 2.0.0-pre.0
# Protagonist Changelog | ||
## 2.0.0-pre.0 | ||
This update now uses Drafter 4.0.0-pre.0. Please see [Drafter | ||
4.0.0-pre.0](https://github.com/apiaryio/drafter/releases/tag/v4.0.0-pre.0) for | ||
the list of changes. | ||
- updated Async call to use Nan::AsyncQueue instead of node v8 functionality directly | ||
### Breaking | ||
- Removed the option to select AST Type. The ouput will be only refract | ||
- Drop support for node.js versions 0.10 and 0.12 | ||
## 1.6.8 | ||
@@ -4,0 +18,0 @@ |
# Drafter Changelog | ||
## 4.0.0-pre0 | ||
### Breaking | ||
* The following compiler versions are supported: | ||
* Microsoft Visual C++ 2015 or higher | ||
* GCC 5.3 or higher | ||
* Clang 4.0 or higher | ||
* Deprecated API Blueprint AST support has been removed. | ||
* Drafter will now produce API Elements 1.0 using the Refract 1.0 JSON Serialisation format. | ||
[Refract JSON Serialisation](https://github.com/refractproject/refract-spec/blob/master/formats/json-refract.md) | ||
[API Elements 1.0](http://apielements.org/) | ||
### Enhancements | ||
* Instead of returning int, functions that may error return `drafter_error` | ||
type. This adds additional type-safety when handling errors. | ||
## Bug Fixes | ||
* Fix JSON Schema "required" for multiple defined members | ||
[#493](https://github.com/apiaryio/drafter/issues/493) | ||
## 3.2.7 | ||
@@ -4,0 +30,0 @@ |
@@ -108,3 +108,3 @@ ![logo](https://raw.github.com/apiaryio/api-blueprint/master/assets/logo_apiblueprint.png) | ||
#### Checking the validity of a blueprint | ||
#### Checking the validity of a blueprint | ||
@@ -151,2 +151,11 @@ The `drafter_check_blueprint` function allows checking the validity of a | ||
## Build | ||
### Compiler Support | ||
| Compiler | Minimum Supported Version | | ||
|----------|---------------------------| | ||
| Clang | 4.0 | | ||
| GCC | 5.3 | | ||
| MSVC++ | 2015 | | ||
1. Clone the repo + fetch the submodules: | ||
@@ -153,0 +162,0 @@ |
{ | ||
"name": "protagonist", | ||
"version": "1.6.8", | ||
"version": "2.0.0-pre.0", | ||
"description": "API Blueprint Parser", | ||
@@ -12,3 +12,3 @@ "author": "Apiary.io <support@apiary.io>", | ||
"engines": { | ||
"node": ">=0.8.15" | ||
"node": ">=4" | ||
}, | ||
@@ -15,0 +15,0 @@ "dependencies": { |
@@ -28,3 +28,3 @@ ![logo](https://raw.github.com/apiaryio/api-blueprint/master/assets/logo_apiblueprint.png) | ||
Tested with node.js 0.10.x, 0.12.x, 4, 6, 7 | ||
Tested with node.js 4, 6, 7 | ||
@@ -73,6 +73,3 @@ ## Getting started | ||
`generateSourceMap` | Enable sourcemap generation (default: false) | ||
`type` | Set the output structure type as either `ast` or `refract` (default: `refract`) | ||
**NOTE**: *The `ast` option is deprecated in favour of `refract`.* | ||
### Parsing Result | ||
@@ -79,0 +76,0 @@ |
@@ -7,19 +7,40 @@ { | ||
"meta": { | ||
"classes": [ | ||
"error" | ||
] | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "error" | ||
} | ||
] | ||
} | ||
}, | ||
"attributes": { | ||
"code": 2, | ||
"sourceMap": [ | ||
{ | ||
"content": [ | ||
[ | ||
0, | ||
8 | ||
"code": { | ||
"element": "number", | ||
"content": 2 | ||
}, | ||
"sourceMap": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "sourceMap", | ||
"content": [ | ||
{ | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "number", | ||
"content": 0 | ||
}, | ||
{ | ||
"element": "number", | ||
"content": 8 | ||
} | ||
] | ||
} | ||
] | ||
], | ||
"element": "sourceMap" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}, | ||
@@ -31,19 +52,40 @@ "content": "expected API name, e.g. '# <API Name>'" | ||
"meta": { | ||
"classes": [ | ||
"warning" | ||
] | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "warning" | ||
} | ||
] | ||
} | ||
}, | ||
"attributes": { | ||
"code": 6, | ||
"sourceMap": [ | ||
{ | ||
"content": [ | ||
[ | ||
0, | ||
8 | ||
"attributes": { | ||
"code": { | ||
"element": "number", | ||
"content": 6 | ||
}, | ||
"sourceMap": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "sourceMap", | ||
"content": [ | ||
{ | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "number", | ||
"content": 0 | ||
}, | ||
{ | ||
"element": "number", | ||
"content": 8 | ||
} | ||
] | ||
} | ||
] | ||
], | ||
"element": "sourceMap" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}, | ||
@@ -50,0 +92,0 @@ "content": "action is missing a response" |
@@ -7,19 +7,40 @@ { | ||
"meta": { | ||
"classes": [ | ||
"warning" | ||
] | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "warning" | ||
} | ||
] | ||
} | ||
}, | ||
"attributes": { | ||
"code": 6, | ||
"sourceMap": [ | ||
{ | ||
"content": [ | ||
[ | ||
8, | ||
8 | ||
"code": { | ||
"element": "number", | ||
"content": 6 | ||
}, | ||
"sourceMap": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "sourceMap", | ||
"content": [ | ||
{ | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "number", | ||
"content": 8 | ||
}, | ||
{ | ||
"element": "number", | ||
"content": 8 | ||
} | ||
] | ||
} | ||
] | ||
], | ||
"element": "sourceMap" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}, | ||
@@ -26,0 +47,0 @@ "content": "action is missing a response" |
@@ -7,28 +7,46 @@ { | ||
"meta": { | ||
"classes": [ | ||
"api" | ||
], | ||
"title": "" | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "api" | ||
} | ||
] | ||
}, | ||
"title": { | ||
"element": "string", | ||
"content": "" | ||
} | ||
}, | ||
"attributes": { | ||
"meta": [ | ||
{ | ||
"element": "member", | ||
"meta": { | ||
"classes": [ | ||
"user" | ||
] | ||
}, | ||
"content": { | ||
"key": { | ||
"element": "string", | ||
"content": "FORMAT" | ||
"metadata": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "member", | ||
"meta": { | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "user" | ||
} | ||
] | ||
} | ||
}, | ||
"value": { | ||
"element": "string", | ||
"content": "1A" | ||
"content": { | ||
"key": { | ||
"element": "string", | ||
"content": "FORMAT" | ||
}, | ||
"value": { | ||
"element": "string", | ||
"content": "1A" | ||
} | ||
} | ||
} | ||
} | ||
] | ||
] | ||
} | ||
}, | ||
@@ -39,6 +57,15 @@ "content": [ | ||
"meta": { | ||
"classes": [ | ||
"resourceGroup" | ||
], | ||
"title": "Messages" | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "resourceGroup" | ||
} | ||
] | ||
}, | ||
"title": { | ||
"element": "string", | ||
"content": "Messages" | ||
} | ||
}, | ||
@@ -49,6 +76,12 @@ "content": [ | ||
"meta": { | ||
"title": "Message" | ||
"title": { | ||
"element": "string", | ||
"content": "Message" | ||
} | ||
}, | ||
"attributes": { | ||
"href": "/messages/{id}", | ||
"href": { | ||
"element": "string", | ||
"content": "/messages/{id}" | ||
}, | ||
"hrefVariables": { | ||
@@ -60,8 +93,17 @@ "element": "hrefVariables", | ||
"meta": { | ||
"description": "Id of a message" | ||
"description": { | ||
"element": "string", | ||
"content": "Id of a message" | ||
} | ||
}, | ||
"attributes": { | ||
"typeAttributes": [ | ||
"required" | ||
] | ||
"typeAttributes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "required" | ||
} | ||
] | ||
} | ||
}, | ||
@@ -75,16 +117,21 @@ "content": { | ||
"element": "enum", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "1" | ||
}, | ||
{ | ||
"element": "string", | ||
"content": "2" | ||
}, | ||
{ | ||
"element": "string", | ||
"content": "3" | ||
"attributes": { | ||
"enumerations": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "1" | ||
}, | ||
{ | ||
"element": "string", | ||
"content": "2" | ||
}, | ||
{ | ||
"element": "string", | ||
"content": "3" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
} | ||
@@ -99,40 +146,44 @@ } | ||
"element": "dataStructure", | ||
"content": [ | ||
{ | ||
"element": "object", | ||
"meta": { | ||
"id": "Message" | ||
"content": { | ||
"element": "object", | ||
"meta": { | ||
"id": { | ||
"element": "string", | ||
"content": "Message" | ||
} | ||
}, | ||
"content": [ | ||
{ | ||
"element": "member", | ||
"content": { | ||
"key": { | ||
"element": "string", | ||
"content": "id" | ||
}, | ||
"value": { | ||
"element": "number" | ||
} | ||
} | ||
}, | ||
"content": [ | ||
{ | ||
"element": "member", | ||
"content": { | ||
"key": { | ||
"element": "string", | ||
"content": "id" | ||
}, | ||
"value": { | ||
"element": "number" | ||
} | ||
{ | ||
"element": "member", | ||
"meta": { | ||
"description": { | ||
"element": "string", | ||
"content": "The Message" | ||
} | ||
}, | ||
{ | ||
"element": "member", | ||
"meta": { | ||
"description": "The Message" | ||
"content": { | ||
"key": { | ||
"element": "string", | ||
"content": "message" | ||
}, | ||
"content": { | ||
"key": { | ||
"element": "string", | ||
"content": "message" | ||
}, | ||
"value": { | ||
"element": "string", | ||
"content": "Hello World!" | ||
} | ||
"value": { | ||
"element": "string", | ||
"content": "Hello World!" | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}, | ||
@@ -142,3 +193,6 @@ { | ||
"meta": { | ||
"title": "Retrieve Message" | ||
"title": { | ||
"element": "string", | ||
"content": "Retrieve Message" | ||
} | ||
}, | ||
@@ -152,3 +206,6 @@ "content": [ | ||
"attributes": { | ||
"method": "GET" | ||
"method": { | ||
"element": "string", | ||
"content": "GET" | ||
} | ||
}, | ||
@@ -160,3 +217,6 @@ "content": [] | ||
"attributes": { | ||
"statusCode": "200", | ||
"statusCode": { | ||
"element": "string", | ||
"content": "200" | ||
}, | ||
"headers": { | ||
@@ -184,7 +244,5 @@ "element": "httpHeaders", | ||
"element": "dataStructure", | ||
"content": [ | ||
{ | ||
"element": "Message" | ||
} | ||
] | ||
"content": { | ||
"element": "Message" | ||
} | ||
}, | ||
@@ -194,8 +252,17 @@ { | ||
"meta": { | ||
"classes": [ | ||
"messageBody" | ||
] | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "messageBody" | ||
} | ||
] | ||
} | ||
}, | ||
"attributes": { | ||
"contentType": "application/json" | ||
"contentType": { | ||
"element": "string", | ||
"content": "application/json" | ||
} | ||
}, | ||
@@ -207,8 +274,17 @@ "content": "{\n \"id\": 0,\n \"message\": \"Hello World!\"\n}" | ||
"meta": { | ||
"classes": [ | ||
"messageBodySchema" | ||
] | ||
"classes": { | ||
"element": "array", | ||
"content": [ | ||
{ | ||
"element": "string", | ||
"content": "messageBodySchema" | ||
} | ||
] | ||
} | ||
}, | ||
"attributes": { | ||
"contentType": "application/schema+json" | ||
"contentType": { | ||
"element": "string", | ||
"content": "application/schema+json" | ||
} | ||
}, | ||
@@ -226,3 +302,6 @@ "content": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"The Message\"\n }\n }\n}" | ||
"meta": { | ||
"title": "Delete Message" | ||
"title": { | ||
"element": "string", | ||
"content": "Delete Message" | ||
} | ||
}, | ||
@@ -236,3 +315,6 @@ "content": [ | ||
"attributes": { | ||
"method": "DELETE" | ||
"method": { | ||
"element": "string", | ||
"content": "DELETE" | ||
} | ||
}, | ||
@@ -244,3 +326,6 @@ "content": [] | ||
"attributes": { | ||
"statusCode": "204" | ||
"statusCode": { | ||
"element": "string", | ||
"content": "204" | ||
} | ||
}, | ||
@@ -261,1 +346,2 @@ "content": [] | ||
} | ||
@@ -6,3 +6,3 @@ /* | ||
* | ||
* node ../perf-protagonist.js fixture-1.apib fixture-1-ast.json fixture-2.apib fixture-2-ast.json | ||
* node ../perf-protagonist.js fixture-1.apib fixture-1.json fixture-2.apib fixture-2.json | ||
*/ | ||
@@ -9,0 +9,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
2261
4246099
471
2
191
2