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.

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

see #104 Fixed all issues in Swagger Editor and issue 104. #106

Conversation

DonaldBradleyDev
Copy link
Contributor

Swagger Editor Issues:

  1. When I opened the file in Swagger Editor, I noticed three errors in the inspector.
    • The first error was resolved by changing the openapi version from 3.1.0 to 3.0.0 or 3.1.1. If you want to keep version 3.1.0, it needs to be updated to 3.1.1. According to the official OpenAPI documentation, there's no difference between the two versions.
    • The second error was a semantic issue: GET operations cannot have a requestBody. I fixed this by removing the requestBody in line 1688.
    • The third issue was a structural error: additionalProperty: ref$. I corrected this by changing ref$ to $ref in line 14355.

Issue 104:
In OpenAPI, external URLs should be approved for reference. To meet this requirement, I added https://raw.githubusercontent.com to the servers section of the specification at line 25.

Fixed all issues in Swagger Editor and issue 104.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@pkothare
Copy link
Member

pkothare commented Sep 3, 2024

The first error was resolved by changing the openapi version from 3.1.0 to 3.0.0 or 3.1.1. If you want to keep version 3.1.0, it needs to be updated to 3.1.1. According to the official OpenAPI documentation, there's no difference between the two versions.

Can you please provide a link to where the 3.1.1 spec is defined? The latest version I see available is https://spec.openapis.org/oas/latest.html, which is currently 3.1.0 as of writing.

Copy link
Contributor

@brian-comply0 brian-comply0 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@brian-comply0
Copy link
Contributor

@DonaldBradleyDev thank you for this!

As it happens, I was working on some of the same, plus a few other cleanup items in the identifiers branch

Please note, that reference didn't belong in the OSCALModelSnapshotEntry at all. So I had deleted it. In my branch.

I was not aware of the requirement to list the github server in the server list. Thank you for addressing!
Trying to get a second approval now to merge your changes. Then I'll merge my additional changes on top of yours.

@pjavan pjavan self-requested a review September 3, 2024 17:13
Copy link

@pjavan pjavan left a comment

Choose a reason for hiding this comment

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

lgtm

@brian-comply0 brian-comply0 merged commit 8a72be4 into EasyDynamics:develop Sep 3, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants