Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editor: Data types misses type: object #487

Closed
slinkydeveloper opened this issue Nov 2, 2018 · 10 comments
Closed

Editor: Data types misses type: object #487

slinkydeveloper opened this issue Nov 2, 2018 · 10 comments

Comments

@slinkydeveloper
Copy link

When I create a new data type (schemas under components), It doesn't add type:object to schema definition

@EricWittmann EricWittmann changed the title Data types misses type: object Editor: Data types misses type: object Nov 2, 2018
@EricWittmann
Copy link
Member

FYI - I've fixed this in the oai-ts-commands library so the next time a release of that is done this will be addressed.

@EricWittmann
Copy link
Member

This has been fixed and committed - should be all set for the next release.

@EricWittmann
Copy link
Member

Thanks for the error report!

@wiktor-obrebski
Copy link

wiktor-obrebski commented Feb 12, 2019

@EricWittmann I see the issue is still here, at least something very similar, for the responses. Shouldn't I be able to choose "object" data type here?

test

@EricWittmann
Copy link
Member

At the moment, apicurio doesn't support inline object definitions. So you would need to create a global data type and then refer to it in the application/json media type in your screenshot. I'd like to support editing an object type inline within the response, but it's not yet done.

@enugentdt
Copy link

Any update on this issue? It's the last thing I need before I rewrite all my documentation using this tool :)

@EricWittmann
Copy link
Member

Which aspect of this issue do you need? Are you referring to inline object definitions? If so, why are reusable definitions not an acceptable alternative? I'd love to know the use-case so that can influence the priority of the feature.

@wiktor-obrebski
Copy link

wiktor-obrebski commented Apr 24, 2019

@EricWittmann

we already have documentation wrote in OpenAPI manually or by other tools that we would like to reuse. inline object definition is common feature, at least I feel like this and it's needed for other tools compatibility.

second problem is that following your advice we fastly have a lot of object definitions that are in real only one-time used definitions. it's make definitions list too long and distracts attention from really useful, commonly used structures in our apis. e.g. instead of have
only User and ShopItem common defs, we ending with many less important types: ResponseXType, ResponseYType, ResponseZType` etc.

@EricWittmann
Copy link
Member

OK thanks for the feedback, @psychowico - I'm going to open a new feature request to add better support for inline schemas. I think your reasons for wanting that feature are good. :)

@ThorstenBux
Copy link

ThorstenBux commented Jun 25, 2019

Just referencing your new feature request in case someone is looking for it: #744

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants