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

More detail response properties #878

Open
1 task done
jamesRUS52 opened this issue Aug 7, 2024 · 2 comments
Open
1 task done

More detail response properties #878

jamesRUS52 opened this issue Aug 7, 2024 · 2 comments

Comments

@jamesRUS52
Copy link

Scribe version

4.37.1

Your question

I use ResponseFromApiResource attribute to get sample response.
I saw that response/properties section in open api spec contains only type and example
Is it possible to get more detail, e.g.
nullable: true
format: "date"
and so on
?
I use Osteel validation package to compare swagger docs and real api response
and it fail because generated openapi spec not contain detailed data about data types

Docs

@daniel100097
Copy link

I have the same issue

@shalvah
Copy link
Contributor

shalvah commented Nov 5, 2024

Hmmm...

  • in October, I released a new version with this PR, which adds support for nullable, so you should update to 4.38.0 and check the Changelog for how to use it.
  • As for format: date, it's a bit tricky because I don't want to tie Scribe directly to OpenAPI. But I'll think about it, and I'm open to any suggestions.

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

3 participants