Comments (1)
I've pushed all the examples I generated to a branch in my fork for reference at https://github.com/veronicagg/azure-rest-api-specs/tree/examples-from-recordings
There should be a folder in the api-version folder called swagger-with-examples, which includes examples and the edited swagger file (if there were recordings available for that service). It's not the idea to merge this code up (at least not now), but to have our generated examples (from .net recordings) available, so I just pushed them to that folder under each spec.
I've run lots of the examples through the validation tool, I've opened issues for many specs. As I extracted some patterns from the issues like "required properties are not coming back in responses" or "properties come back as null which doesn't match the spec'd type", instead of opening issues for all those, I'm writing up some proposals first on how we could resolve those, so we can publish them for service teams.
One of the proposals is already at Azure/azure-rest-api-specs#790
Additionally, we need to think of ways to consolidate the errors in an output that's more readable and less repeated errors, to make it less noisy and more actionable.
from oav.
Related Issues (20)
- Special logic for x-ms-mutability and possibly other cases doesn't work when a sibling of $ref
- `oav generate-examples generated.json` fails to parse x-ms-paths HOT 1
- [HTML Report] Details of Failed Operations cannot be displayed in Windows.
- [HTML Report] Links of schemaPath and payloadFilePath do not point to the correct file location
- Re-enable AdditionalProperties validation in RPaaS HOT 1
- arm-id marked as unknown format and not validated HOT 6
- `oav generate-examples` on typespec with `byte` generates invalid examples
- generate-examples fails to generate correct example at json depth 6 HOT 2
- [INVALID_DISCRIMINATOR_TYPE] False positive if discriminator is optional $ref HOT 1
- `oav` not properly honoring `collectionFormat` when comparing types HOT 2
- `response_schema_not_in_spec` erroneously thrown while resolving `$ref` for an example response body HOT 1
- Replace dependency on `mock.js`
- NO OAV binary found in Windows
- 'POST' list calls incorrectly flagged with 'MISSING_RESOURCE_ID' and 'OBJECT_MISSING_REQUIRED_PROPERTY'
- Fix `unacceptable kind of object to dump` error
- Example type verification for sub-object errors with `INVALID_TYPE`
- [LiveValidate RPaaS] Newest image version crashes validation of `networkFunctions` service request HOT 6
- Ship `oav` with `sourcemaps` to enable debugging from dependent projects HOT 1
- oav example-validator incorrectly flags "writeOnly" property missing from response body HOT 1
- Fix validation for readOnly $ref properties HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from oav.