openfoodfacts / folksonomy_api

A light REST API designed for Open Food Facts folksonomy engine
https://wiki.openfoodfacts.org/Folksonomy_Engine
GNU Affero General Public License v3.0
11 stars 7 forks source link

Harmonize vocabulary #11

Open CharlesNepote opened 3 years ago

CharlesNepote commented 3 years ago

In the API documentation we use:

Tag, key/value

In the general public, a tag is only a keyword, not a combination of a property and a value. This meaning is shared by:

The OpenStreetMap community is using the "tag" term: A tag consists of two items, a key and a value (source). But OpenStreetMap mappers are often techies who know what is key and a value. A key is probably not very instinctive for Open Food Facts contributors.

Pros:

Cons:

Pair (or triple or triple tag), property, value

Pros:

Cons:

Other?

stephanegigandet commented 3 years ago

I much prefer property and value. e.g. this product has the value "Green" for the property "Color". I don't see the need to introduce the notion of a pair (property + value). e.g. for the OFF API, we never say "you can set a pair of field + value", we just say that you can set the value for some field. Same here, we can read or write the value for a property.

aadarsh-ram commented 2 years ago

I agree with @stephanegigandet. I had a confusion regarding 'k' and 'v' when I first tried using Folksonomy Engine. Renaming it as 'property' and 'value' would be much better, as it accurately conveys it's meaning. If required, the (property+value) pair could be named as a 'couple' instead. According to me, other people would be able to instinctively understand that a 'couple' = ('property' + 'value').

@CharlesNepote @stephanegigandet, does this make any sense?

stephanegigandet commented 2 years ago

Thanks @aadarsh-ram . Renaming k and v to property and value makes sense to me.

puneeth072003 commented 1 year ago

hey i'm new to this community where shall i start

puneeth072003 commented 1 year ago

Can i get any guidance, like what should i learn then how can i contribute in this project

alexgarel commented 1 year ago

Hi @puneeth072003 can you join on slack ? (we should limit off-topic discussion on the issue).

For this project, key knowledge is Postgresql, Python and FastAPI. You are really welcome to contribute :-)