GithubHelp home page GithubHelp logo

Comments (2)

snebjorn avatar snebjorn commented on September 27, 2024 1

So that's a yes if I open a PR on swagger-ui and fix the anyOf UI 🎉 - challenge accepted 😄

Update:
Seems something is coming down the pipe: swagger-api/swagger-ui#3803

from odata-openapi.

ralfhandl avatar ralfhandl commented on September 27, 2024

@snebjorn you are essential correct.

However the purpose of OpenAPI descriptions for OData services is to give a gentle introduction into some of the most prominent features and an easy "Try it out" experience in Swagger UI. They in no way describe the full set of possible requests. For example direct access to properties such as Employees/1234567/lastName is allowed and supported by many OData service frameworks out-of-the-box, and is not mentioned in the OpenAPI descriptions because it would make them unreadably long and cluttered.

For me the benchmark is "does it look nice in Swagger UI", and with the above anyOf construct - while semantically correct - it does no longer look nice in Swagger UI, which then completely ignores the enum values.

So I accept the incompleteness of the current enum construct and prefer the clickable multi-select list demonstrating the most basic features of $select and $expand.

from odata-openapi.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.