Skip to content

Latest commit

 

History

History
177 lines (132 loc) · 4.52 KB

README.md

File metadata and controls

177 lines (132 loc) · 4.52 KB
Raw

Metadata Microservice

This repository implements the metadata services that are available in the API.

Quick Overview

Metadata Entity

dataset: <String>, required
language: <String>, required
name: <String>
info: <Object>
createdAt: <Date>
updatedAt: <Date>

Dataset Metadata

GET: /dataset/:dataset/metadata
POST: /dataset/:dataset/metadata
PATCH: /dataset/:dataset/metadata
DELETE: /dataset/:dataset/metadata

Widget Metadata

GET: /dataset/:dataset/widget/:widget/metadata
POST: /dataset/:dataset/widget/:widget/metadata
PATCH: /dataset/:dataset/widget/:widget/metadata
DELETE: /dataset/:dataset/widget/:widget/metadata

Layer Metadata

GET: /dataset/:dataset/layer/:layer/metadata
POST: /dataset/:dataset/layer/:layer/metadata
PATCH: /dataset/:dataset/layer/:layer/metadata
DELETE: /dataset/:dataset/layer/:layer/metadata

GetAll Metadata

GET: /metadata

FindByIds Metadata

POST: /dataset/metadata/find-by-ids
POST: /dataset/:dataset/widget/metadata/find-by-ids
POST: /dataset/:dataset/layer/metadata/find-by-ids

POST, PATCH, DELETE

"language" attribute is required and it is mandatory to include them in the payload (when doing CRUD requests). This doesn't apply to the FindByIds Endpoints

GET Queryparam Filters:

language: select between available languages (select one or some of them)
limit: desired number

Custom param for /metadata endpoint

type: [dataset, widget, layer]

CRUD Examples

Getting

GET: /dataset/111123/metadata
GET: /dataset/111123/widget/134599/metadata
GET: /dataset/111123/layer/134599/metadata
GET: /dataset/111123/metadata?language=es,en&limit=20
GET: /dataset/111123/widget/134599/metadata?language=en
GET: /dataset/111123/layer/134599/metadata?language=en

Creating

POST: /dataset/111123/metadata -> payload: {"language": "es"}
POST: /dataset/111123/widget/134599/metadata -> payload: {"language": "es"}
POST: /dataset/111123/layer/134599/metadata -> payload: {"language": "es"}
POST: /dataset/111123/layer/134599/metadata -> payload: {"language": "es", "name": "M1", "info": {"a": "a", "b": "b"}}

Updating (partial)

PATCH: /dataset/111123/metadata -> payload: {"language": "es", "name": "M0", "info": {"a": "A", "b": "B"}}
PATCH: /dataset/111123/widget/134599/metadata -> payload: {"language": "es", "name": "M1", "info": {"c": "C", "d": "D"}}
PATCH: /dataset/111123/layer/134599/metadata -> payload: {"language": "es", "name": "M2", "info": {"e": "E", "f": "F"}}
PATCH: /dataset/111123/layer/134599/metadata -> payload: {"language": "es", "name": "M3", "info": {"g": "G", "h": "H"}}

Deleting

DELETE: /dataset/111123/metadata?language=en
DELETE: /dataset/111123/widget/134599/metadata?language=es
DELETE: /dataset/111123/layer/134599/metadata?language=en

Getting All

GET: /metadata
GET: /metadata?type=dataset
GET: /metadata?type=widget
GET: /metadata?language=es,en&limit=20
GET: /metadata?language=en&type=dataset
GET: /metadata?language=en

Finding By Ids

"ids" property is required in the payload, in other case the endpoint responds a 400 HTTP ERROR (Bad Request) This property can be an Array or a String (comma-separated) payload -> {"ids": ["112313", "111123"]} payload -> {"ids": "112313, 111123"}

POST: /dataset/metadata/find-by-ids -> payload: {"ids": ["112313", "111123"]}
POST: /dataset/metadata/find-by-ids?language=es,en&limit=20 -> payload: {"ids": "112313, 111123"}
POST: /dataset/111123/widget/metadata/find-by-ids -> payload: {"ids": "112313, 111123"}
POST: /dataset/111123/widget/metadata/find-by-ids?language=es&limit=200 -> payload: {"ids": ["112313", "111123"]}

Ir order to contribute to this repo:

  1. Getting Started
  2. Deployment

Getting Started

First, make sure that you have the API gateway running locally.

We're using Docker which, luckily for you, means that getting the application running locally should be fairly painless. First, make sure that you have Docker Compose installed on your machine.

You also need to configure an alias for your local machine:

Get your local IP:

ifconfig

Modify the /etc/hosts config file adding a new rule: mymachine

vim /etc/hosts

Now we're ready to actually get the microservice running:

git clone https://github.com/resource-watch/rw_metadata
cd rw_metadata
./metadata.sh develop

You can now access the microservice through the API gateway.