https://github.com/koop-retired/koop-api

API Plans and Docs for Koop
https://github.com/koop-retired/koop-api

Last synced: about 2 months ago
JSON representation

API Plans and Docs for Koop

• Host: GitHub
• URL: https://github.com/koop-retired/koop-api
• Owner: koop-retired
• License: apache-2.0
• Archived: true
• Created: 2016-01-14T02:08:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-01-14T20:19:36.000Z (over 8 years ago)
• Last Synced: 2024-04-29T23:52:08.566Z (5 months ago)
• Size: 6.84 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - koop-retired/koop-api - API Plans and Docs for Koop (others)

README

        
# Koop API

## Basic CRUD

### Import/Update dataset

`put :koop/:source_type/:host/:identifier`

### Delete dataset

`delete :koop/:source_type/:host/:identifier`

ArcGIS example

`put :koop/ArcGIS/production/1ef_2`

### Get info

`get :koop/:source_type/:host/:identifier`

## Source

*A source exposes two functions `fetchMetadata` and `toGeoJSON`*

### `Source.fetchMetadata`

Returns a promise that resolves with metadata about the resource, including a set of URLs pointing to all the raw data

```javascript

async function fetchMetadata (options) {

      return {

      name: String,

      updated: Number,

      retrieved: Number,

      data: Array, // pointers to raw data

      fields: Array // Map("string", "string")

    }

}

```

ArcGIS example

```javascript

import 'portal'

import 'featureService'

async function fetchMetadata (host, identifier) {

  try {

    const itemId = identifier.split('_')[0]

    const layer = identifier.split('_')[1] || 0

    const item = await portal.getItem(options)

    const service = new FeatureService(item.url, {layer: layer})

    const pages = await service.getPages()

    return {

      name: service.name,

      updated: service.updated,

      retrieved: Date.now(),

      data: pages,

      fields: service.fields

    }

  } catch (e) {

    throw new Error('Request for resource metadata failed')  

  }

}

```

#### `Source.toGeoJSON`

Transform stream that takes in raw input from one of the data urls and emits either GeoJSON features or errors

```javascript

function toGeoJSON (options) {

 const output = _.pipeline(stream => {

  return stream

  .pipe(transformation) // implement source specific logic

  .on('error', e => output.emit('error', e))

 })

 return output

}

```

## Global

The `global` `source_type` is reserved for actions that map across all resources

## Cache

Functions exposed

### `Cache.createTable`

### `Cache.stageTable`

Creates table in a partitioned namespace as a holding point while data is being gathered

### `Cache.promoteTable`

* Promotes table from staging into

* e.g.: `BEGIN;DROP TABLE IF EXISTS ${table}; ALTER TABLE ${staging_table} RENAME TO ${table};COMMIT`

### `Cache.insert`

### `Cache.createExportStream`

### `Cache.remove`

### `Cache.aggregate`

### `Cache.select`

### `Cache.count`

## Plugins

*A plugin exposes a set of functions that act on a resource*

### `get :koop/:source_type/:host/:identifier/:plugin/:action?:query`

Koop-Exporter

* Download file

  * `get :koop/:source_type/:host/:identifier/export.format?:query`

Koop-Search

* Search across all resources

  * `get :koop/global/search?:query`

Koop-Geoservices

* Make a Feature Service style request

* Depends on `Cache` & `Index`

  * `get :koop/:source_type/:host/:identifier/FeatureService/0/query?:query`

Koop-Queue

* Manage a job queue

* Add a job onto the queue

  * `put :koop/:source_type/:host/:identifier/:queue/:job_type`