Make the VASP url optional - #848
Conversation
The upstream directory returns an empty url for most entries, so it cannot be promised.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
|
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript
|
Greptile SummaryThe PR makes
Confidence Score: 4/5The response contract should be corrected before merging because the change still rejects the empty-string URL values it is intended to accommodate. Making Files Needing Attention: openapi/components/schemas/vasps/Vasp.yaml, openapi.yaml, mintlify/openapi.yaml
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/vasps/Vasp.yaml | Makes url optional, but retaining format: uri leaves the stated empty-string runtime values outside the response contract. |
| openapi.yaml | Correctly mirrors the source-schema edit while preserving the same empty-string validation mismatch. |
| mintlify/openapi.yaml | Keeps the Mintlify bundle synchronized, including the unresolved URI-format mismatch. |
Prompt To Fix All With AI
### Issue 1
openapi/components/schemas/vasps/Vasp.yaml:2-3
**Empty URLs Remain Invalid**
When the upstream directory returns `url: ""`, removing `url` from `required` does not make that present value optional or valid; it still violates `format: uri`, causing strict response validators and generated clients that enforce URI formatting to reject real directory entries.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "Make the VASP url optional" | Re-trigger Greptile
| required: | ||
| - vaspName |
There was a problem hiding this comment.
When the upstream directory returns url: "", removing url from required does not make that present value optional or valid; it still violates format: uri, causing strict response validators and generated clients that enforce URI formatting to reject real directory entries.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/vasps/Vasp.yaml
Line: 2-3
Comment:
**Empty URLs Remain Invalid**
When the upstream directory returns `url: ""`, removing `url` from `required` does not make that present value optional or valid; it still violates `format: uri`, causing strict response validators and generated clients that enforce URI formatting to reject real directory entries.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.There was a problem hiding this comment.
i just added this field its fine
There was a problem hiding this comment.
Fair enough — making url optional is the right call if the upstream returns empty strings on most entries. My concern about format: uri rejecting "" still technically stands (an empty string isn't a valid URI), but if your validators/generated clients are lenient about format enforcement on optional fields, or you handle empty strings at the application layer, that's your call to make.
Happy to drop this.
Summary
Follow-up to #827.
Vasp.urlwas marked required, but the upstream directory returns an empty string for it on most entries, so it can't be promised. Drops it fromrequiredand softens the description to "when known".Testing
make buildbundles cleanly;redocly lintandspectral lintmatch the pre-existing baseline onmainexactly (no new findings).🤖 Generated with Claude Code
Generated by Claude Code