rest-guide icon indicating copy to clipboard operation
rest-guide copied to clipboard

REST guide terminology: document vs. entity and filter vs. search

Open pvdbosch opened this issue 6 years ago • 1 comments

In GitLab by @pvdbosch on Nov 20, 2019, 15:01

During presentation of the REST guide to Flanders, there was some feedback on naming:

  • resource archetype "Document": would "Entity" be a better name?
    • an entity implies something with an identity, while "document" is like a volatile message
  • "Filtering" on collections: would "searching" be better?
    • the goal is finding items within collections
    • filtering could be misunderstood as property-level filtering on a response (?select=...)

pvdbosch avatar Jan 06 '20 14:01 pvdbosch

In GitLab by @pvdbosch on Nov 20, 2019, 15:01

changed the description

pvdbosch avatar Jan 06 '20 14:01 pvdbosch