Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/4.0.0/list-juz-recitation.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/4.0.0/random-verse.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

133 changes: 1 addition & 132 deletions docs/content_apis_versioned/4.0.0/sidebar.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/4.0.0/verses-by-verse-key.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/list-ayah-recitation.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/list-hizb-recitation.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/list-juz-recitation.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/list-manzil-recitation.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/list-page-recitation.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/list-ruku-recitation.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/quran-verses-by-script.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/random-verse.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/recitation-audio-files.api.mdx

Large diffs are not rendered by default.

133 changes: 1 addition & 132 deletions docs/content_apis_versioned/sidebar.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-chapter-number.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-hizb-number.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-juz-number.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-manzil-number.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-page-number.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-ruku-number.api.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/verses-by-verse-key.api.mdx

Large diffs are not rendered by default.

74 changes: 0 additions & 74 deletions docs/user_related_apis_versioned/1.0.0/add-a-comment.api.mdx

This file was deleted.

78 changes: 0 additions & 78 deletions docs/user_related_apis_versioned/1.0.0/add-a-post.api.mdx

This file was deleted.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/user_related_apis_versioned/1.0.0/add-collection.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

This file was deleted.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
id: comments-controller-success
title: "CommentsController_success"
description: "CommentsController_success"
sidebar_label: "CommentsController_success"
hide_title: true
hide_table_of_contents: true
api: {"operationId":"CommentsController_success","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["Comments"],"servers":[{"url":"https://apis-prelive.quran.foundation/quran-reflect","description":"Pre-production Server"},{"url":"https://apis.quran.foundation/quran-reflect","description":"Production Server"}],"description":"CommentsController_success","method":"get","path":"/v1/comments/{id}/delete","security":[{"x-auth-token":[],"x-client-id":[]}],"securitySchemes":{"x-auth-token":{"type":"apiKey","in":"header","name":"x-auth-token","description":"The JWT access token required for accessing the endpoints."},"x-client-id":{"type":"apiKey","in":"header","name":"x-client-id","description":"Your client id"}},"info":{"title":"User-related APIs","version":"1.0.0","description":"Quran.Foundation user-related APIs enable your app to seamlessly integrate with Quran.Foundation's user-centric features, providing access to personalized notes, bookmarks, goals, streaks, reading sessions, and more. This differentiates them from [content APIs](/docs/category/content-apis) that focus on non-user-specific resources like translations, tafsirs, and verses.\n\n ## How to get access \n\n We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to [get an access token](/docs/tutorials/oidc/getting-started-with-oauth2#obtaining-oauth-20-client-credentials) to make requests to our APIs. Then follow the steps mentioned [here](/docs/tutorials/oidc/getting-started-with-oauth2). \n\n ## Pagination \n\n We are using cursor based pagination. The pagination query params consist of `first`,`after`, `before` and `last`. \n\n Example \n - `first: 10` will give you first 10 items \n - `first: 10, after: xyz` will give you first 10 items after the item with id `xyz` \n - `last: 10` will give you the last 10 items \n - `last: 10, before: xyz` will give you the last 10 items before the item with id `xyz` \n\n The only possible combinations are `first + after` or `last + before`. They should not be used together"},"postman":{"name":"Comments Controller success","description":{"type":"text/plain"},"url":{"path":["v1","comments",":id","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: docs/user_related_apis_versioned/1.0.0/user-related-apis
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## CommentsController_success



CommentsController_success

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","required":true,"in":"path","schema":{"type":"number"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div></div><div></div></TabItem></ApiTabs></div>

Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: comments-controller-toggle-like
title: "Toggle like/unlike a comment"
description: "Toggle like/unlike a comment"
sidebar_label: "Toggle like/unlike a comment"
hide_title: true
hide_table_of_contents: true
api: {"operationId":"CommentsController_toggleLike","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the comment to like/unlike","schema":{"type":"number"}}],"responses":{"200":{"description":"Like status toggled successfully","content":{"application/json":{"schema":{"type":"object","properties":{"liked":{"type":"boolean","example":true}}}}}}},"tags":["Comments"],"servers":[{"url":"https://apis-prelive.quran.foundation/quran-reflect","description":"Pre-production Server"},{"url":"https://apis.quran.foundation/quran-reflect","description":"Production Server"}],"description":"Toggle like/unlike a comment","method":"post","path":"/v1/comments/{id}/toggle-like","security":[{"x-auth-token":[],"x-client-id":[]}],"securitySchemes":{"x-auth-token":{"type":"apiKey","in":"header","name":"x-auth-token","description":"The JWT access token required for accessing the endpoints."},"x-client-id":{"type":"apiKey","in":"header","name":"x-client-id","description":"Your client id"}},"info":{"title":"User-related APIs","version":"1.0.0","description":"Quran.Foundation user-related APIs enable your app to seamlessly integrate with Quran.Foundation's user-centric features, providing access to personalized notes, bookmarks, goals, streaks, reading sessions, and more. This differentiates them from [content APIs](/docs/category/content-apis) that focus on non-user-specific resources like translations, tafsirs, and verses.\n\n ## How to get access \n\n We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to [get an access token](/docs/tutorials/oidc/getting-started-with-oauth2#obtaining-oauth-20-client-credentials) to make requests to our APIs. Then follow the steps mentioned [here](/docs/tutorials/oidc/getting-started-with-oauth2). \n\n ## Pagination \n\n We are using cursor based pagination. The pagination query params consist of `first`,`after`, `before` and `last`. \n\n Example \n - `first: 10` will give you first 10 items \n - `first: 10, after: xyz` will give you first 10 items after the item with id `xyz` \n - `last: 10` will give you the last 10 items \n - `last: 10, before: xyz` will give you the last 10 items before the item with id `xyz` \n\n The only possible combinations are `first + after` or `last + before`. They should not be used together"},"postman":{"name":"Toggle like/unlike a comment","description":{"type":"text/plain"},"url":{"path":["v1","comments",":id","toggle-like"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the comment to like/unlike","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}}
sidebar_class_name: "post api-method"
info_path: docs/user_related_apis_versioned/1.0.0/user-related-apis
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Toggle like/unlike a comment



Toggle like/unlike a comment

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","required":true,"in":"path","description":"ID of the comment to like/unlike","schema":{"type":"number"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Like status toggled successfully

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"liked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"liked\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>

4 changes: 2 additions & 2 deletions docs/user_related_apis_versioned/1.0.0/create-a-goal.api.mdx

Large diffs are not rendered by default.

Loading