Comments (8)
🎉 This issue has been resolved in version 1.7.0 🎉
The release is available on:
Your semantic-release bot 📦🚀
from typeconv.
Great feedback, I'll look into configuring it by command line arguments. Defaulting to only top-level types probably makes sense.
from typeconv.
Not sure if this has been a bug, but in the latest version this does work, however these will be saved into title
rather than description
.
I made a unit test out of this and god the following result:
components:
schemas:
Point:
properties:
x:
title: The distance from the left in mm
type: number
'y':
title: The distance from the top in mm
type: number
required:
- x
- 'y'
additionalProperties: false
type: object
Let me know if this is an issue.
from typeconv.
Yeah, sorry, title is a different thing - it really should be description. Title if anything should be the type name of the top level item, like:
/** This is useful for such and such */
type Foo = { a: number }
Becomes
title: Foo
description: This is useful for such and such
type: object
properties:
a:
type: number
You can take a look at how stripe-node's TS types are printed from their openapi spec for a real world example
from typeconv.
OpenAPI forwards the title
field straight from JSON Schema, which is a bit unclear about this: http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.9.1 but the "A title will preferably be short" means you're probably right.
I'll try to fix this throughout the core-types packages (it affects quite a few packages), it does make sense, thanks for enlightening me!
from typeconv.
Awesome, thanks so much!
from typeconv.
Amazing!! That was quick.
FWIW I would actually recommend against adding title
s like Point.x
, which I see in the spec, but the addition of the title
for things like Point
is definitely awesome. I don't think it can really hurt per se to add Point.x
, so I don't think you should feel obligated to remove it (though now would be the easiest time, before anyone starts relying on it) but it definitely seems nonstandard/redundant to my OpenAPI eyes.
from typeconv.
Hi @grantila, did you ever configure the removal of the title
via command line arguments by any chance? I find it fairly redundant as well and would like to remove it but I don't seem to see an option to (or maybe I'm just not looking in the right spot).
from typeconv.
Related Issues (20)
- Parse inferred typescript types HOT 2
- [ts-to-oapi] Imported types are transformed HOT 3
- [jsc-to-ts] Discards descriptions on enums HOT 1
- Add option to read stdin
- OpenAPI -> TypeScript adds wildcard prop to each type HOT 2
- TypeScript to OpenApi HOT 1
- TypeScript nonExported to cli options HOT 2
- [gql] `input` type is not getting converted HOT 1
- [ts-to-oapi] Enums are not generated during conversion. HOT 3
- Is it possible to export all types into one file from different directories?
- Unable to convert `keyof typeof something` HOT 1
- Executing typeconv from nmp-scripts or within bash script does not work HOT 4
- TS -> OAPI single example HOT 1
- OpenAPI version 2 HOT 1
- JsonSchema => GraphQL: only "AllOf" schema is used HOT 2
- TS -> OAPI - ignores interfaces inheritance
- Convert interfaces/types that implements generic types HOT 2
- Nested interfaces ignored when declared in other files (Typescript -> OpenAPI) HOT 3
- Overlapping attributes in inherited types fails to convert HOT 2
- [jsc-to-ts] enum with null value throws
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 typeconv.