Skip to content

Make operationId consistent #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Make operationId consistent #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae65173
fix typo, add editorconfig, format user-related-apis
Aug 29, 2025
9a27b4e
make operationIds consistent
Aug 29, 2025
a196113
fix path parameters
Aug 29, 2025
de8b24b
make collectionId path parameter required
Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[*.json]
indent_style = space
indent_size = 2
70 changes: 35 additions & 35 deletions openAPI/content/v4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
"tags": ["Chapters"],
"summary": "List Chapters",
"description": "Get list of Chapter.",
"operationId": "list-chapters",
"operationId": "chapters",
"parameters": [
{
"name": "language",
Expand Down Expand Up @@ -239,7 +239,7 @@
"tags": ["Chapters"],
"summary": "Get Chapter",
"description": "Get details of a single Chapter.",
"operationId": "GET-chapter",
"operationId": "chapter",
"parameters": [
{
"name": "id",
Expand Down Expand Up @@ -312,7 +312,7 @@
"tags": ["Chapters"],
"summary": "Get Chapter Info",
"description": "Get Chapter Info in specific language. Default to `English`.",
"operationId": "info",
"operationId": "chapter-info",
"parameters": [
{
"name": "chapter_id",
Expand Down Expand Up @@ -1713,7 +1713,7 @@
"tags": ["Quran"],
"summary": "Get Indopak Script of ayah",
"description": "Get Indopak script of ayah. Use query strings to filter results, leave all query string blank if you want to fetch Indopak script of whole Quran.",
"operationId": "QURAN-verses-indopak",
"operationId": "quran-verses-indopak",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -1831,7 +1831,7 @@
"tags": ["Quran"],
"summary": "Get Uthmani Tajweed Script of ayah",
"description": "Get Uthmani color coded tajweed text of ayah. Tajweed rules are embedded in text as `tajweed` html tags.",
"operationId": "QURAN-verses-uthmani-tajweed",
"operationId": "quran-verses-uthmani_tajweed",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -1949,7 +1949,7 @@
"tags": ["Quran"],
"summary": "Get Uthmani Script of ayah",
"description": "Get Uthmani script of ayah. Use query strings to filter results, leave all query string blank if you want to fetch Uthmani script of whole Quran.",
"operationId": "QURAN-verses-uthmani",
"operationId": "quran-verses-uthmani",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -2067,7 +2067,7 @@
"tags": ["Quran"],
"summary": "Get Uthmani simple script of ayah",
"description": "Get Uthmani simple script(without tashkiq/diacritical marks) of ayah. Use query strings to filter results, leave all query string blank if you want to fetch script of whole Quran.",
"operationId": "QURAN-verses-uthmani_simple",
"operationId": "quran-verses-uthmani_simple",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -2185,7 +2185,7 @@
"tags": ["Quran"],
"summary": "Get Imlaei Simple text of ayah",
"description": "Get Imlaei simple script(without tashkiq/diacritical marks) of ayah.",
"operationId": "QURAN-verses-Imlaei",
"operationId": "quran-verses-imlaei",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -2869,7 +2869,7 @@
"tags": ["Quran"],
"summary": "Get V1 Glyph codes of ayah",
"description": "Get glyph codes of ayah for QCF v1 font",
"operationId": "QURAN-verses-code_v1",
"operationId": "quran-verses-code_v1",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -2995,7 +2995,7 @@
"tags": ["Quran"],
"summary": "Get V2 Glyph codes of ayah",
"description": "Get glyph codes of ayah for QCF v2 font",
"operationId": "QURAN-verses-code_v2",
"operationId": "quran-verses-code_v2",
"parameters": [
{
"name": "chapter_number",
Expand Down Expand Up @@ -3122,7 +3122,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Surah",
"description": "Get list of ayah AudioFile for a Surah.",
"operationId": "list-surah-recitation",
"operationId": "chapter-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -3207,7 +3207,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Juz",
"description": "Get list of ayah AudioFile for a juz.",
"operationId": "list-juz-recitation",
"operationId": "juz-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -3293,7 +3293,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Madani Mushaf page",
"description": "Get list of ayah AudioFile for a Madani Mushaf page.",
"operationId": "list-page-recitation",
"operationId": "page-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -3379,7 +3379,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Rub el Hizb",
"description": "Get list of ayah AudioFile for a Rub el Hizb.",
"operationId": "list-rub-el-hizb-recitation",
"operationId": "rub-el-hizb-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -3465,7 +3465,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Hizb",
"description": "Get list of ayah AudioFile for a Hizb.",
"operationId": "list-hizb-recitation",
"operationId": "hizb-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -3551,7 +3551,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Ayah",
"description": "Get list of ayah AudioFile for a specific Ayah.",
"operationId": "list-ayah-recitation",
"operationId": "ayah-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -4009,7 +4009,7 @@
"tags": ["Resources"],
"summary": "Chapter Infos",
"description": "Get list of chapter info we've in different languages.",
"operationId": "chapter-info",
"operationId": "chapter-infos",
"responses": {
"200": {
"description": "Successful response",
Expand Down Expand Up @@ -4219,7 +4219,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Manzil",
"description": "Get list of ayah recitations for a Manzil.",
"operationId": "list-manzil-recitation",
"operationId": "manzil-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -4297,7 +4297,7 @@
"tags": ["Audio"],
"summary": "Get Ayah recitations for specific Ruku",
"description": "Get list of ayah recitations for a Ruku.",
"operationId": "list-ruku-recitation",
"operationId": "ruku-recitations",
"parameters": [
{
"name": "recitation_id",
Expand Down Expand Up @@ -4375,7 +4375,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Surah",
"description": "Get list of translations for a specific Surah.",
"operationId": "list-surah-translations",
"operationId": "chapter-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4446,7 +4446,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Madani Mushaf page",
"description": "Get list of translations for a specific Madani Mushaf page.",
"operationId": "list-page-translations",
"operationId": "page-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4508,7 +4508,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Juz",
"description": "Get list of translations for a specific Juz.",
"operationId": "list-juz-translations",
"operationId": "juz-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4570,7 +4570,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Rub el Hizb",
"description": "Get list of translations for a specific Rub el Hizb.",
"operationId": "list-rub-el-hizb-translations",
"operationId": "rub-el-hizb-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4632,7 +4632,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Hizb",
"description": "Get list of translations for a specific Hizb.",
"operationId": "list-hizb-translations",
"operationId": "hizb-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4694,7 +4694,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Manzil",
"description": "Get list of translations for a specific Manzil.",
"operationId": "list-manzil-translations",
"operationId": "manzil-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4756,7 +4756,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Ruku",
"description": "Get list of translations for a specific Ruku.",
"operationId": "list-ruku-translations",
"operationId": "ruku-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4818,7 +4818,7 @@
"tags": ["Translations"],
"summary": "Get translations for specific Ayah",
"description": "Get list of translations for a specific Ayah.",
"operationId": "list-ayah-translations",
"operationId": "ayah-translations",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4876,7 +4876,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Surah",
"description": "Get list of tafsirs for a specific Surah.",
"operationId": "list-surah-tafsirs",
"operationId": "chapter-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -4947,7 +4947,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Madani Mushaf page",
"description": "Get list of tafsirs for a specific Madani Mushaf page.",
"operationId": "list-page-tafsirs",
"operationId": "page-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -5009,7 +5009,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Juz",
"description": "Get list of tafsirs for a specific Juz.",
"operationId": "list-juz-tafsirs",
"operationId": "juz-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -5071,7 +5071,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Rub el Hizb",
"description": "Get list of tafsirs for a specific Rub el Hizb.",
"operationId": "list-rub-el-hizb-tafsirs",
"operationId": "rub-el-hizb-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -5133,7 +5133,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Hizb",
"description": "Get list of tafsirs for a specific Hizb.",
"operationId": "list-hizb-tafsirs",
"operationId": "hizb-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -5195,7 +5195,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Manzil",
"description": "Get list of tafsirs for a specific Manzil.",
"operationId": "list-manzil-tafsirs",
"operationId": "manzil-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -5257,7 +5257,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Ruku",
"description": "Get list of tafsirs for a specific Ruku.",
"operationId": "list-ruku-tafsirs",
"operationId": "ruku-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down Expand Up @@ -5319,7 +5319,7 @@
"tags": ["Tafsirs"],
"summary": "Get tafsirs for specific Ayah",
"description": "Get list of tafsirs for a specific Ayah.",
"operationId": "list-ayah-tafsirs",
"operationId": "ayah-tafsirs",
"parameters": [
{
"name": "resource_id",
Expand Down
12 changes: 6 additions & 6 deletions openAPI/oauth2-apis/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
"type": "array"
},
"client_id": {
"description": "ID is aclient identifier for the OAuth 2.0 client that\nrequested this token.",
"description": "ID is a client identifier for the OAuth 2.0 client that\nrequested this token.",
"type": "string"
},
"exp": {
Expand Down Expand Up @@ -220,7 +220,7 @@
"post": {
"summary": "The OAuth 2.0 Token Endpoint",
"description": "This endpoint is used by your application to obtain an access token or a refresh token. It is used by all flows except for the Implicit Flow because in that case an access token is issued directly. \n\n1. In the Client Credentials Flow, the application authenticates using a set of credentials and then gets an access token.\n2. In the Authorization Code Flow, the application exchanges an authorization code for an access token.\n3. In the Refresh Token Flow, the application uses a refresh token to obtain a new access token.",
"operationId": "oauth2TokenExchange",
"operationId": "oauth2-token-exchange",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
Expand Down Expand Up @@ -330,7 +330,7 @@
"post": {
"summary": "Introspect OAuth2 Access and Refresh Tokens",
"description": "The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token\nis neither expired nor revoked. If a token is active, additional information on the token will be included. You can\nset additional data for a token by setting `session.access_token` during the consent flow.",
"operationId": "introspectOAuth2Token",
"operationId": "introspect-oauth2-token",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
Expand Down Expand Up @@ -387,7 +387,7 @@
"get": {
"summary": "OAuth 2.0 Authorize Endpoint",
"description": "This endpoint is used to start the authorization process. The client redirects the user to this endpoint to request authorization. The user will be prompted to log in and grant permission to the client application.\n\nUse open source libraries to perform OAuth 2.0 and OpenID Connect available for any programming language. You can find a list of libraries at https://oauth.net/code/\n\nFor now, you can only use grant_type `authorization_code` and `refresh_token` in the /oauth2/token endpoint",
"operationId": "oAuth2Authorize",
"operationId": "oauth2-authorize",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -466,7 +466,7 @@
"get": {
"summary": "OpenID Connect Userinfo",
"description": "This endpoint returns the payload of the ID Token, including `session.id_token` values, of\nthe provided OAuth 2.0 Access Token's consent request.\n\nIn the case of authentication error, a WWW-Authenticate header might be set in the response\nwith more information about the error. See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3)\nfor more details about header format.",
"operationId": "getOidcUserInfo",
"operationId": "get-oidc-user-info",
"responses": {
"200": {
"description": "Successful retrieval of user information",
Expand All @@ -493,7 +493,7 @@
"get": {
"summary": "OpenID Connect Logout",
"description": "This endpoint handles the user logout process in Quran.Foundation's OAuth2 & OpenID Connect system. When called, it:\n\n1. Ends the user's current session\n2. Revokes associated access and refresh tokens\n\nThe logout process follows the OpenID Connect specifications:\n- [Front-Channel Logout](https://openid.net/specs/openid-connect-frontchannel-1_0.html)\n- [Back-Channel Logout](https://openid.net/specs/openid-connect-backchannel-1_0.html)",
"operationId": "revokeOidcSession",
"operationId": "revoke-oidc-session",
"responses": {
"302": {
"$ref": "#/components/responses/emptyResponse",
Expand Down
19,676 changes: 19,675 additions & 1 deletion openAPI/user-related-apis/v1.json
View file
Open in desktop

Large diffs are not rendered by default.