Azure / azure-api-style-guide

Spectral rules to check conformance to Azure API Guidelines
MIT License
45 stars 21 forks source link

Add a rule to check that the schemas for all 2XX responses are the same #110

Open mikekistler opened 1 year ago

mikekistler commented 1 year ago

For client generation, we want to have only one type of object returned from an operation. In terms of the REST API, that means that all the success response codes (2XX) should have the same schema.

Comparing schemas for equality might be a little tricky, so we could simplify the logic somewhat:

Maybe we'll start with that.