Module: WikidataAdaptor::RestApi::Items

Included in:
WikidataAdaptor::RestApi
Defined in:
lib/wikidata_adaptor/rest_api/items.rb

Overview

https://doc.wikimedia.org/Wikibase/master/js/rest-api/#/items

Instance Method Summary collapse

Instance Method Details

#get_item(item_id) ⇒ Hash

Retrieve a single Wikibase Item by ID

Parameters:

  • item_id (String) —

    The ID of the required Item.

Returns:

  • (Hash) —

    A single Wikibase Item.



12
13
14
 
# File 'lib/wikidata_adaptor/rest_api/items.rb', line 12

def get_item(item_id)
  get_json("#{endpoint}/v1/entities/items/#{CGI.escape(item_id)}")
end

#patch_item(item_id, payload) ⇒ Hash

Apply JSON Patch operations to an Item.

Parameters:

  • item_id (String) —

    The ID of the Item.

  • payload (Hash) —

    JSON Patch operations and edit metadata.

Returns:

  • (Hash) —

    The updated Item.



31
32
33
 
# File 'lib/wikidata_adaptor/rest_api/items.rb', line 31

def patch_item(item_id, payload)
  patch_json("#{endpoint}/v1/entities/items/#{CGI.escape(item_id)}", payload)
end

#post_item(payload) ⇒ Hash

Create a Wikibase Item

Parameters:

  • payload (Hash) —

    Item containing a Wikibase Item and edit metadata

Returns:

  • (Hash) —

    A single Wikibase Item.



21
22
23
 
# File 'lib/wikidata_adaptor/rest_api/items.rb', line 21

def post_item(payload)
  post_json("#{endpoint}/v1/entities/items", payload)
end