Change openapi.json to be formatted and corrected openapi

[ctII]

This change runs jq to format the openapi.json to remove extra white spacing and generally format the original spec to consistent formatting

Then moves the InternalServerError to the components/responses section that is referenced in the already written api endpoints, instead of schemas/responses

Then fixes the reference to SuggestionComment

This resolves all errors that https://editor.swagger.io/ shows when using the openapi.json

swagger editor errors:

Semantic error at paths./cwe/version.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/{id(s)}.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/weakness/{id(s)}.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/category/{id(s)}.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/view/{id(s)}.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/{id}/parents.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/{id}/descendants.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/{id}/children.get.responses.500.$ref
$refs must reference a valid location in the document

Semantic error at paths./cwe/{id}/ancestors.get.responses.500.$ref
$refs must reference a valid location in the document

Structural error at components.schemas.MappingNotes.properties.Suggestions
should NOT have additional properties
additionalProperty: #ref

Semantic error at components.schemas.MappingNotes.properties.Suggestions
Schemas with 'type: array', require a sibling 'items: ' field

Structural error at components.schemas.responses
should NOT have additional properties
additionalProperty: InternalServerError

actual difference excluding the general formatting changes

cat openapi-original.json | jq > openapi-original-formatted.json
diff openapi-original-formatted.json {json file of this change}

out of diff

1273c1273,1275
<             "#ref": "#/components/schema/SuggestionComment"
---
>             "items": {
>               "$ref": "#/components/schemas/SuggestionComment"
>             }
1595,1599c1597,1601
<       },
<       "responses": {
<         "InternalServerError": {
<           "description": "An Internal Server Error occurred"
<         }
---
>       }
>     },
>     "responses": {
>       "InternalServerError": {
>         "description": "An Internal Server Error occurred"

[rpiazza]

@ctII - Thanks - is made those changes myself, so I'm closing this MR. You should be able to pull and get exactly what you proposed.

[ctII]

@ctII - Thanks - is made those changes myself, so I'm closing this MR. You should be able to pull and get exactly what you proposed.

This is not completely correct, since this PR also included formatting the JSON using jq to fix formatting inconsistencies in the spec file

For example line 173, while correct JSON, is not consistent formatting. This doesn't break any parsers, but makes it more difficult to read manually. Not to mention the formatted JSON spec file is actually smaller than the unformatted version

REST-API-wg/openapi.json

Line 173 in d1b4cf4

"$ref": "#/components/schemas/Category" }

[rpiazza]

I'll look into it

[ctII]

PR #3 has been opened that is solely the formatting aspect of this PR