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

feat(oas2): add format link #527

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

feat(oas2): add format link #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1efbd0a
feat(oas2): add format link
Aug 4, 2020
827361b
chore(oas2): add format link to fixtures
Aug 4, 2020
68d4669
fix(oas3): change format link
Aug 4, 2020
d6c3c44
chore(oas2): change format link to fixtures
Aug 4, 2020
3a2fc98
Merge branch 'master' into marco/format-link
Aug 6, 2020
6664f14
chore(oas2): add format link to `swagger-zoo` fixtures
Aug 10, 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
4 changes: 4 additions & 0 deletions packages/openapi2-parser/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# API Elements: OpenAPI 2 Parser Changelog

## Master

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

## 0.32.3 (2020-08-06)

Adds compatibility for @apielements/core 0.2.0.
Expand Down
13 changes: 13 additions & 0 deletions packages/openapi2-parser/lib/parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ class Parser {
// By default there are no groups, just the root API element
this.group = this.api;

this.addFormatLink();
this.handleSwaggerInfo();
this.handleSwaggerHost();
this.handleSwaggerAuth();
Expand Down Expand Up @@ -325,6 +326,18 @@ class Parser {
});
}

// Add the link to the format version specs
addFormatLink() {
const { Link } = this.namespace.elements;
const link = new Link();

link.title = 'OpenAPI 2';
link.relation = 'via';
link.href = 'https://spec.openapis.org/oas/v2.0';

return this.result.links.push(link);
}

// Converts the Swagger title and description
handleSwaggerInfo() {
const { Copy } = this.namespace.elements;
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/auth-extensions.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/auth-extensions.sourcemap.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/auth-multi-consumes.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/auth-multi-consumes.sourcemap.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/circular-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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/circular-example.sourcemap.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/consumes-invalid-type.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/consumes-invalid-type.sourcemap.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/consumes-multipart-file.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/consumes-multipart-file.sourcemap.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi2-parser/test/fixtures/data-structure-generation-nullable-member.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": "OpenAPI 2"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v2.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
Loading