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

id field should be renamed or have its keys moved to the body of the object #22

Closed
ruhnowg opened this issue Feb 12, 2019 · 3 comments
Closed
Labels
context-data FDC3 Context Data Working Group

Comments

@ruhnowg
Copy link

ruhnowg commented Feb 12, 2019

Currently all of the objects that have ids are represented something like this:

{
  id: {
    [key: string]: string
  }
}

This may represent a challenge when trying to integrate these objects into existing infrastructure as id is a very common field and almost always represents a string value. From the perspective of this effort the field that the ids live under has no impact on the spec itself, but there likely would be a cost to consumers of the spec attempting to integrate it into existing workflows as id is an incredibly common field and likely already exists in those workflows as something else.

I propose that either:

  1. id is renamed to another field, maybe 'ids'
    • This would be more semantically correct as it implies multiple ids rather than a single id
  2. the keys and values from id could be moved onto the base object
    • I frequently work with financial objects as a part of my role at FactSet and have generally found that nesting identifiers under another value only serves to make the object more difficult to work with. The spec already specifies what ids should be specified by a given type, so there should be no confusion about which fields are identifiers.
@rikoe rikoe transferred this issue from FDC3/ContextData Feb 28, 2019
@rikoe rikoe added the context-data FDC3 Context Data Working Group label Feb 28, 2019
@RichLinnell
Copy link
Contributor

Personally I favour option 2. I don't think putting the Ids into a separate object gives us anything.

@rikoe
Copy link
Contributor

rikoe commented Jul 10, 2019

@ruhnowg @RichLinnell as discussed in the Context Data & Intents working group, this would be a major breaking change to the schema in FDC3 1.0, which is in use today.

Are you okay with us closing this issue and continuing to use the context data interface as it is today?

@rikoe
Copy link
Contributor

rikoe commented Sep 11, 2019

Closing due to inactivity

@rikoe rikoe closed this as completed Sep 11, 2019
robmoffat added a commit to robmoffat/FDC3 that referenced this issue Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
context-data FDC3 Context Data Working Group
Projects
None yet
Development

No branches or pull requests

3 participants