Skip to content

[IDP-1564] Add spectral to detect usage of base server url #21

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

Merged
merged 3 commits into from
May 29, 2024
Merged

[IDP-1564] Add spectral to detect usage of base server url #21

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
1d36613
[IDP-1564] Add spectral to detect usage of base server url
heqianwang May 28, 2024
ae357f5
Update description
heqianwang May 29, 2024
b27a6bb
update comment
heqianwang May 29, 2024
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
9 changes: 8 additions & 1 deletion .spectral.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,11 @@ rules:
then:
function: length
functionOptions:
max: 95
max: 95

must-not-use-base-server-url:
description: "Must not use base server url in spec to be able to generate a single client compatible with multiple environments."
severity: warn
given: $.servers[*].url
then:
function: falsy
16 changes: 16 additions & 0 deletions TestSpecs/must-not-use-base-server-url-invalid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
openapi: 3.0.1
info:
title: V1 API General
version: v1
servers:
- url: https://api.example.com/v1
paths:
/buy-item:
post:
tags:
- Shop
summary: Buy an item
operationId: BuyItem
responses:
'200':
description: Success
14 changes: 14 additions & 0 deletions TestSpecs/must-not-use-base-server-url-valid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
openapi: 3.0.1
info:
title: V1 API General
version: v1
paths:
/buy-item:
post:
tags:
- Shop
summary: Buy an item
operationId: BuyItem
responses:
'200':
description: Success
2 changes: 2 additions & 0 deletions test.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ $tests = @(
@{ rule = "items-must-have-a-type"; expectError = $true; filename = "items-must-have-a-type-invalid.yaml" },
@{ rule = "must-accept-content-types"; expectError = $false; filename = "must-accept-content-types-valid.yaml" },
@{ rule = "must-accept-content-types"; expectError = $true; filename = "must-accept-content-types-invalid.yaml" },
@{ rule = "must-not-use-base-server-url"; expectError = $false; filename = "must-not-use-base-server-url-valid.yaml" },
@{ rule = "must-not-use-base-server-url"; expectError = $true; filename = "must-not-use-base-server-url-invalid.yaml" },
@{ rule = "must-return-content-types"; expectError = $false; filename = "must-return-content-types-valid.yaml" },
@{ rule = "must-return-content-types"; expectError = $true; filename = "must-return-content-types-invalid.yaml" },
@{ rule = "must-support-client-credentials-oauth2"; expectError = $false; filename = "must-support-client-credentials-oauth2-valid.yaml" },
Expand Down