Skip to content

Commit

Permalink
chore(API Docs): Remove default
Browse files Browse the repository at this point in the history
  • Loading branch information
@saengel
saengel committed Mar 13, 2024
1 parent 60fced3 commit 963fc84
Showing 1 changed file with 6 additions and 32 deletions.
38 changes: 6 additions & 32 deletions openAPI.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -738,8 +738,7 @@
"name": "tref",
"description": "A valid Sefaria textual `Ref`.",
"schema": {
"$ref": "#/components/schemas/ref",
"default": "Obadiah 1.2"
"$ref": "#/components/schemas/ref"
},
"in": "path",
"required": true
Expand Down Expand Up @@ -856,7 +855,6 @@
"name": "parasha",
"description": "The _Parasha_ for which you'd like to generate relevant metadata, most notably the schedule of when it is next read. \n\n*Note*: The _Parasha_ must be in English written with a capitalized first letter, so `Noach` is valid, but `noach` will return an empty array. Any parshiyot with special characters (i.e. apostrophes, or spaces) should have those special characters percent url encoded. ",
"schema": {
"default": "Lech%20Lecha",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -942,8 +940,7 @@
"name": "tref",
"description": "A valid Sefaria textual `Ref`.",
"schema": {
"$ref": "#/components/schemas/ref",
"default": "Pesachim 21b.1"
"$ref": "#/components/schemas/ref"
},
"in": "path",
"required": true
Expand All @@ -958,7 +955,6 @@
"name": "limit",
"description": "Number of results to return (`0` indicates no limit)",
"schema": {
"default": 10,
"type": "integer"
},
"in": "query"
Expand All @@ -967,7 +963,6 @@
"name": "ref_only",
"description": "By default `0` the Name API returns `Ref`s, book titles, authors, topics, and collections. If true, the response will only contain text references.",
"schema": {
"default": false,
"type": "boolean"
},
"in": "query"
Expand All @@ -993,7 +988,6 @@
"name": "name",
"description": "An arbitrary text string to match against Sefaria's data collections.",
"schema": {
"default": "Shabbat",
"type": "string"
},
"in": "path",
Expand All @@ -1013,7 +1007,6 @@
"name": "ref_list",
"description": "List of strings separated by '+'",
"schema": {
"default": "Genesis 50+Mishnah Peah 3",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -1081,7 +1074,6 @@
"name": "ref_list",
"description": "List of strings separated by '+'",
"schema": {
"default": "Genesis 50+Mishnah Peah 3",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -1165,8 +1157,7 @@
"name": "tref",
"description": "A valid Sefaria textual `Ref`",
"schema": {
"$ref": "#/components/schemas/ref",
"default": "Shabbat 2b.2"
"$ref": "#/components/schemas/ref"
},
"in": "path",
"required": true
Expand Down Expand Up @@ -1717,8 +1708,7 @@
"name": "tref",
"description": "A valid Sefaria textual `Ref`. ",
"schema": {
"$ref": "#/components/schemas/ref",
"default": "Deuteronomy 1.1"
"$ref": "#/components/schemas/ref"
},
"in": "path",
"required": true
Expand Down Expand Up @@ -1796,7 +1786,6 @@
"name": "name",
"description": "The English name of a valid Sefaria term. ",
"schema": {
"default": "Noah",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -1868,7 +1857,6 @@
"name": "lang",
"description": "An ISO 639-1 language code.",
"schema": {
"default": "fr",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -2028,7 +2016,6 @@
"name": "index",
"description": "A valid Sefaria Index",
"schema": {
"default": "Kohelet",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -2220,7 +2207,6 @@
"name": "link_type",
"description": "Default is `is-a`, but you can pass any link type.",
"schema": {
"default": "the-four-species",
"type": "string"
},
"in": "query"
Expand Down Expand Up @@ -2366,7 +2352,6 @@
"name": "topic_slug",
"description": "The slug of a topic in the Sefaria system. (To find all of the slugs, you can run `api/topics` without a path parameter to see the data for each topic in our database).",
"schema": {
"default": "nachman-of-breslov",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -3096,7 +3081,6 @@
"name": "index_title",
"description": "A title of a valid Sefaria `Index`. For a complete list of works in the [Sefaria](sefaria.org) library, as well as their index titles, query the [api/index](https://www.sefaria.org/api/index/) endpoint. ",
"schema": {
"default": "Pesachim",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -3273,7 +3257,6 @@
"name": "topic_slug",
"description": "The slug of the desired topic",
"schema": {
"default": "torah",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -4265,7 +4248,6 @@
"name": "tref",
"description": "A Sefaria-specific reference, `Ref`. This should be a segment `Ref` (the most specific reference possible), or bottom level section `Ref` (i.e. a section of text on level up, a section is an array of segments). If a `Ref` is passed in which is not a segment level or a bottom level section, the response will be to the first bottom level section `Ref` (e.g. `Genesis` will resolve to the bottom level section `Ref` of `Genesis 1`)",
"schema": {
"default": "Esther 4:14",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -4377,7 +4359,6 @@
"name": "word",
"description": "The word or phrase to search for in the lexicons.",
"schema": {
"default": "שב",
"type": "string"
},
"in": "path",
Expand All @@ -4393,7 +4374,6 @@
"name": "limit",
"description": "Number of results to return (0 indicates no limit, and is the default)",
"schema": {
"default": 10,
"type": "integer"
},
"in": "query"
Expand Down Expand Up @@ -4422,7 +4402,6 @@
"name": "lexicon",
"description": "An optional text string matching the name of one of Sefaria's lexicons to limit the search.",
"schema": {
"default": "Klein Dictionary",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -4510,7 +4489,6 @@
"name": "word",
"description": "An arbitrary text string to match against Sefaria's lexicon collections.",
"schema": {
"default": "שב",
"type": "string"
},
"in": "path",
Expand All @@ -4534,7 +4512,6 @@
"name": "tref",
"description": "The `tref` parameter must a valid Sefaria ref to a text.",
"schema": {
"default": "Numbers 12.1",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -4614,7 +4591,6 @@
"name": "tref",
"description": "A valid Sefaria ref",
"schema": {
"default": "Numbers.17.2",
"type": "string"
},
"in": "path",
Expand Down Expand Up @@ -4784,8 +4760,7 @@
"name": "tref",
"description": "A valid textual `Ref` to a Sefaria text.",
"schema": {
"$ref": "#/components/schemas/ref",
"default": "Rashi on Genesis 1:1:1"
"$ref": "#/components/schemas/ref"
},
"in": "path",
"required": true
Expand Down Expand Up @@ -4898,8 +4873,7 @@
"name": "tref",
"description": "A valid textual `Ref` to a Sefaria text.",
"schema": {
"$ref": "#/components/schemas/ref",
"default": "Rashi on Genesis 1:1:1"
"$ref": "#/components/schemas/ref"
},
"in": "path",
"required": true
Expand Down

0 comments on commit 963fc84

Please sign in to comment.