search

openchargemap / ocm-docs

Documentation and branding source files
MIT License
8 stars 8 forks source link

Documentation #6

Closed wanderzirkus closed 2 years ago

wanderzirkus commented 5 years ago

Hi,

am I missing something or is there no documentation on the properties delivered by the json-response at all? I mean things like the meaning of "IsRecentlyVerified" and when exactly it is true or false.

BR, Friedemann.

webprofusion-chrisc commented 5 years ago

Hi, no you are correct there is no per-data-field documentation currently, it just hasn't been written.

Looking at this, IsRecentlyVerified is true if there is a DateLastVerified value. So I'd look at the DateLastVerified field instead which is computed based on a combination of DateLastConfirmed (typically the last edit date, if it's within the last 6 months), or the latest User comment with a positive status type, or the date it was created in the database (if within the last month). We don't actually have a button anywhere for 'I confirm this information is all present and correct', which would probably be the best way.

webprofusion-chrisc commented 5 years ago

Leaving the issue open because we do need full API docs.

wanderzirkus commented 5 years ago

Thanks, I can do some documentation on my side when I have spme spare time. :)

webprofusion-chrisc commented 2 years ago

Closing. Our API documentation (and associated output models) are fairly well documented now:https://openchargemap.org/site/develop/api

Adjustments can be made by editing our API schema: https://github.com/openchargemap/ocm-docs/blob/master/Model/schema/ocm-api-schema.yaml