@datafire/mozilla_kinto v6.0.0

@datafire/mozilla_kinto

Client library for Remote Settings

Installation and Usage

npm install --save @datafire/mozilla_kinto

let mozilla_kinto = require('@datafire/mozilla_kinto').create();

.then(data => {
  console.log(data);
});

Description

Actions

server_info

mozilla_kinto.server_info(null, context)

Input

This action has no parameters

Output

• output object

get_openapi_spec

mozilla_kinto.get_openapi_spec(null, context)

Input

This action has no parameters

Output

• output object

heartbeat

mozilla_kinto.__heartbeat__(null, context)

Input

This action has no parameters

Output

• output object

lbheartbeat

mozilla_kinto.__lbheartbeat__(null, context)

Input

This action has no parameters

Output

• output object

version

mozilla_kinto.__version__(null, context)

Input

This action has no parameters

Output

• output object

batch

mozilla_kinto.batch({
  "BatchPayloadSchema": {
    "requests": []
  }
}, context)

Input

• input object
  • BatchPayloadSchema required object
    • defaults object
      • body object
      • headers object
      • method string (values: GET, HEAD, DELETE, TRACE, POST, PUT, PATCH)
      • path string
    • requests required array
      • items object
        • body object
        • headers object
        • method string (values: GET, HEAD, DELETE, TRACE, POST, PUT, PATCH)
        • path required string

Output

• output object
  • responses required array
    • items object
      • body object
      • headers object
      • path required string
      • status required integer

get_buckets

mozilla_kinto.get_buckets({}, context)

Input

• input object
  • _limit integer
  • _sort array
  • _token string
  • _since integer
  • _to integer
  • _before integer
  • id string
  • last_modified integer
  • _fields array
  • If-Match string
  • If-None-Match string

Output

• output object
  • data array
    • items object
      • collection:schema object
      • group:schema object
      • record:schema object

get_changess

mozilla_kinto.get_changess({}, context)

Input

• input object
  • _limit integer
  • _sort array
  • _token string
  • _since integer
  • _to integer
  • _before integer
  • id string
  • last_modified integer
  • _fields array
  • If-Match string
  • If-None-Match string

Output

• output object
  • data array
    • items object
      • bucket required string
      • collection required string
      • host required string

get_collections

mozilla_kinto.get_collections({
  "bucket_id": ""
}, context)

Input

• input object
  • _limit integer
  • _sort array
  • _token string
  • _since integer
  • _to integer
  • _before integer
  • id string
  • last_modified integer
  • _fields array
  • If-Match string
  • If-None-Match string
  • bucket_id required string

Output

• output object
  • data array
    • items object
      • cache_expires integer
      • schema object

get_records

mozilla_kinto.get_records({
  "bucket_id": "",
  "collection_id": ""
}, context)

Input

• input object
  • _limit integer
  • _sort array
  • _token string
  • _since integer
  • _to integer
  • _before integer
  • id string
  • last_modified integer
  • _fields array
  • If-Match string
  • If-None-Match string
  • bucket_id required string
  • collection_id required string

Output

• output object
  • data array
    • items object

get_record

mozilla_kinto.get_record({
  "bucket_id": "",
  "collection_id": "",
  "id": ""
}, context)

Input

• input object
  • _fields array
  • If-Match string
  • If-None-Match string
  • bucket_id required string
  • collection_id required string
  • id required string

Output

• output object
  • data object
  • permissions object
    • read array
      • items string
    • write array
      • items string

delete_attachment

mozilla_kinto.delete_attachment({
  "bucket_id": "",
  "collection_id": "",
  "id": ""
}, context)

Input

• input object
  • bucket_id required string
  • collection_id required string
  • id required string

Output

Output schema unknown

create_attachment

mozilla_kinto.create_attachment({
  "bucket_id": "",
  "collection_id": "",
  "id": ""
}, context)

Input

• input object
  • bucket_id required string
  • collection_id required string
  • id required string

Output

Output schema unknown

get_collection

mozilla_kinto.get_collection({
  "bucket_id": "",
  "id": ""
}, context)

Input

• input object
  • _fields array
  • If-Match string
  • If-None-Match string
  • bucket_id required string
  • id required string

Output

• output object
  • data object
    • cache_expires integer
    • schema object
  • permissions object
    • read array
      • items string
    • record:create array
      • items string
    • write array
      • items string

get_groups

mozilla_kinto.get_groups({
  "bucket_id": ""
}, context)

Input

• input object
  • _limit integer
  • _sort array
  • _token string
  • _since integer
  • _to integer
  • _before integer
  • id string
  • last_modified integer
  • _fields array
  • If-Match string
  • If-None-Match string
  • bucket_id required string

Output

• output object
  • data array
    • items object
      • members array
        • items string

get_group

mozilla_kinto.get_group({
  "bucket_id": "",
  "id": ""
}, context)

Input

• input object
  • _fields array
  • If-Match string
  • If-None-Match string
  • bucket_id required string
  • id required string

Output

• output object
  • data object
    • members array
      • items string
  • permissions object
    • read array
      • items string
    • write array
      • items string

get_bucket

mozilla_kinto.get_bucket({
  "id": ""
}, context)

Input

• input object
  • _fields array
  • If-Match string
  • If-None-Match string
  • id required string

Output

• output object
  • data object
    • collection:schema object
    • group:schema object
    • record:schema object
  • permissions object
    • collection:create array
      • items string
    • group:create array
      • items string
    • read array
      • items string
    • write array
      • items string

contribute

mozilla_kinto.contribute(null, context)

Input

This action has no parameters

Output

• output object

get_blocklist

mozilla_kinto.get_blocklist({
  "api_ver:\\d+": "",
  "metrics:.*": "",
  "prefix": "",
  "application_guid": "",
  "application_ver": ""
}, context)

Input

• input object
  • api_ver:\d+ required string
  • metrics:.* required string
  • prefix required string
  • application_guid required string
  • application_ver required string

Output

Output schema unknown

Definitions

This integration has no definitions