JimHume
commented
1 year ago TL;DR: another URL that reproduces the issue can be found at https://docs.oracle.com/en/industries/food-beverage/simphony/omsstsg2api/swagger.json
More detail:
Using the swagger doc mentioned in the original post one can narrow down the issue to (at least) this path:
"/api_v2/hmi": {
"post": {
"description": "send hmi message",
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": ["assetId", "message", "deliveryType"],
"properties": {
"assetId": {
"description": "Asset receiver (id)",
"type": "integer"
},
"message": {
"description": "Message to send",
"type": "string"
},
"deliveryType": {
"description": "Force delivery type: '1' (over http) or '2' (send with SMS)",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/schemas/InsertEntityResult"
}
}
}
},That path links to this response:
"InsertEntityResult": {
"title": "Insert Entity Result Model",
"description": "Generic response of insert item",
"properties": {
"success": {
"description": "Operation status",
"type": "boolean",
"format": "bool"
},
"message": {
"description": "Generic message",
"type": "string",
"format": "string"
},
"item": {
"description": "Item definition",
"type": "object",
"format": "object"
},
"id": {
"description": "Item id definition",
"type": "object",
"format": "integer"
}
},
"type": "object"
}I am encountering the same issue with a different swagger doc: https://docs.oracle.com/en/industries/food-beverage/simphony/omsstsg2api/swagger.json
This path in particular can reproduce the issue:
"{basePath}/notifications/subscriptions": {
"post": {
"tags": [
"Notifications API"
],
"summary": "Post create a subscription",
"description": "The API creates a subscription to a resource for the current subscriber.\n",
"operationId": "CreateSubscription",
"parameters": [{
"$ref": "#/parameters/body.SubscriptionViewModel"
}
],
"responses": {
"200": {
"description": "The subscription",
"schema": {
"$ref": "#/definitions/Subscription"
}
},
"400": {
"description": "400 Bad Request\nNote - A subscription for message type ID 'EmployeesNotification' will return 400 if RvcRef has a value. Such a subscription would never receive any notifications.\n",
"schema": {
"$ref": "#/responses/NotificationsApiBadRequest"
}
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
}
},
"x-internal-id": "basePath}-notifications-subscriptions-post",
"x-filename-id": "basepath-notifications-subscriptions-post"
}
}More specifically: if you remove the "400" response type then it will work just fine. This is the section in question that acts as the starting point:
"400": {
"description": "400 Bad Request\nNote - A subscription for message type ID 'EmployeesNotification' will return 400 if RvcRef has a value. Such a subscription would never receive any notifications.\n",
"schema": {
"$ref": "#/responses/NotificationsApiBadRequest"
}
}This "400" links to the "NotificationsApiBadRequest" response:
"responses": {
"NotificationsApiBadRequest": {
"description": "400 Bad Request",
"schema": {
"$ref": "#/definitions/NotificationsApiProblemDetails"
}
}
}The "NotificationsApiBadRequest" is a reference to the "NotificationsApiProblemDetails" definition:
"NotificationsApiProblemDetails": {
"description": "Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).\n\nThe content type for this response is `application/problem+json`\n",
"type": "object",
"example": {
"type": "error:validation",
"title": "Required value not specified.",
"details": "The OrgShortName value is required.",
"instance": "required_value_missing"
},
"properties": {
"type": {
"description": "A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
"type": "string",
"example": "error:validation"
},
"title": {
"description": "A short, human-readable summary of the problem type.",
"type": "string",
"example": "Required value not specified."
},
"details": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"type": "string",
"example": "The OrgShortName value is required."
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
"type": "string",
"example": "required_value_missing"
}
}
}There is seemingly no obvious link between the originally-reported issue and the issue I am facing. The schema doesn't overlap all that much and no amount of removing or changing the response or definitions seems to get past the issue.
This appears related to the following issues in one way or another, all of which remain in the "open" state: https://github.com/RicoSuter/NSwag/issues/2921 https://github.com/RicoSuter/NSwag/issues/3031 https://github.com/RicoSuter/NSwag/issues/3513 https://github.com/RicoSuter/NSwag/issues/3930 https://github.com/RicoSuter/NSwag/issues/2899
To summarize my issue: "path -> response -> definition" seemingly fails for at least one path but it's not clear what the issue is.
Hello,
I'm trying to use NSwagStudio with https://[cgm.kiwisat.it/doc/merged-swagger-base.json](https://cgm.kiwisat.it/doc/merged-swagger-base.json) I get the below error: System.InvalidCastException: Unable to cast object of type 'NJsonSchema.JsonSchema' to type 'NSwag.OpenApiResponse'.
I don't know why I got this error. Can anyone help me?