Comments (6)
I do not believe this is a helpful example. I do not believe we have ever talked about how a JSON model should be serialized in text/plain payloads. We should make it a more useful example.
from openapi-specification.
@OAI/tsc review request: see above
from openapi-specification.
I expect some git spelunking (in an old swagger repo, perhaps)? might be needed to derive the original intent here. I agree it makes no sense at all - text/plain's serializer/deserializer is the identity function (and indeed my implementation has this hardcoded for 'text/*')!
from openapi-specification.
I agree that this is not a helpful example and we should make it more useful.
But I think there is a larger question here which is: how to interpret -- or whether to ignore -- schema
for various media types. Does it make any sense for text/plain
content to have any schema other than type: string
? Likewise, for image/<anything>
does it make any sense to have any schema other than type: string, format: binary
?
In other words, I think that certain content types imply the schema -- maybe even impose a schema. I realize this is a much larger topic than just fixing an example, but shouldn't we address this somehow?
from openapi-specification.
@mikekistler I have had similar thoughts that there's a general topic here. I wasn't going to bring it up yet, but since you did (and I'm glad to hear someone else have this sort of thought), I have started a discussion on a registry for data modeling:
Let's have the larger discussion there (including the idea of certain types implying or imposing a schema, which is an interesting frame that had not occurred to me) and focus on just this example (which it sounds like there is consensus to remove) here.
from openapi-specification.
I think the assessment is clear enough for me to remove the review
label – I'll address this with several other media type encoding issues I'm working on.
from openapi-specification.
Related Issues (20)
- Open Community (TDC) Meeting, Thursday 16 May 2024 HOT 2
- RFC 7231 has been obsoleted by RFC 9110 HOT 10
- Define a policy using draft PRs when waiting on specific approvals HOT 3
- Open Community (TDC) Meeting, Thursday 23 May 2024 HOT 5
- Open Community (TDC) Meeting, Thursday 30 May 2024 HOT 2
- We should not keep a minified version of respec.js HOT 1
- Document milestone usage in DEVELOPMENT.md
- Define and add new process labels and document general label usage in DEVELOPMENT.md
- Should `style: form` examples include `?` prefix? If so, what about `spaceDelimited`, `pipeDelimited`, and `deepObject`? HOT 3
- Simplify HTML rendering build process HOT 1
- Consolidated $ref-to-Some Object feature request
- Move examples to learn.openapis.org or spec.openapis.org HOT 5
- Preserve section links in ReSpec output HOT 1
- Open Community (TDC) Meeting, Thursday 06 June 2024 HOT 1
- Add dark mode support to the HTML versions of the OpenAPI specs HOT 2
- Clarify the meaning of info.version HOT 13
- Clarify default dialect for referenced JSON Schema documents
- Mention registry in the section defining extensions HOT 3
- Inconsistent or unclear string format : byte or base64 HOT 1
- Open Community (TDC) Meeting, Thursday 13 June 2024 HOT 1
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.