search

azurestandard / api-spec

OpenAPI 3.0 Specification for Azure Standard’s API.
https://azure-api-docs.netlify.app/
1 stars 1 forks source link

Add piece meta links to product api. #333

Closed tommckennon closed 2 years ago

tommckennon commented 2 years ago

@davidmcatee-azure , I figured I would give this new inline product property a more descriptive name (pieceMetaLinks) in case we want to add any other product links in the future, and the front-end will know exactly what type of links they are. If no, just name it links?

tommckennon commented 2 years ago

@davidmcatee-azure , I added the inline rule to this new property's description. I noticed its left out of the allergens description. Probably should add that to the allergens description, correct?

davidmcatee-azure commented 2 years ago

@davidmcatee-azure , I figured I would give this new inline product property a more descriptive name (pieceMetaLinks) in case we want to add any other product links in the future, and the front-end will know exactly what type of links they are. If no, just name it links?

I would just name it links. As far as the API is concerned, there is no such thing as a piece meta. It is abstracted and called a "product", so "pieceMetaLinks" is no more descriptive than "links" since it is on the product JSON.

davidmcatee-azure commented 2 years ago

Probably should add that to the allergens description, correct?

Correct.

tommckennon commented 2 years ago

Thanks @davidmcatee-azure for answering those questions. You can provide review these spec changes when you're free.