forked from dev-magdy/Shreyash-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
the-gita-api.yaml
194 lines (194 loc) · 9.27 KB
/
the-gita-api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
openapi: 3.0.0
info:
title: The Gita API
version: "1.0"
description: Gita-API furnishes data associated with the renowned Vedic text, Bhagavad Gita, which is also recognized as the Iswara Gita, Ananta Gita, Hari Gita, Vyasa Gita, or simply, the Gita.
contact:
name: Pt. Prashant tripathi
url: https://github.com/ptprashanttripathi
servers:
- url: https://bhagavadgitaapi.in
paths:
/chapters:
get:
operationId: listAllChapters
description: Obtain a compilation of the 18 sections comprising the Bhagavad Gita.
responses:
"200":
content:
application/json:
examples:
response:
value:
- chapters:
- chapter_number: 1
name: "अर्जुनविषादयोग"
name_english: "Arjuna Dilemma"
name_transliterated: "Arjun Viṣhād Yog"
name_transliterated_simple: "Arjuna Visada Yoga"
verses_count: 47
- chapter_number: 2
name: "सांख्ययोग"
name_english: "Transcendental Knowledge"
name_transliterated: "Sānkhya Yog"
name_transliterated_simple: "Sankhya Yoga"
verses_count: 72
schema:
type: array
items:
$ref: "#/components/schemas/ChapterSchema"
description: "Success: Everything worked as expected."
"400":
description: "Bad Request: The request was unacceptable due to wrong parameter(s)."
"401":
description: "Unauthorized: Invalid access_token used."
"402":
description: Request Failed.
"500":
description: "Server Error: Something went wrong on our end."
summary: Get all the 18 Chapters of the Bhagavad Gita.
tags:
- chapter
/chapter/{chapter}:
get:
operationId: getParticularChapterByNumber
description: Retrieve specific information about the chapters of the Bhagavad Gita.
parameters:
- description: Which Chapter Number to filter? (from 1 to 18)
in: path
name: chapter
required: true
schema:
default: 1
type: integer
responses:
"200":
content:
application/json:
examples:
response:
value:
chapter_number: 1
verses_count: 47
name: "अर्जुनविषादयोग"
translation: "Arjuna Visada Yoga"
transliteration: "Arjun Viṣhād Yog"
meaning:
en: "Arjuna's Dilemma"
hi: "अर्जुन विषाद योग"
summary:
en: "The first chapter of the Bhagavad Gita - Arjuna Vishada Yoga introduces the setup, the setting, the characters and the circumstances that led to the epic battle of Mahabharata, fought between the Pandavas and the Kauravas. It outlines the reasons that led to the revelation of the of Bhagavad Gita.\nAs both armies stand ready for the battle, the mighty warrior Arjuna, on observing the warriors on both sides becomes increasingly sad and depressed due to the fear of losing his relatives and friends and the consequent sins attributed to killing his own relatives. So, he surrenders to Lord Krishna, seeking a solution. Thus, follows the wisdom of the Bhagavad Gita."
hi: "भगवद गीता का पहला अध्याय अर्जुन विशाद योग उन पात्रों और परिस्थितियों का परिचय कराता है जिनके कारण पांडवों और कौरवों के बीच महाभारत का महासंग्राम हुआ। यह अध्याय उन कारणों का वर्णन करता है जिनके कारण भगवद गीता का ईश्वरावेश हुआ। जब महाबली योद्धा अर्जुन दोनों पक्षों पर युद्ध के लिए तैयार खड़े योद्धाओं को देखते हैं तो वह अपने ही रिश्तेदारों एवं मित्रों को खोने के डर तथा फलस्वरूप पापों के कारण दुखी और उदास हो जाते हैं। इसलिए वह श्री कृष्ण को पूरी तरह से आत्मसमर्पण करते हैं। इस प्रकार, भगवद गीता के ज्ञान का प्रकाश होता है।"
schema:
$ref: "#/components/schemas/ChapterSchema"
description: "Success: Everything worked as expected."
"400":
description: "Bad Request: The request was unacceptable due to wrong parameter(s)."
"401":
description: "Unauthorized: Invalid access_token used."
"402":
description: Request Failed.
"404":
description: "Not Found: The chapter number you are looking for could not be found."
"500":
description: "Server Error: Something went wrong on our end."
summary: GET Particular Chapters details of Shreemad Bhagavad Gita.
tags:
- chapter
/slok/{chapter}/{verse}:
get:
operationId: getParticularVerseByNumberAndChapterNumber
description: You can utilize this endpoint to retrieve a particular verse from the Bhagavad Gita.
parameters:
- description: specfic chapter number from any of 18 chapters
in: path
name: chapter
required: true
schema:
default: 1
type: integer
- description: specfic verse number avilable in that particular chapters
in: path
name: verse
required: true
schema:
default: "1"
type: string
responses:
"200":
content:
application/json:
examples:
response:
value:
chapter_number: 1,
meaning: "Dhritarashtra said: O Sanjay, after gathering on the holy field of Kurukshetra, and desiring to fight, what did my sons and the sons of Pandu do?"
text: "धृतराष्ट्र उवाच | धर्मक्षेत्रे कुरुक्षेत्रे समवेता युयुत्सवः | मामकाः पाण्डवाश्चैव किमकुर्वत सञ्जय |||1||"
transliteration: "dhṛitarāśhtra uvācha dharma-kṣhetre kuru-kṣhetre samavetā yuyutsavaḥ māmakāḥ pāṇḍavāśhchaiva kimakurvata sañjaya"
verse_number: "1"
word_meanings: "dhṛitarāśhtraḥ uvācha—Dhritarashtra said; dharma-kṣhetre—the land of dharma; kuru-kṣhetre—at Kurukshetra; samavetāḥ—having gathered; yuyutsavaḥ—desiring to fight; māmakāḥ—my sons; pāṇḍavāḥ—the sons of Pandu; cha—and; eva—certainly; kim—what; akurvata—did they do; sañjaya—Sanjay"
schema:
$ref: "#/components/schemas/VerseSchema"
description: "Success: Everything worked as expected."
"400":
description: "Bad Request: The request was unacceptable due to wrong parameter(s)."
"401":
description: "Unauthorized: Invalid access_token used."
"402":
description: Request Failed.
"404":
description: "Not Found: The chapter/verse number you are looking for could not be found."
"500":
description: "Server Error: Something went wrong on our end."
summary: This endpoint allows you to get any random slok of Shreemad Bhagavad Gita.
tags:
- verse
tags:
- name: verse
- name: chapter
components:
schemas:
ChapterSchema:
properties:
chapter_number:
format: int32
nullable: true
type: integer
chapter_summary:
nullable: true
type: string
name:
nullable: true
type: string
name_meaning:
nullable: true
type: string
name_translation:
nullable: true
type: string
name_transliterated:
nullable: true
type: string
verses_count:
format: int32
nullable: true
type: integer
type: object
VerseSchema:
properties:
meaning:
nullable: true
type: string
text:
nullable: true
type: string
transliteration:
nullable: true
type: string
verse_number:
nullable: true
type: string
word_meanings:
nullable: true
type: string
type: object