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

feat(apiaryb): add format link #535

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(apiaryb): add format link #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fb4c8d
feat(apiaryb): add format link
Aug 11, 2020
d134967
chore(apiaryb): add format link to fixtures
Aug 11, 2020
d923abf
refactor(apiaryb): remove comment
Aug 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/apiaryb-parser/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# API Elements: Apiary Blueprint Parser Changelog

## Master

### Enhancements

- added a Link element to the specific format/version in the parse result.

## 0.2.1 (2020-08-05)

Adds compatibility for @apielements/core 0.2.0.
Expand Down
9 changes: 8 additions & 1 deletion packages/apiaryb-parser/lib/parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class Parser {

parse() {
const {
Annotation, Category, Copy, ParseResult,
Annotation, Category, Copy, ParseResult, Link,
} = this.namespace.elements;

this.result = new ParseResult();
Expand All @@ -34,6 +34,12 @@ class Parser {
return this.result;
}

const link = new Link();
link.title = 'Apiary Blueprint';
link.relation = 'via';
link.href = 'https://apiary.io/blueprint';
this.result.links.push(link);

this.api = new Category();
this.api.classes.push('api');
this.api.title = this.blueprint.name;
Expand All @@ -56,6 +62,7 @@ class Parser {
});

this.result.push(this.api);

return this.result;
}

Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/description.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
28 changes: 27 additions & 1 deletion packages/apiaryb-parser/test/fixtures/example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down Expand Up @@ -394,4 +420,4 @@
]
}
]
}
}
49 changes: 49 additions & 0 deletions packages/apiaryb-parser/test/fixtures/format-link.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
"meta": {
"classes": {
"element": "array",
"content": [
{
"element": "string",
"content": "api"
}
]
},
"title": {
"element": "string",
"content": "Blueprint with Format Link"
}
}
}
]
}
1 change: 1 addition & 0 deletions packages/apiaryb-parser/test/fixtures/format-link.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--- Blueprint with Format Link ---
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/host-metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/host-path.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/host-trailing-slash-path.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/json-validations-host-path.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/json-validations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/title.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/apiaryb-parser/test/fixtures/unnamed-section.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
{
"element": "parseResult",
"meta": {
"links": {
"element": "array",
"content": [
{
"element": "link",
"meta": {
"title": {
"element": "string",
"content": "Apiary Blueprint"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://apiary.io/blueprint"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down