-
Notifications
You must be signed in to change notification settings - Fork 4.9k
fix stream name in stream transformation update #14044
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4082,16 +4082,15 @@ components: | |
| type: object | ||
| required: | ||
| - transformType | ||
| - streamDescriptor | ||
| properties: | ||
| transformType: | ||
| type: string | ||
| enum: | ||
| - add_stream | ||
| - remove_stream | ||
| - update_stream | ||
| addStream: | ||
| $ref: "#/components/schemas/StreamDescriptor" | ||
| removeStream: | ||
| streamDescriptor: | ||
| $ref: "#/components/schemas/StreamDescriptor" | ||
| updateStream: | ||
| type: array | ||
|
|
@@ -4103,46 +4102,47 @@ components: | |
| description: "Describes the difference between two Streams." | ||
| required: | ||
| - transformType | ||
| - fieldName | ||
| properties: | ||
| transformType: | ||
| type: string | ||
| enum: | ||
| - add_field | ||
| - remove_field | ||
| - update_field_schema | ||
| fieldName: | ||
| $ref: "#/components/schemas/FieldName" | ||
| addField: | ||
| $ref: "#/components/schemas/FieldNameAndSchema" | ||
| $ref: "#/components/schemas/FieldAdd" | ||
| removeField: | ||
| $ref: "#/components/schemas/FieldNameAndSchema" | ||
| $ref: "#/components/schemas/FieldRemove" | ||
| updateFieldSchema: | ||
| $ref: "#/components/schemas/FieldSchemaUpdate" | ||
| FieldNameAndSchema: | ||
| FieldAdd: | ||
| type: object | ||
| required: | ||
| - fieldName | ||
| - fieldSchema | ||
| properties: | ||
| fieldName: | ||
| type: array | ||
| items: | ||
| type: string | ||
| fieldSchema: | ||
| schema: | ||
| $ref: "#/components/schemas/FieldSchema" | ||
| FieldRemove: | ||
| type: object | ||
| properties: | ||
| schema: | ||
| $ref: "#/components/schemas/FieldSchema" | ||
| FieldSchemaUpdate: | ||
| type: object | ||
| required: | ||
| - fieldName | ||
| - oldSchema | ||
| - newSchema | ||
| properties: | ||
| fieldName: | ||
| type: array | ||
| items: | ||
| type: string | ||
| oldSchema: | ||
| $ref: "#/components/schemas/FieldSchema" | ||
| newSchema: | ||
| $ref: "#/components/schemas/FieldSchema" | ||
| FieldName: | ||
| description: A field name is a list of strings that for the path to the field. | ||
|
||
| type: array | ||
| items: | ||
| type: string | ||
| FieldSchema: | ||
| description: JSONSchema representation of the field | ||
| type: object | ||
|
|
||
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.
why separate schemas for FieldAdd and FieldRemove? is there a benefit to this?
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.
@alovew I could be convinced this was the wrong thing. What I want to make clear in the API is the pattern that each transformation type gets its own, separately named object. For add / remove it is slightly redundant. But when we add something like "add is hash-able" or something that it is clear that should go in its own field with its own object.
Basically was trying to make the pattern clear and thought the redundancy of one object was worth it. wdyt?
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.
Ah I see, yes this makes sense to me. I'm good with this 👍