Describe naming convention for role in collections#173
Open
Conversation
Adds an AppNote describing the role naming convention and editorial purposes.
j616
reviewed
Feb 10, 2026
| * Good, because it captures suggested names without constraining the purposes that a Flow or Source can be used for | ||
| * Good, because inspiration can be drawn from the other documents suggested, without being constrained by tem | ||
| * Good, because it is easy to add new items to the list | ||
| * Bad, because the list is open-ended and uncontrolled, which may lead to content using a mix of names |
Contributor
There was a problem hiding this comment.
Suggested change
| * Bad, because the list is open-ended and uncontrolled, which may lead to content using a mix of names | |
| * Bad, because the list is open-ended and uncontrolled, which may lead to content using a mix of names | |
| * Bad, because metadata that exists elsewhere in the API may be duplicated in this list | |
| * Bad, because such duplicated metadata may conflict |
Member
Author
There was a problem hiding this comment.
Having switched away from using semi-structured identifiers, I'm not sure these make as much sense now? Because the list is just editorial purpose now and we can't fully capture that as an item property?
Member
Author
|
After a chat with @j616 I've fairly extensively reworked this, to move away from the semi-structured format originally proposed to using Note that in the process I've tweaked how the ADR options are numbered to make clearer that they are two separate decisions, which are related, but the options aren't interchangeable between them |
samdbmg
force-pushed
the
sammg/docs/better-role-values
branch
from
55fb9c7 to
ae272ce
Compare
Splits the set of options for how to represent editorial purpose to a different numbering scheme, to make clear they are related but not interchangeable because they refer to different decisions.
Restructures the options to use a different numbering scheme, and group related options together. Adds additional options around querying Flow/Source properties directly
Expands and reworks role name decision outcome following discussion
samdbmg
force-pushed
the
sammg/docs/better-role-values
branch
from
ae272ce to
41a6a91
Compare
Reworks the role naming convention appnote to remove semi-structured format, instead just describing editorial purpose, in line with AppNote 0047.
Updates some of the examples to use the role names based on the appnote convention
samdbmg
force-pushed
the
sammg/docs/better-role-values
branch
from
41a6a91 to
6937daa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Details
rolefield in collections of Flows and SourcesThis is a first pass off the back of a discussion about handling broadcast channel ingests: I'd definitely appreciate a wider perspective!
Jira Issue (if relevant)
Jira URL: https://jira.dev.bbc.co.uk/browse/CLOUDFIT-5509
Related PRs
N/A
Submitter PR Checks
(tick as appropriate)
Reviewer PR Checks
(tick as appropriate)
Info on PRs
The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.