knuckleswtf / knuckleswtf/scribe

More detail response properties

Open
#878 2 comments 1 reaction 0 assignees View on GitHub
feature-request question
Dominant language
PHP
Stars
2.3k
Forks
357
PR merge metrics
No merged PRs in 30d

Description

### 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

- [X] I've checked [the docs](https://scribe.knuckles.wtf/laravel), the [troubleshooting guide](https://scribe.knuckles.wtf/laravel/troubleshooting), and [existing issues](https://github.com/knuckleswtf/scribe/issues?q=is%3Aissue+), but I didn't find a solution

Contributor guide

Open the contributing guide

Research direction

Start at the ResponseFromApiResource attribute and inspect the generated OpenAPI response/properties section, comparing its current output with the requested nullable and format details. Review the linked Laravel documentation and troubleshooting guide, then verify that the generated schema contains the needed data-type metadata for Osteel validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
laravel, openapi, php
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.