-
Notifications
You must be signed in to change notification settings - Fork 9k
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
refactor: introduce function for getting Schema Object type #10330
base: master
Are you sure you want to change the base?
Conversation
|
||
export const getSchemaObjectTypeLabel = (label) => label | ||
|
||
export const getSchemaObjectType = (schema) => schema.type ?? "any" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be consistent with JSON Schema 2020-12 processing, can we make the fallback type the string
type?
export const getSchemaObjectType = (schema) => schema.type ?? "any" | |
export const getSchemaObjectType = (schema) => schema.type ?? "string" |
Also, may I suggest to make this function safe:
export const getSchemaObjectType = (schema) => schema.type ?? "any" | |
export const getSchemaObjectType = (schema) => schema?.type ?? "string" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Preferred alternative: What if both the functions would have the following signature?
getSchemaObjectType: (schema: object) -> string
getSchemaObjectTypeLabel: (schema: object) -> string
This would simplify their usage inside the code as it is now abstracted how the the type or label are computed from the schema.
Instead of
const typeLabel = fn.getSchemaObjectTypeLabel(immutableToJS(schema?.get("type")))
you'll end up having
const typeLabel = fn.getSchemaObjectTypeLabel(immutableToJS(schema))
If you further abstract and allow the functions to consume immutable along with POJO, it can look like:
const typeLabel = fn.getSchemaObjectTypeLabel(schema)
NOTE: this applies both for Draft 5 and 2020-12 functions.
@@ -635,3 +635,7 @@ const resolver = (arg1, arg2, arg3) => [arg1, JSON.stringify(arg2), JSON.stringi | |||
export const memoizedCreateXMLExample = memoizeN(createXMLExample, resolver) | |||
|
|||
export const memoizedSampleFromSchema = memoizeN(sampleFromSchema, resolver) | |||
|
|||
export const getSchemaObjectTypeLabel = (label) => label |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The input is type
not a label
.
export const getSchemaObjectTypeLabel = (label) => label | |
export const getSchemaObjectTypeLabel = (type) => type |
But anyway we can make this point-free by:
import identity from "lodash/identity"
export const getSchemaObjectTypeLabel = identity
const typeLabel = fn.jsonSchema202012.getType(immutableToJS(schema)) | ||
const type = fn.jsonSchema202012.foldType(immutableToJS(schema?.get("type"))) | ||
const itemType = fn.jsonSchema202012.foldType(immutableToJS(schema?.getIn(["items", "type"]))) | ||
const typeLabel = fn.getSchemaObjectType(immutableToJS(schema)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks a bit confusing. For getting a typeLabel
we're using getSchemaObjectType
. For actual type
we're using getSchemaObjectTypeLabel
. Shouldn't it be reversed?
use function for getting
schema object type
/schema object type
label depending on the OpenAPI versionAttribution: @robert-hebel-sb