Skip to content
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

Add flow collections to the API #35

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Add flow collections to the API #35

merged 1 commit into from
Mar 27, 2024

Conversation

robwadge
Copy link
Contributor

@robwadge robwadge commented Mar 22, 2024

Details

ADR and associated implementation proposing addition of Flow collections to the API, to support multi-essence Flows

Pivotal Story (if relevant)

Story URL: https://www.pivotaltracker.com/story/show/187060669

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

@robwadge robwadge force-pushed the rw-flow-collections branch 3 times, most recently from 92c4fcf to 71809a1 Compare March 22, 2024 18:53
@robwadge robwadge marked this pull request as ready for review March 25, 2024 11:50
@robwadge robwadge requested a review from a team as a code owner March 25, 2024 11:50
Copy link
Member

@samdbmg samdbmg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall - I've inlined a few nits and a question about creating new Sources

docs/adr/decisions/0012-add-flow-collections.md Outdated Show resolved Hide resolved
docs/adr/decisions/0012-add-flow-collections.md Outdated Show resolved Hide resolved
api/schemas/collection-item.json Outdated Show resolved Hide resolved
api/schemas/flow-multi.json Outdated Show resolved Hide resolved
api/schemas/source.json Show resolved Hide resolved
docs/adr/decisions/0012-add-flow-collections.md Outdated Show resolved Hide resolved
api/schemas/source.json Show resolved Hide resolved
Copy link
Contributor

@philipnbbc philipnbbc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of my comments inline

api/examples/flow-get-200-multi.json Outdated Show resolved Hide resolved
api/examples/flow-get-200-multi.json Outdated Show resolved Hide resolved
api/examples/flow-get-200-multi.json Outdated Show resolved Hide resolved
api/schemas/collection-item.json Outdated Show resolved Hide resolved
api/schemas/source.json Show resolved Hide resolved
Copy link
Contributor

@philipnbbc philipnbbc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. As discussed, there are some complications around grouping conflicts and what to do if Flows get deleted (Source inference conflicts, missing slots, etc.), but that's something we can figure that out as we implement these changes.

I was surprised the the JSON schema validator was ok with the codec and container properties being on flow-core and only required in flow-video etc., but it turns out that is valid according to a JSON schema editor.

Add implementation of flow and source collections
Update readme.md
@robwadge robwadge merged commit 16ea401 into main Mar 27, 2024
3 checks passed
@robwadge robwadge deleted the rw-flow-collections branch March 27, 2024 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants