Comments (8)
I've added comments/suggestions to all 3 PRs following the discussion at the meeting today.
from openapi-specification.
Please refer to the 3.1.1 specification in the v3.1.1-dev branch, as there have already been some corrections to this area of the specification.
It does appear that the table is incorrect for simple
, at least -- primitive and object types are supported there, and it probably makes sense to allow primitives for spaceDelimited and pipeDelimited.
from openapi-specification.
Why does it make sense to allow primitives for spaceDelimited and pipeDelimited? The description for these two styles is specific to arrays.
spaceDelimited: Space separated array values.
pipeDelimited: Pipe separated array values.
from openapi-specification.
I'm coming at it from the perspective of a request/response validation author, where we're taking data in a request or response and deserializing it into a data structure. From this angle, allowing more types means fewer places where the validation would error out because of the wrong type being specified in the schema, but indeed it doesn't add any value to allow it (the application might as well accept an array with a single value).
from openapi-specification.
Update: we discussed this PR at the TSC meeting today (#3672) and decided:
- the changes for
simple
are sensible - all of primitives, arrays and objects are possible and make sense, so the spec should reflect that - regarding
spaceDelimited
andpipeDelimited
, a primitive type is not useful here (when writing an api spec, if you're expecting a string why would you specifystyle: spaceDelimited
? just usesimple
form
).
Therefore -- @charjr: could you possibly revert the changes to spaceDelimited and pipeDelimited in your PRs? I think then we should be able to review and merge them quickly (e.g. before or by the next TSC meeting). thanks!
from openapi-specification.
@karenetheridge I've updated each PR to remove the primitive
type from spaceDelimited
and pipeDelimited
.
Hopefully it's ready to go, if not let me know.
from openapi-specification.
looks great, thank you!
from openapi-specification.
@karenetheridge updated, let me know if it needs any further changes.
from openapi-specification.
Related Issues (20)
- Open Community (TDC) Meeting, Thursday 11 April 2024 HOT 7
- Reference schema property within a response HOT 2
- Open Community (TDC) Meeting, Thursday 18 April 2024 HOT 5
- Format Registry documentation is not accurate / well published HOT 2
- Schema issues in documentation examples HOT 4
- Add tokenExchange grant type to list of allowed grant types for oauth2 shape
- Open Community (TDC) Meeting, Thursday 25 April 2024 HOT 7
- Define and document our schema publishing process HOT 1
- Schema development: main or branch, in parallel or at release time?
- Should we-organize our GitHub pages to a directory on main?
- Why does the JSON schema for 3.0 specify patternProperties for component names but allows additional properties?
- Support for `multipart/mixed` (and possibly better `multipart/*` support in general) HOT 5
- `description`/`summary` for Paths Object
- Support `multipart/byteranges` for 206 responses
- Support application/json-seq and similar JSON-based sequential formats HOT 1
- Did we break 3.2 compatibility by removing the Path Item $ref special case? HOT 12
- pipeDelimited and spaceDelimited style examples can be unresolvable HOT 10
- Encoding Object `contentType` field: "comma-separated list of the two types"? HOT 8
- Add appendix "Informative references" to published spec documents HOT 4
- Open Community (TDC) Meeting, Thursday 02 May 2024 HOT 3
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 openapi-specification.