Skip to content

Commit

Permalink
Updated talawa api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gautam-divyanshu committed Dec 29, 2024
1 parent c05804b commit d9d8d29
Show file tree
Hide file tree
Showing 1,336 changed files with 2,875 additions and 2,275 deletions.
4 changes: 2 additions & 2 deletions docs/talawa-api-docs/REST/controllers/mutation/createPost/functions/createPost.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Express request object with authenticated user

### res

`Response`\<`any`, `Record`\<`string`, `any`\>\>
`Response`

Express response object

Expand Down Expand Up @@ -64,4 +64,4 @@ InputValidationError - When title or text validation fails

## Defined in

[src/REST/controllers/mutation/createPost.ts:71](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/controllers/mutation/createPost.ts#L71)
[src/REST/controllers/mutation/createPost.ts:71](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/controllers/mutation/createPost.ts#L71)
4 changes: 2 additions & 2 deletions docs/talawa-api-docs/REST/controllers/mutation/updatePost/functions/updatePost.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Express request object with authenticated user

### res

`Response`\<`any`, `Record`\<`string`, `any`\>\>
`Response`

Express response object

Expand Down Expand Up @@ -68,4 +68,4 @@ InputValidationError - When title/text validation fails or pinned status require

## Defined in

[src/REST/controllers/mutation/updatePost.ts:73](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/controllers/mutation/updatePost.ts#L73)
[src/REST/controllers/mutation/updatePost.ts:73](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/controllers/mutation/updatePost.ts#L73)
6 changes: 3 additions & 3 deletions docs/talawa-api-docs/REST/controllers/query/getFile/functions/getFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ If an error occurs during the retrieval, it logs the error and sends a 500 statu

### req

`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
`Request`

The Express request object, containing the key for the file in the parameters.

### res

`Response`\<`any`, `Record`\<`string`, `any`\>\>
`Response`

The Express response object used to send the file back to the client.

Expand All @@ -42,4 +42,4 @@ app.get("/file/:key*", getFile);

## Defined in

[src/REST/controllers/query/getFile.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/controllers/query/getFile.ts#L23)
[src/REST/controllers/query/getFile.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/controllers/query/getFile.ts#L23)
6 changes: 3 additions & 3 deletions docs/talawa-api-docs/REST/routes/functions/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@

### req

`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
`Request`

### res

`Response`\<`any`, `Record`\<`string`, `any`\>, `number`\>
`Response`

### next

Expand All @@ -28,4 +28,4 @@

## Defined in

[src/REST/routes/index.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/routes/index.ts#L10)
[src/REST/routes/index.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/routes/index.ts#L10)
2 changes: 1 addition & 1 deletion docs/talawa-api-docs/REST/services/file/createFile/functions/createFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ console.log(file);

## Defined in

[src/REST/services/file/createFile.ts:25](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/file/createFile.ts#L25)
[src/REST/services/file/createFile.ts:25](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/file/createFile.ts#L25)
2 changes: 1 addition & 1 deletion docs/talawa-api-docs/REST/services/file/deleteFile/functions/deleteFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@

## Defined in

[src/REST/services/file/deleteFile.ts:5](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/file/deleteFile.ts#L5)
[src/REST/services/file/deleteFile.ts:5](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/file/deleteFile.ts#L5)
6 changes: 3 additions & 3 deletions docs/talawa-api-docs/REST/services/file/uploadFile/functions/uploadFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Handles file upload.

### req

`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
`Request`

The HTTP request object containing the file.

### res

`Response`\<`any`, `Record`\<`string`, `any`\>\>
`Response`

The HTTP response object used to send the response.

Expand All @@ -36,4 +36,4 @@ Error - Throws an error if no file is uploaded or if the file type is invalid.

## Defined in

[src/REST/services/file/uploadFile.ts:28](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/file/uploadFile.ts#L28)
[src/REST/services/file/uploadFile.ts:28](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/file/uploadFile.ts#L28)
34 changes: 17 additions & 17 deletions ...-docs/REST/services/file/uploadFile/interfaces/InterfaceUploadedFileResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

#### Defined in

[src/models/File.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L8)
[src/models/File.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L10)

***

Expand All @@ -36,7 +36,7 @@

#### Defined in

[src/models/File.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L20)
[src/models/File.ts:22](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L22)

***

Expand All @@ -50,7 +50,7 @@

#### Defined in

[src/models/File.ts:26](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L26)
[src/models/File.ts:28](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L28)

***

Expand All @@ -64,7 +64,7 @@

#### Defined in

[src/models/File.ts:22](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L22)
[src/models/File.ts:24](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L24)

***

Expand All @@ -78,7 +78,7 @@

#### Defined in

[src/models/File.ts:24](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L24)
[src/models/File.ts:26](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L26)

***

Expand All @@ -92,7 +92,7 @@

#### Defined in

[src/models/File.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L19)
[src/models/File.ts:21](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L21)

***

Expand All @@ -106,7 +106,7 @@

#### Defined in

[src/models/File.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L9)
[src/models/File.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L11)

***

Expand All @@ -128,7 +128,7 @@

#### Defined in

[src/models/File.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L12)
[src/models/File.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L14)

***

Expand All @@ -142,7 +142,7 @@

#### Defined in

[src/models/File.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L18)
[src/models/File.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L20)

***

Expand All @@ -156,7 +156,7 @@

#### Defined in

[src/models/File.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L10)
[src/models/File.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L12)

***

Expand All @@ -166,7 +166,7 @@

#### Defined in

[src/REST/services/file/uploadFile.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/file/uploadFile.ts#L18)
[src/REST/services/file/uploadFile.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/file/uploadFile.ts#L18)

***

Expand All @@ -180,7 +180,7 @@

#### Defined in

[src/models/File.ts:17](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L17)
[src/models/File.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L19)

***

Expand All @@ -194,7 +194,7 @@

#### Defined in

[src/models/File.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L11)
[src/models/File.ts:13](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L13)

***

Expand All @@ -208,7 +208,7 @@

#### Defined in

[src/models/File.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L23)
[src/models/File.ts:25](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L25)

***

Expand All @@ -222,7 +222,7 @@

#### Defined in

[src/models/File.ts:25](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L25)
[src/models/File.ts:27](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L27)

***

Expand All @@ -236,7 +236,7 @@

#### Defined in

[src/models/File.ts:16](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L16)
[src/models/File.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L18)

***

Expand All @@ -250,4 +250,4 @@

#### Defined in

[src/models/File.ts:21](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/models/File.ts#L21)
[src/models/File.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/models/File.ts#L23)
2 changes: 1 addition & 1 deletion docs/talawa-api-docs/REST/services/minio/functions/deleteFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ console.log(response);

## Defined in

[src/REST/services/minio/index.ts:114](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/minio/index.ts#L114)
[src/REST/services/minio/index.ts:114](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/minio/index.ts#L114)
2 changes: 1 addition & 1 deletion docs/talawa-api-docs/REST/services/minio/functions/uploadMedia.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ console.log(result);

## Defined in

[src/REST/services/minio/index.ts:43](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/minio/index.ts#L43)
[src/REST/services/minio/index.ts:43](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/minio/index.ts#L43)
8 changes: 4 additions & 4 deletions docs/talawa-api-docs/REST/services/minio/interfaces/InterfaceUploadResult.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#### Defined in

[src/REST/services/minio/index.ts:17](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/minio/index.ts#L17)
[src/REST/services/minio/index.ts:17](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/minio/index.ts#L17)

***

Expand All @@ -24,7 +24,7 @@

#### Defined in

[src/REST/services/minio/index.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/minio/index.ts#L19)
[src/REST/services/minio/index.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/minio/index.ts#L19)

***

Expand All @@ -34,7 +34,7 @@

#### Defined in

[src/REST/services/minio/index.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/minio/index.ts#L20)
[src/REST/services/minio/index.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/minio/index.ts#L20)

***

Expand All @@ -44,4 +44,4 @@

#### Defined in

[src/REST/services/minio/index.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/services/minio/index.ts#L18)
[src/REST/services/minio/index.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/services/minio/index.ts#L18)
2 changes: 1 addition & 1 deletion docs/talawa-api-docs/REST/types/type-aliases/FileMimeType.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Allowed MIME types for files.

## Defined in

[src/REST/types/index.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/039b0f127fb8caa46d57186ab4b3bb27fe150903/src/REST/types/index.ts#L4)
[src/REST/types/index.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/3a5276aff43f5de4f7fab3ec9683a420dcdc7a06/src/REST/types/index.ts#L4)
Loading

0 comments on commit d9d8d29

Please sign in to comment.