v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB

Ref-Topic-Links

An API endpoint where, given a Ref, all of the topics linked to that Ref are retrieved along with the respective metadata.

get/api/ref-topic-links/{tref}

Response

Successful response

linkTypestring

The type of the link, based on the relationship within our ontology. Many links has an is-a relationship (such as Genesis is-a Book), but other topic-to-topic links have a variety of other types documented here.

Some examples include child-of, parent-of, sibling-of etc.

class'refTopic' | 'intraTopic'

A classification of the link as either refTopic (i.e. a ref to a topic) or intraTopic (topic-to-topic). In this case, it would be expected that all returned topic links would be of type refTopic.

is_sheetboolean

Is this ref-to-topic link one that was generated by a user-created source sheet?

topicstring

The title of the topic.

anchorRefstring

The Ref the topic is connected to, which should overlap with the requested Ref passed through the endpoint. For example, if someone queries for Bamidbar 28:21, one of the topics returned is passover which has an anchorRef of Numbers 28:16-24 - a range overlapping with our desired Ref.

anchorRefExpandedstring[]

If the anchorRef is a ranged Ref (i.e. containing more than a single segment), then this is a list of strings, with each string being one of single segment level Refs that together comprise the range. So for example, the anchorRefExpanded of Exodus 1:1-2 would be ["Exodus 1:1", "Exodus 1:2"].

Example response

{
  "linkType": "about",
  "class": "refTopic",
  "dataSource": {
    "en": "Aspaklaria",
    "he": "אספקלריא",
    "slug": "aspaklaria"
  },
  "is_sheet": false,
  "order": {
    "tfidf": 53.476917039392994,
    "numDatasource": 2,
    "availableLangs": [
      "en",
      "he"
    ],
    "comp_date": -1400,
    "order_id": "A00000000300280026",
    "pr": 5.15330629652094,
    "curatedPrimacy": {
      "en": 100,
      "he": 0
    }
  },
  "descriptions": {
    "en": {
      "title": "A New Grain Offering",
      "prompt": "The central ritual of Shavuot as described in the Torah is a special bread offering that was brought to the Temple. This sacrifice marked the beginning of sacrifices that were brought using grain from that year, as opposed to grains from the previous year, as explained in the Book of Numbers."
    }
  },
  "topic": "shavuot",
  "anchorRef": "Numbers 28:26",
  "anchorRefExpanded": [
    "Numbers 28:26"
  ]
}