Skip to content

Include Ids in Metadata Objects #128

@WesleyTangNationalInstruments

Description

Previously we included ids in the green-box metadata objects and these were removed due to deduping reasons. As we have recently taken the approach to change some of our APIs to operate on ids (e.g. Publish), it might make sense for us to re-add the ids to the green-box metadata objects.

One example would be a user wanting to publish a measurement with previously created metadata objects. While it's reasonable that we could expect the user to simply recreate them before publishing with the understanding that we would deduplicate, adding ids would enable the Query->Publish workflow which may be more intuitive.

Additionally, this can allow us to potentially improve our CreateAlias API to be more self-documenting as requiring ids implicitly enforces that the metadata object already exist and makes it more difficult for users to make mistakes, particularly the use case of Query->CreateAlias (in the case of Create->CreateAlias, we would already have the ids from the response of the Create call).

FYI @csjall

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions