Documentation outdated > cannot get to work

Created on 24 December 2022, almost 2 years ago
Updated 11 August 2023, over 1 year ago

Problem/Motivation

The documentation (specifically «Example 2 Rijksmuseum» from 2019) doesn't match the current implementation (8.x-2.0):

  • Mandatory «uuid» field mapping with no example or explanation
  • No explanation of «Verify entities» - external entity not in content list of content menu
  • External entity not in content list of view definition (as demonstrated per 2018 COPE recording)
  • «Search API» indexing (as demonstrated per 2018 COPE recording) causes HTTP error 500

Steps to reproduce

Reproduce Example 2 Rijksmuseum as per current documentation (D 9.5.0)

Module functionality required to access REST data

According to the module description this is what I need. A working REST source is available. However with the current information / documentation I cannot get the module to work - I am stuck.

Clarifications required:

  • uuid - what should be the field mapping? Is it created by Drupal or REST source?
  • How are entities verified?
  • Is Search API indexing still required? Pending issue for 9 years now

Maybe I can get a walk-through from one of the maintainers?

Happy to update the documentation once I got the module working.

💬 Support request
Status

Fixed

Component

Documentation

Created by

🇨🇭Switzerland janes_p Zurich

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Status changed to Fixed almost 2 years ago
  • 🇨🇭Switzerland janes_p Zurich

    I have installed the Search API module created an index on the external entity rijksmuseum.

    It looks like the Search API indexing process doesn't index anything, as per the view based on it (no results shown).

    Looking at the RijksData API documentation, it appears the index should look for artObjects (plural, result of request below) instead of artObject, as per field mappings.

    Request to retrieve whole collection - curl https://www.rijksmuseum.nl/api/en/collection?key=fpGQTuED&format=json

    Where do I need to specify the artObjects target for the indexing process?

  • 🇨🇭Switzerland janes_p Zurich

    Now struggling with my own example (as simple as possible):

    Calling a PostgREST service on a PostgreSQL database - curl http://152.67.66.248:3000/test1 returns this:

    [{"test1_id":1,"test1_name":"John"}, 
     {"test1_id":2,"test1_name":"Kate"}, 
     {"test1_id":3,"test1_name":"Bill"}]

    You can check for yourself - the service is up and running most of the time.

    External entity test_1:

    REST storage with endpoint http://152.67.66.248:3000/test1

    List parameters, single parameters - format | json

    Simple mappings:

    ID - test1_id
    Title - test1_name

    /test_1/1 returns Page not found

    Any hint what's missing would be much appreciated!

  • Automatically closed - issue fixed for 2 weeks with no activity.

  • Status changed to Fixed over 1 year ago
  • 🇺🇸United States designerada

    This seems to still be an issue. I'm having the same problem as #10, except using a JSON file. I've spent weeks trying to make sure everything is set up correctly. I installed the xnttfiles, xnttjson, xnttmulti, and xnttmanager modules. I also studied the JSONPath syntax documentation to make sure all my file mappings are correct, and still, despite anything I try, I get "Page not found" for each individual external entity page I try to view.

Production build 0.71.5 2024