Skip to content

tuning action #2

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

Jump to bottom
Merged
merged 12 commits into from
Jun 6, 2025
Merged

tuning action #2

merged 12 commits into from
Jun 6, 2025

Conversation

@daveshanley
Copy link
Member

@daveshanley daveshanley commented Jun 6, 2025

No description provided.

@github-actions
Copy link

github-actions bot commented Jun 6, 2025 •
edited
Loading

vacuum OpenAPI quality report

vacuum has graded this OpenAPI specification with a score of 99 out of a possible 100

⚠️1 warnings detected

vacuum detected warnings in your OpenAPI specification, please review and address accordingly.

vacuum ran against the following 48 rules:
  • 🔴 path-params (Check path validity and definition)
  • 🔴 path-not-include-query (Check path excludes query string)
  • 🔴 path-declarations-must-exist (Check path parameter declarations)
  • 🔴 operation-parameters (Check operation parameters)
  • 🔴 operation-operationId-valid-in-url (Check operationId is URL friendly)
  • 🔴 operation-operationId-unique (Check operations for unique operationId)
  • 🔴 operation-operationId (Check operations for an operationId)
  • 🔴 oas3-schema (Check spec is valid OpenAPI 3)
  • 🔴 oas3-operation-security-defined (Check operation security)
  • 🔴 oas3-no-$ref-siblings (Check for siblings to $ref values)
  • 🔴 oas2-schema (Check schema is valid OpenAPI 2)
  • 🔴 oas2-operation-security-defined (Check operation security)
  • 🔴 oas2-oneOf (Check for invalid use of 'oneOf')
  • 🔴 oas2-discriminator (Discriminator check)
  • 🔴 oas2-anyOf (Check for invalid use of 'anyOf')
  • 🔴 oas-schema-check (schemas must have a valid type defined)
  • 🔴 no-script-tags-in-markdown (Check descriptions for '<script>' tags)
  • 🔴 no-eval-in-markdown (Check descriptions for 'eval()' statements)
  • 🔴 no-ambiguous-paths (No ambiguous paths, each path must resolve unambiguously)
  • 🔴 no-$ref-siblings (Check for siblings to $ref values)
  • 🔴 info-license-spdx (Check license object for URL or identifier, but not both)
  • 🔴 info-description (Check for a specification description)
  • 🔴 duplicated-entry-in-enum (Check for duplicate enum entries)
  • ⚠️ typed-enum (Check enum types)
  • ⚠️ paths-kebab-case (Path segments must be kebab-case only)
  • ⚠️ path-keys-no-trailing-slash (Check path for any trailing slashes)
  • ⚠️ operation-tags (Check operation tags are used)
  • ⚠️ operation-tag-defined (Check operation tags exist globally)
  • ⚠️ operation-success-response (Check operations for success response)
  • ⚠️ operation-description (Check operation description)
  • ⚠️ oas3-valid-schema-example (Check all example schemas are valid)
  • ⚠️ oas3-unused-component (Check for unused components)
  • ⚠️ oas3-parameter-description (Check parameter description)
  • ⚠️ oas3-missing-example (Check schemas, headers, parameters and media types all have examples present.)
  • ⚠️ oas3-example-external-check (Check schemas, headers, parameters and media types use either 'example' or 'externalValue' but not both.)
  • ⚠️ oas3-api-servers (Validate API server definitions)
  • ⚠️ oas2-unused-definition (Check for unused definitions)
  • ⚠️ oas2-parameter-description (Check parameter description)
  • ⚠️ oas2-operation-formData-consume-check (Check operation parameter 'formData' definition)
  • ⚠️ oas2-host-trailing-slash (Check host for trailing slash)
  • ⚠️ oas2-host-not-example (Check server URLs for example.com)
  • ⚠️ oas2-api-schemes (Check host schemes are defined)
  • ⚠️ no-request-body (Check GET and DELETE methods do not accept request bodies)
  • ⚠️ no-http-verbs-in-path (Paths cannot contain HTTP verbs as segments)
  • ⚠️ component-description (Check component description)
  • ℹ️ path-item-refs (Check path items have not used references)
  • ℹ️ oas2-api-host (Check spec for 'host' value)
  • ℹ️ description-duplication (Check descriptions for duplicates)

Examples violations

⚠️️ Warnings: 1 ⚠️️ oas3-missing-example: 1
location JSONPath
316:9 $.components.schemas['Fries'].properties['seasoning']
Category Errors Warnings Info
Examples 0 1 0

@github-actions
Copy link

github-actions bot commented Jun 6, 2025

No description provided.

@github-actions
Copy link

github-actions bot commented Jun 6, 2025

vacuum OpenAPI quality report

vacuum has graded this OpenAPI specification with a score of 99 out of a possible 100

⚠️1 warnings detected

vacuum detected warnings in your OpenAPI specification, please review and address accordingly.

vacuum ran against the following 48 rules:
  • 🔴 path-params (Check path validity and definition)
  • 🔴 path-not-include-query (Check path excludes query string)
  • 🔴 path-declarations-must-exist (Check path parameter declarations)
  • 🔴 operation-parameters (Check operation parameters)
  • 🔴 operation-operationId-valid-in-url (Check operationId is URL friendly)
  • 🔴 operation-operationId-unique (Check operations for unique operationId)
  • 🔴 operation-operationId (Check operations for an operationId)
  • 🔴 oas3-schema (Check spec is valid OpenAPI 3)
  • 🔴 oas3-operation-security-defined (Check operation security)
  • 🔴 oas3-no-$ref-siblings (Check for siblings to $ref values)
  • 🔴 oas2-schema (Check schema is valid OpenAPI 2)
  • 🔴 oas2-operation-security-defined (Check operation security)
  • 🔴 oas2-oneOf (Check for invalid use of 'oneOf')
  • 🔴 oas2-discriminator (Discriminator check)
  • 🔴 oas2-anyOf (Check for invalid use of 'anyOf')
  • 🔴 oas-schema-check (schemas must have a valid type defined)
  • 🔴 no-script-tags-in-markdown (Check descriptions for '<script>' tags)
  • 🔴 no-eval-in-markdown (Check descriptions for 'eval()' statements)
  • 🔴 no-ambiguous-paths (No ambiguous paths, each path must resolve unambiguously)
  • 🔴 no-$ref-siblings (Check for siblings to $ref values)
  • 🔴 info-license-spdx (Check license object for URL or identifier, but not both)
  • 🔴 info-description (Check for a specification description)
  • 🔴 duplicated-entry-in-enum (Check for duplicate enum entries)
  • ⚠️ typed-enum (Check enum types)
  • ⚠️ paths-kebab-case (Path segments must be kebab-case only)
  • ⚠️ path-keys-no-trailing-slash (Check path for any trailing slashes)
  • ⚠️ operation-tags (Check operation tags are used)
  • ⚠️ operation-tag-defined (Check operation tags exist globally)
  • ⚠️ operation-success-response (Check operations for success response)
  • ⚠️ operation-description (Check operation description)
  • ⚠️ oas3-valid-schema-example (Check all example schemas are valid)
  • ⚠️ oas3-unused-component (Check for unused components)
  • ⚠️ oas3-parameter-description (Check parameter description)
  • ⚠️ oas3-missing-example (Check schemas, headers, parameters and media types all have examples present.)
  • ⚠️ oas3-example-external-check (Check schemas, headers, parameters and media types use either 'example' or 'externalValue' but not both.)
  • ⚠️ oas3-api-servers (Validate API server definitions)
  • ⚠️ oas2-unused-definition (Check for unused definitions)
  • ⚠️ oas2-parameter-description (Check parameter description)
  • ⚠️ oas2-operation-formData-consume-check (Check operation parameter 'formData' definition)
  • ⚠️ oas2-host-trailing-slash (Check host for trailing slash)
  • ⚠️ oas2-host-not-example (Check server URLs for example.com)
  • ⚠️ oas2-api-schemes (Check host schemes are defined)
  • ⚠️ no-request-body (Check GET and DELETE methods do not accept request bodies)
  • ⚠️ no-http-verbs-in-path (Paths cannot contain HTTP verbs as segments)
  • ⚠️ component-description (Check component description)
  • ℹ️ path-item-refs (Check path items have not used references)
  • ℹ️ oas2-api-host (Check spec for 'host' value)
  • ℹ️ description-duplication (Check descriptions for duplicates)

Examples violations

⚠️️ Warnings: 1 ⚠️️ oas3-missing-example: 1
location JSONPath
316:9 $.components.schemas['Fries'].properties['seasoning']
Category Errors Warnings Info
Examples 0 1 0

@github-actions
Copy link

github-actions bot commented Jun 6, 2025

vacuum OpenAPI quality report

vacuum has graded this OpenAPI specification with a score of 98 out of a possible 100

⚠️3 warnings detected

vacuum detected warnings in your OpenAPI specification, please review and address accordingly.

vacuum ran against the following 48 rules:
  • 🔴 path-params (Check path validity and definition)
  • 🔴 path-not-include-query (Check path excludes query string)
  • 🔴 path-declarations-must-exist (Check path parameter declarations)
  • 🔴 operation-parameters (Check operation parameters)
  • 🔴 operation-operationId-valid-in-url (Check operationId is URL friendly)
  • 🔴 operation-operationId-unique (Check operations for unique operationId)
  • 🔴 operation-operationId (Check operations for an operationId)
  • 🔴 oas3-schema (Check spec is valid OpenAPI 3)
  • 🔴 oas3-operation-security-defined (Check operation security)
  • 🔴 oas3-no-$ref-siblings (Check for siblings to $ref values)
  • 🔴 oas2-schema (Check schema is valid OpenAPI 2)
  • 🔴 oas2-operation-security-defined (Check operation security)
  • 🔴 oas2-oneOf (Check for invalid use of 'oneOf')
  • 🔴 oas2-discriminator (Discriminator check)
  • 🔴 oas2-anyOf (Check for invalid use of 'anyOf')
  • 🔴 oas-schema-check (schemas must have a valid type defined)
  • 🔴 no-script-tags-in-markdown (Check descriptions for '<script>' tags)
  • 🔴 no-eval-in-markdown (Check descriptions for 'eval()' statements)
  • 🔴 no-ambiguous-paths (No ambiguous paths, each path must resolve unambiguously)
  • 🔴 no-$ref-siblings (Check for siblings to $ref values)
  • 🔴 info-license-spdx (Check license object for URL or identifier, but not both)
  • 🔴 info-description (Check for a specification description)
  • 🔴 duplicated-entry-in-enum (Check for duplicate enum entries)
  • ⚠️ typed-enum (Check enum types)
  • ⚠️ paths-kebab-case (Path segments must be kebab-case only)
  • ⚠️ path-keys-no-trailing-slash (Check path for any trailing slashes)
  • ⚠️ operation-tags (Check operation tags are used)
  • ⚠️ operation-tag-defined (Check operation tags exist globally)
  • ⚠️ operation-success-response (Check operations for success response)
  • ⚠️ operation-description (Check operation description)
  • ⚠️ oas3-valid-schema-example (Check all example schemas are valid)
  • ⚠️ oas3-unused-component (Check for unused components)
  • ⚠️ oas3-parameter-description (Check parameter description)
  • ⚠️ oas3-missing-example (Check schemas, headers, parameters and media types all have examples present.)
  • ⚠️ oas3-example-external-check (Check schemas, headers, parameters and media types use either 'example' or 'externalValue' but not both.)
  • ⚠️ oas3-api-servers (Validate API server definitions)
  • ⚠️ oas2-unused-definition (Check for unused definitions)
  • ⚠️ oas2-parameter-description (Check parameter description)
  • ⚠️ oas2-operation-formData-consume-check (Check operation parameter 'formData' definition)
  • ⚠️ oas2-host-trailing-slash (Check host for trailing slash)
  • ⚠️ oas2-host-not-example (Check server URLs for example.com)
  • ⚠️ oas2-api-schemes (Check host schemes are defined)
  • ⚠️ no-request-body (Check GET and DELETE methods do not accept request bodies)
  • ⚠️ no-http-verbs-in-path (Paths cannot contain HTTP verbs as segments)
  • ⚠️ component-description (Check component description)
  • ℹ️ path-item-refs (Check path items have not used references)
  • ℹ️ oas2-api-host (Check spec for 'host' value)
  • ℹ️ description-duplication (Check descriptions for duplicates)

Examples violations

⚠️️ Warnings: 3 ⚠️️ oas3-missing-example: 3
location JSONPath
280:5 $.components.schemas['Error']
307:9 $.paths['/burgers'].post.responses['200'].content['application/json'].schema.properties['fries']
316:9 $.components.schemas['Fries'].properties['seasoning']
Category Errors Warnings Info
Examples 0 3 0

@daveshanley daveshanley merged commit 6af968d into main Jun 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@daveshanley