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

feat(oas3): add format link #533

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

feat(oas3): add format link #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8cb6eb7
feat(oas3): add format link
Aug 6, 2020
b7ebf79
chore(oas3): add format link to fixtures
Aug 6, 2020
2772392
docs(oas3): adjust changelog
Aug 13, 2020
01b6121
fix(oas3): improve regex expression
Aug 13, 2020
48abc84
fix(oas3): change formatVersion function
Aug 18, 2020
729dacb
chore(oas3): lint correction
Aug 18, 2020
f52cd03
fix(oas3): modify formatVersion function
Aug 18, 2020
88bcb56
fix(oas3): add format link when `OpenAPI` property is not a string
Aug 18, 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/openapi3-parser/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# API Elements: OpenAPI 3 Parser Changelog

## Unreleased

### Enhancements

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

## 0.15.0 (2020-08-06)

### Enhancements
Expand Down
29 changes: 27 additions & 2 deletions packages/openapi3-parser/lib/parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
const R = require('ramda');
const parseYAML = require('./parser/parseYAML');

const { isAnnotation, isWarningAnnotation, isObject } = require('./predicates');
const {
isAnnotation, isWarningAnnotation, isObject, isMember, hasKey, isString,
} = require('./predicates');
const { createError } = require('./elements');
const pipeParseResult = require('./pipeParseResult');

Expand Down Expand Up @@ -126,14 +128,37 @@ function parse(source, context) {
R.unless(isObjectOrAnnotation, createError(context.namespace, 'Source document is not an object')),
R.unless(isAnnotation, parseOpenAPIObject(context)));

return R.chain(
const parseResult = R.chain(
R.pipe(
parseDocument,
deduplicateUnsupportedAnnotations(context.namespace),
context.options.generateSourceMap ? filterColumnLine : filterSourceMaps
),
document
);

const formatVersion = R.tryCatch(
R.pipe(
R.prop('content'),
R.find(isObject),
R.prop('content'),
R.find(R.both(isMember, hasKey('openapi'))),
R.path(['content', 'value']),
R.ifElse(isString, R.prop('content'), R.always('3.0.3'))
), R.always('3.0.3')
)(document);

const formatLink = `https://spec.openapis.org/oas/v${formatVersion}`;
const { Link } = context.namespace.elements;
const link = new Link();

link.title = `OpenAPI ${formatVersion}`;
link.relation = 'via';
link.href = formatLink;

parseResult.links.push(link);

return parseResult;
}

module.exports = parse;
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/auth-scheme-does-not-exist.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/auth-scheme-does-not-exist.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/auth-scheme-global.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/auth-scheme-global.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/auth-scheme.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/auth-scheme.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions ...ages/openapi3-parser/test/integration/fixtures/components/media-type-object-examples.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions ...enapi3-parser/test/integration/fixtures/components/media-type-object-schema-multiple.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions packages/openapi3-parser/test/integration/fixtures/components/media-type-object-schema.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
26 changes: 26 additions & 0 deletions ...es/openapi3-parser/test/integration/fixtures/components/operation-object-requestBody.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 3.0.0"
}
},
"attributes": {
"relation": {
"element": "string",
"content": "via"
},
"href": {
"element": "string",
"content": "https://spec.openapis.org/oas/v3.0.0"
}
}
}
]
}
},
"content": [
{
"element": "category",
Expand Down
Loading