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: openapi info section #209

Merged
merged 8 commits into from
Jan 17, 2024
Merged

fix: openapi info section #209

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7c7478c
feat: add openapi linter
bkioshn Jan 13, 2024
add302d
fix(lint): openapi linting
bkioshn Jan 16, 2024
e7b6d3b
fix(spectral): add version for CDN
bkioshn Jan 16, 2024
9272740
fix(openapi): linting openAPI files in test stage
bkioshn Jan 16, 2024
b0b1884
fix: make the info section compatible with v3.0.0
bkioshn Jan 17, 2024
c931b46
style: format rust
bkioshn Jan 17, 2024
90666df
fix: remove openapi linter
bkioshn Jan 17, 2024
e5b655d
style: remove EOF line
bkioshn Jan 17, 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
8 changes: 1 addition & 7 deletions catalyst-gateway/bin/src/service/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@ fn get_api_contact() -> ContactObject {
.url("https://projectcatalyst.io")
}

/// A summary describing the API
const API_SUMMARY: &str = "Project Catalyst Gateway API";

/// A long description of the API. Markdown is supported
const API_DESCRIPTION: &str = r#"# Catalyst Gateway API.

Expand All @@ -51,9 +48,7 @@ TODO:

/// Get the license details for the API
fn get_api_license() -> LicenseObject {
LicenseObject::new("Apache 2.0")
.url("https://www.apache.org/licenses/LICENSE-2.0")
.identifier("Apache-2.0")
LicenseObject::new("Apache 2.0").url("https://www.apache.org/licenses/LICENSE-2.0")
}

/// Get the terms of service for the API
Expand All @@ -72,7 +67,6 @@ pub(crate) fn mk_api(
.contact(get_api_contact())
.description(API_DESCRIPTION)
.license(get_api_license())
.summary(API_SUMMARY)
.terms_of_service(TERMS_OF_SERVICE)
.url_prefix(API_URL_PREFIX.as_str());

Expand Down