Skip to content

Commit

Permalink
fix: openapi info section (#209)
Browse files Browse the repository at this point in the history
* feat: add openapi linter

* fix(lint): openapi linting

* fix(spectral): add version for CDN

* fix(openapi): linting openAPI files in test stage

* fix: make the info section compatible with v3.0.0

* style: format rust

* fix: remove openapi linter

* style: remove EOF line
  • Loading branch information
bkioshn authored Jan 17, 2024
1 parent 820ea53 commit fdbe65e
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions catalyst-gateway/bin/src/service/api/mod.rs
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

0 comments on commit fdbe65e

Please sign in to comment.