maverick/flex-template-web
1
0
Fork 0
mirror of https://github.com/kingomarnajjar/flex-template-web.git synced 2026-07-26 06:47:17 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation about extended data

Browse source
This commit is contained in:
Hannu Lyytikainen 2018-04-19 11:35:55 +03:00
parent 919ed201b0
commit ca4f9700c0
2 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -22,3 +22,4 @@ Documentation for specific topics can be found in the following files:
* [Google Maps](google-maps.md)
* [Content Security Policy (CSP)](content-security-policy.md)
* [Search filters](search-filters.md)
* [Extended data](extended-data.md)

37
docs/extended-data.md Normal file
View file

@ -0,0 +1,37 @@
# Extended Data
_Extended data_ is arbitrary information that can be attached to certain resources in the Flex API.
Extended data values can be of any valid JSON data type, including JSON data structures like object
and array. The purpose of extended data is to expand the ways in which the Flex API can be used.
## Types of extended data
Extended data is divided into two types: _public data_ and _protected data_.
### Public data
Public data can be written by anyone who has write permission to a resource and it is visible to
anyone who can read that resource.
### Protected data
Protected data, just like public data, can be modified by anyone with write access to the resource.
However, it can only be read by marketplace operators. It is also possible to reveal the protected
data at a specific point in the booking transaction process, for example if listing's address is
presented to the customer after a booking has been confirmed.
## Data schema and searched
Extended data works out of the box without any prior configuration to the marketplace. Public and
protected data can be added to listings just by passing it in the create/update request to the API.
However, optionally a _data schema_ can be defined for an extended data key. The data schema allows
that extended data field to be used as a search parameter in some API endpoints, like in the
listings query endpoint.
## Extended data in Flex template app
The Flex web template uses extended data by default with listing and user resources. In case of the
listings, category and amenities fields are stored in the `publicData` field. For the
users, phone number is stored in the `protectedData` field. As for indexed data, the template app
relies on data schemas for categories and amenities to be configured for the marketplace in the API
as those values are used as filters in the listing search.