search

openculinary / knowledge-graph

The RecipeRadar knowledge graph stores and provides access to recipe and ingredient relationship information.
GNU Affero General Public License v3.0
10 stars 0 forks source link

Refactor: equipment endpoint: remove per-entity response fields #45

Closed jayaddison closed 4 years ago

jayaddison commented 4 years ago

Describe the reason for these changes and the problem that they solve

The number of entity types that will be included in the knowledge graph's /equipment/query -- possibly a misnomer for a /directions/query -- endpoint API response will soon increase, and in the short term it seems to make sense to bundle more of this content into the markup returned for each parsed text input.

Longer term it will make sense for the markup to include id reference attributes, and for the response to include metadata about each of the associated items; a few more steps are required before we can reach that point.

Briefly summarize the changes

  1. Refactor the /equipment/query endpoint to include inline entity information inside the markup response field
  2. Rename the /equipment/query endpoint to /directions/query

How have the changes been tested?

  1. Unit test coverage is updated
jayaddison commented 4 years ago

NB: This is a breaking API change.