Skip to content

Commit ac2c57e

Browse files
subalalithaflsubalalithafl
committed
Doc changes
1 parent 7296fa5 commit ac2c57e

26 files changed

+160
-85
lines changed

‎MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
include LICENSE
2-
include README.md
2+
include README.html

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Collection of NLP APIs to help developers. We have grouped the APIs under Basic
99

1010
This API is documented in **OpenAPI v3.0 format**.
1111
In addition to standard
12-
OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
12+
OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.html).
1313

1414
## Building
1515

@@ -143,7 +143,7 @@ nosetests
143143

144144
## Initialize the API Client
145145

146-
**_Note:_** Documentation for the client can be found [here.](/doc/client.md)
146+
**_Note:_** Documentation for the client can be found [here.](/doc/client.html)
147147

148148
The following parameters are configurable for the API Client:
149149

@@ -175,12 +175,12 @@ This API uses `Custom Header Signature`.
175175

176176
## List of APIs
177177

178-
* [Basic APIs](/doc/controllers/basic-api.md)
179-
* [Advanced APIs](/doc/controllers/advanced-api.md)
178+
* [Basic APIs](/doc/controllers/basic-api.html)
179+
* [Advanced APIs](/doc/controllers/advanced-api.html)
180180

181181
## Classes Documentation
182182

183-
* [Utility Classes](/doc/utility-classes.md)
184-
* [HttpResponse](/doc/http-response.md)
185-
* [HttpRequest](/doc/http-request.md)
183+
* [Utility Classes](/doc/utility-classes.html)
184+
* [HttpResponse](/doc/http-response.html)
185+
* [HttpRequest](/doc/http-request.html)
186186

‎dist/firstlanguage_python-1.0.1.tar.gz

33 KB
Binary file not shown.

‎doc/controllers/advanced-api.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ advanced_api_controller = client.advanced_api
1212

1313
## Methods
1414

15-
* [Get Classification](/fl-python/doc/controllers/advanced-api.md#get-classification)
16-
* [Get QA](/fl-python/doc/controllers/advanced-api.md#get-qa)
17-
* [Get NER](/fl-python/doc/controllers/advanced-api.md#get-ner)
18-
* [Get Summary](/fl-python/doc/controllers/advanced-api.md#get-summary)
19-
* [Get Translate](/fl-python/doc/controllers/advanced-api.md#get-translate)
15+
* [Get Classification](/firstlanguage_python/doc/controllers/advanced-api.html#get-classification)
16+
* [Get QA](/firstlanguage_python/doc/controllers/advanced-api.html#get-qa)
17+
* [Get NER](/firstlanguage_python/doc/controllers/advanced-api.html#get-ner)
18+
* [Get Summary](/firstlanguage_python/doc/controllers/advanced-api.html#get-summary)
19+
* [Get Translate](/firstlanguage_python/doc/controllers/advanced-api.html#get-translate)
2020

2121

2222
# Get Classification
@@ -58,7 +58,7 @@ def get_classification(self,
5858

5959
## Response Type
6060

61-
[`Responseclassify`](/fl-python/doc/models/responseclassify.md)
61+
[`Responseclassify`](/firstlanguage_python/doc/models/responseclassify.html)
6262

6363
## Example Usage
6464

@@ -87,8 +87,8 @@ result = advanced_api_controller.get_classification(body)
8787

8888
| HTTP Status Code | Error Description | Exception Class |
8989
| --- | --- | --- |
90-
| 400 | Error output | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
91-
| 426 | Please use HTTPS protocol | [`ApiClassify426ErrorException`](/fl-python/doc/models/api-classify-426-error-exception.md) |
90+
| 400 | Error output | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
91+
| 426 | Please use HTTPS protocol | [`ApiClassify426ErrorException`](/firstlanguage_python/doc/models/api-classify-426-error-exception.html) |
9292
| 429 | Too Many Requests | `APIException` |
9393

9494

@@ -113,7 +113,7 @@ def get_qa(self,
113113

114114
## Response Type
115115

116-
[`ApiQaResponse`](/fl-python/doc/models/api-qa-response.md)
116+
[`ApiQaResponse`](/firstlanguage_python/doc/models/api-qa-response.html)
117117

118118
## Example Usage
119119

@@ -137,8 +137,8 @@ result = advanced_api_controller.get_qa(body)
137137

138138
| HTTP Status Code | Error Description | Exception Class |
139139
| --- | --- | --- |
140-
| 400 | Bad Request | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
141-
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/fl-python/doc/models/m426-error-exception.md) |
140+
| 400 | Bad Request | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
141+
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/firstlanguage_python/doc/models/m426-error-exception.html) |
142142
| 429 | Too Many Requests | `APIException` |
143143

144144

@@ -179,7 +179,7 @@ def get_ner(self,
179179

180180
## Response Type
181181

182-
[`List of ApiNerResponse`](/fl-python/doc/models/api-ner-response.md)
182+
[`List of ApiNerResponse`](/firstlanguage_python/doc/models/api-ner-response.html)
183183

184184
## Example Usage
185185

@@ -211,8 +211,8 @@ result = advanced_api_controller.get_ner(body)
211211

212212
| HTTP Status Code | Error Description | Exception Class |
213213
| --- | --- | --- |
214-
| 400 | Bad Request | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
215-
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/fl-python/doc/models/m426-error-exception.md) |
214+
| 400 | Bad Request | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
215+
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/firstlanguage_python/doc/models/m426-error-exception.html) |
216216
| 429 | Too Many Requests | `APIException` |
217217

218218

@@ -280,7 +280,7 @@ def get_summary(self,
280280

281281
## Response Type
282282

283-
[`ApiSummaryResponse`](/doc/models/api-summary-response.md)
283+
[`ApiSummaryResponse`](/doc/models/api-summary-response.html)
284284

285285
## Example Usage
286286

@@ -302,8 +302,8 @@ result = advanced_ap_is_controller.get_summary(body)
302302

303303
| HTTP Status Code | Error Description | Exception Class |
304304
| --- | --- | --- |
305-
| 400 | Bad Request | [`ErrorsException`](/doc/models/errors-exception.md) |
306-
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/doc/models/m426-error-exception.md) |
305+
| 400 | Bad Request | [`ErrorsException`](/doc/models/errors-exception.html) |
306+
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/doc/models/m426-error-exception.html) |
307307
| 429 | Too Many Requests | `APIException` |
308308

309309

@@ -387,7 +387,7 @@ def get_translate(self,
387387

388388
## Response Type
389389

390-
[`ApiTranslateResponse`](/doc/models/api-translate-response.md)
390+
[`ApiTranslateResponse`](/doc/models/api-translate-response.html)
391391

392392
## Example Usage
393393

@@ -409,7 +409,7 @@ result = advanced_ap_is_controller.get_translate(body)
409409

410410
| HTTP Status Code | Error Description | Exception Class |
411411
| --- | --- | --- |
412-
| 400 | Bad Request | [`ErrorsException`](/doc/models/errors-exception.md) |
413-
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/doc/models/m426-error-exception.md) |
412+
| 400 | Bad Request | [`ErrorsException`](/doc/models/errors-exception.html) |
413+
| 426 | Please use HTTPS protocol | [`M426ErrorException`](/doc/models/m426-error-exception.html) |
414414
| 429 | Too Many Requests | `APIException` |
415415

‎doc/controllers/basic-api.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ basic_api_controller = client.basic_api
1212

1313
## Methods
1414

15-
* [Get Stemmer](/fl-python/doc/controllers/basic-api.md#get-stemmer)
16-
* [Get Lemma](/fl-python/doc/controllers/basic-api.md#get-lemma)
17-
* [Get Morph](/fl-python/doc/controllers/basic-api.md#get-morph)
18-
* [Get Postag](/fl-python/doc/controllers/basic-api.md#get-postag)
15+
* [Get Stemmer](/firstlanguage_python/doc/controllers/basic-api.html#get-stemmer)
16+
* [Get Lemma](/firstlanguage_python/doc/controllers/basic-api.html#get-lemma)
17+
* [Get Morph](/firstlanguage_python/doc/controllers/basic-api.html#get-morph)
18+
* [Get Postag](/firstlanguage_python/doc/controllers/basic-api.html#get-postag)
1919

2020

2121
# Get Stemmer
@@ -70,7 +70,7 @@ def get_stemmer(self,
7070

7171
## Response Type
7272

73-
[`List of Responsestem`](/fl-python/doc/models/responsestem.md)
73+
[`List of Responsestem`](/firstlanguage_python/doc/models/responsestem.html)
7474

7575
## Example Usage
7676

@@ -103,8 +103,8 @@ result = basic_api_controller.get_stemmer(body)
103103

104104
| HTTP Status Code | Error Description | Exception Class |
105105
| --- | --- | --- |
106-
| 400 | Error output | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
107-
| 426 | Please use HTTPS protocol | [`ApiStemmer426ErrorException`](/fl-python/doc/models/api-stemmer-426-error-exception.md) |
106+
| 400 | Error output | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
107+
| 426 | Please use HTTPS protocol | [`ApiStemmer426ErrorException`](/firstlanguage_python/doc/models/api-stemmer-426-error-exception.html) |
108108
| 429 | Too Many Requests | `APIException` |
109109

110110

@@ -148,7 +148,7 @@ def get_lemma(self,
148148

149149
## Response Type
150150

151-
[`List of Responselemma`](/fl-python/doc/models/responselemma.md)
151+
[`List of Responselemma`](/firstlanguage_python/doc/models/responselemma.html)
152152

153153
## Example Usage
154154

@@ -185,8 +185,8 @@ result = basic_api_controller.get_lemma(body)
185185

186186
| HTTP Status Code | Error Description | Exception Class |
187187
| --- | --- | --- |
188-
| 400 | Error output | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
189-
| 426 | Please use HTTPS protocol | [`ApiLemmatize426ErrorException`](/fl-python/doc/models/api-lemmatize-426-error-exception.md) |
188+
| 400 | Error output | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
189+
| 426 | Please use HTTPS protocol | [`ApiLemmatize426ErrorException`](/firstlanguage_python/doc/models/api-lemmatize-426-error-exception.html) |
190190
| 429 | Too Many Requests | `APIException` |
191191

192192

@@ -230,7 +230,7 @@ def get_morph(self,
230230

231231
## Response Type
232232

233-
[`Responsemorph`](/fl-python/doc/models/responsemorph.md)
233+
[`Responsemorph`](/firstlanguage_python/doc/models/responsemorph.html)
234234

235235
## Example Usage
236236

@@ -412,8 +412,8 @@ result = basic_api_controller.get_morph(body)
412412

413413
| HTTP Status Code | Error Description | Exception Class |
414414
| --- | --- | --- |
415-
| 400 | Error output | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
416-
| 426 | Please use HTTPS protocol | [`ApiMorph426ErrorException`](/fl-python/doc/models/api-morph-426-error-exception.md) |
415+
| 400 | Error output | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
416+
| 426 | Please use HTTPS protocol | [`ApiMorph426ErrorException`](/firstlanguage_python/doc/models/api-morph-426-error-exception.html) |
417417
| 429 | Too Many Requests | `APIException` |
418418

419419

@@ -450,7 +450,7 @@ def get_postag(self,
450450

451451
## Response Type
452452

453-
[`List of Responsepo`](/fl-python/doc/models/responsepo.md)
453+
[`List of Responsepo`](/firstlanguage_python/doc/models/responsepo.html)
454454

455455
## Example Usage
456456

@@ -499,7 +499,7 @@ result = basic_api_controller.get_postag(body)
499499

500500
| HTTP Status Code | Error Description | Exception Class |
501501
| --- | --- | --- |
502-
| 400 | Error output | [`ErrorsException`](/fl-python/doc/models/errors-exception.md) |
503-
| 426 | Please use HTTPS protocol | [`ApiPostag426ErrorException`](/fl-python/doc/models/api-postag-426-error-exception.md) |
502+
| 400 | Error output | [`ErrorsException`](/firstlanguage_python/doc/models/errors-exception.html) |
503+
| 426 | Please use HTTPS protocol | [`ApiPostag426ErrorException`](/firstlanguage_python/doc/models/api-postag-426-error-exception.html) |
504504
| 429 | Too Many Requests | `APIException` |
505505

‎doc/models/api-ner-request-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| Name | Type | Tags | Description |
1111
| --- | --- | --- | --- |
12-
| `input` | [`Input8`](/doc/models/input-8.md) | Required | - |
12+
| `input` | [`Input8`](/doc/models/input-8.html) | Required | - |
1313

1414
## Example (as JSON)
1515

‎doc/models/api-ner-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| Name | Type | Tags | Description |
1111
| --- | --- | --- | --- |
12-
| `input` | [`Input7`](/doc/models/input-7.md) | Required | - |
12+
| `input` | [`Input7`](/doc/models/input-7.html) | Required | - |
1313

1414
## Example (as JSON)
1515

‎doc/models/api-qa-request-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| Name | Type | Tags | Description |
1111
| --- | --- | --- | --- |
12-
| `input` | [`Input6`](/doc/models/input-6.md) | Required | - |
12+
| `input` | [`Input6`](/doc/models/input-6.html) | Required | - |
1313

1414
## Example (as JSON)
1515

‎doc/models/api-qa-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| Name | Type | Tags | Description |
1111
| --- | --- | --- | --- |
12-
| `input` | [`Input5`](/doc/models/input-5.md) | Required | - |
12+
| `input` | [`Input5`](/doc/models/input-5.html) | Required | - |
1313

1414
## Example (as JSON)
1515

‎doc/models/api-summary-request-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| Name | Type | Tags | Description |
1111
| --- | --- | --- | --- |
12-
| `input` | [`Input10`](/doc/models/input-10.md) | Required | - |
12+
| `input` | [`Input10`](/doc/models/input-10.html) | Required | - |
1313

1414
## Example (as JSON)
1515

0 commit comments

Comments
 (0)