Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix a few minor openapi spec issues, upgrade remark and spectral #287

Merged
merged 7 commits into from
Mar 17, 2022
Merged

fix a few minor openapi spec issues, upgrade remark and spectral #287

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0971e5
fix a few minor openapi spec issues, upgrade remark and spectral
Mar 10, 2022
4519746
re-enable max line lenght
Mar 10, 2022
b28a87c
convert external spectral config into package.json
Mar 11, 2022
8a846d1
add remark-gfm plugin to fix issue with false positives on long lines…
Mar 11, 2022
ac16ed6
reformat
Mar 11, 2022
9ef192c
Merge branch 'dev' into openapi-cleanup-and-spectral-and-remark-upgrade
philvarner Mar 17, 2022
0c36fce
format tables in extensions
philvarner Mar 17, 2022
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
2 changes: 1 addition & 1 deletion .circleci/.spectral-fragments.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ rules:
openapi-tags: off
info-contact: off
oas3-api-servers: off
oas3-unused-components-schema: off
oas3-unused-component: off
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the name of this changed between spectral 5 and 6

operation-operationId: off
oas3-parameter-description: true
2 changes: 0 additions & 2 deletions .circleci/rc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ plugins:
- remark-lint-hard-break-spaces
- remark-lint-blockquote-indentation
- remark-lint-no-consecutive-blank-lines
- - remark-lint-maximum-line-length
- 150
# Code
- remark-lint-fenced-code-flag
- remark-lint-fenced-code-marker
Expand Down
12 changes: 1 addition & 11 deletions children/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ paths:
schema:
$ref: '../core/openapi.yaml#/components/schemas/landingPage'
example:
stac_version: 1.0.0-rc.1
stac_version: '1.0.0'
type: Catalog
id: sentinel
title: Copernicus Sentinel Imagery
Expand Down Expand Up @@ -107,16 +107,6 @@ components:
application/json:
schema:
$ref: '#/components/schemas/children'
InvalidParameter:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

latest spectral determined these are unused

description: |-
A query parameter has an invalid value.
content:
application/json:
schema:
$ref: '../core/commons.yaml#/components/schemas/exception'
NotFound:
description: |-
The requested URI was not found.
ServerError:
description: |-
A server error occurred.
Expand Down
9 changes: 1 addition & 8 deletions collections/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ paths:
schema:
$ref: '../core/openapi.yaml#/components/schemas/landingPage'
example:
stac_version: 1.0.0-rc.1
stac_version: '1.0.0'
type: Catalog
id: sentinel
title: Copernicus Sentinel Imagery
Expand Down Expand Up @@ -165,13 +165,6 @@ components:
application/json:
schema:
$ref: '../core/commons.yaml#/components/schemas/collection'
InvalidParameter:
description: |-
A query parameter has an invalid value.
content:
application/json:
schema:
$ref: '../core/commons.yaml#/components/schemas/exception'
NotFound:
description: |-
The requested URI was not found.
Expand Down
4 changes: 2 additions & 2 deletions core/commons.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ components:
- type: string
- type: number
example:
stac_version: 1.0.0
stac_version: '1.0.0'
stac_extensions: []
type: Collection
id: Sentinel-2
Expand Down Expand Up @@ -598,7 +598,7 @@ components:
assets:
$ref: '#/components/schemas/assets'
example:
stac_version: 1.0.0
stac_version: '1.0.0'
stac_extensions:
- 'https://stac-extensions.github.io/eo/v1.0.0/schema.json'
- 'https://stac-extensions.github.io/view/v1.0.0/schema.json'
Expand Down
2 changes: 1 addition & 1 deletion core/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ components:
$ref: '#/components/schemas/landingPage'
example:
type: Catalog
stac_version: 1.0.0
stac_version: '1.0.0'
id: sentinel
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
Expand Down
2 changes: 1 addition & 1 deletion ogcapi-features/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ paths:
schema:
$ref: '../core/openapi.yaml#/components/schemas/landingPage'
example:
stac_version: 1.0.0-rc.1
stac_version: '1.0.0'
type: Catalog
id: sentinel
title: Copernicus Sentinel Imagery
Expand Down
Loading