-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d56f54a
commit 02a6ad8
Showing
23 changed files
with
195 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,7 +17,6 @@ | |
padding: 0; | ||
} | ||
</style> | ||
{{{redocHead}}} | ||
</head> | ||
<body> | ||
<redoc spec-url='dist.json'></redoc> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,80 +1,66 @@ | ||
openapi: 3.1.0 | ||
info: | ||
title: PuppyLove2.0_Backend | ||
description: API Documentation for PuppyLove2.0_Backend [Github](https://github.com/pclubiitk/puppylove2.0_backend) | ||
version: 1.0.0 | ||
title: Example.com | ||
termsOfService: https://example.com/terms/ | ||
contact: | ||
email: [email protected] | ||
url: http://example.com/contact | ||
license: | ||
name: Apache 2.0 | ||
url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
url: https://pclub.in/ | ||
x-logo: | ||
url: https://redocly.github.io/openapi-template/logo.png | ||
description: > | ||
This is an **example** API to demonstrate features of the OpenAPI | ||
specification. | ||
url: https://pclub.in/images/pclub.png | ||
|
||
# Introduction | ||
This API definition is intended to to be a good starting point for | ||
describing your API in [OpenAPI/Swagger | ||
format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md). | ||
It also demonstrates features of the | ||
[create-openapi-repo](https://github.com/Redocly/create-openapi-repo) tool | ||
and the [Redoc](https://github.com/Redocly/Redoc) documentation engine. Beyond | ||
the standard OpenAPI syntax, we use a few | ||
[vendor extensions](https://github.com/Redocly/Redoc/blob/master/docs/redoc-vendor-extensions.md). | ||
# OpenAPI Specification | ||
The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which | ||
allows both humans and computers to discover and understand the capabilities | ||
of the service without access to source | ||
code, documentation, or through network traffic inspection. When properly | ||
defined via OpenAPI, a consumer can | ||
understand and interact with the remote service with a minimal amount of | ||
implementation logic. Similar to what | ||
interfaces have done for lower-level programming, OpenAPI removes the | ||
guesswork in calling the service. | ||
tags: | ||
- name: Echo | ||
description: Example echo operations. | ||
- name: Session | ||
description: Endpoints for Session Login and Logout. | ||
- name: User | ||
description: Operations about users. | ||
- name: Tag | ||
description: This is a tag description. | ||
servers: | ||
- url: https://{tenant}/api/v1 | ||
variables: | ||
tenant: | ||
default: www | ||
description: Your tenant id | ||
- url: https://example.com/api/v1 | ||
description: Endpoints for Users. | ||
- name: Admin | ||
description: Endpoints for Admin Use. | ||
- name: Fetch | ||
description: Endpoints for Fetching Tabular Data Fields for all users. | ||
- name: Send | ||
description: Endpoints for user to insert data in DB. | ||
- name: Verify | ||
description: Enpoints for user to verify claims about data in DB. | ||
paths: | ||
/users/{username}: | ||
$ref: paths/users_{username}.yaml | ||
/echo: | ||
$ref: paths/echo.yaml | ||
/pathItem: | ||
$ref: paths/pathItem.yaml | ||
/pathItemWithExamples: | ||
$ref: paths/pathItemWithExamples.yaml | ||
components: | ||
securitySchemes: | ||
main_auth: | ||
type: oauth2 | ||
flows: | ||
implicit: | ||
authorizationUrl: http://example.com/api/oauth/dialog | ||
scopes: | ||
read:users: read users info | ||
write:users: modify or remove users | ||
api_key: | ||
type: apiKey | ||
in: header | ||
name: api_key | ||
basic_auth: | ||
type: http | ||
scheme: basic | ||
/users/mail:id: | ||
$ref: paths/users/mail:id.yaml | ||
/users/login/first: | ||
$ref: paths/users/login/first.yaml | ||
/session/login: | ||
$ref: paths/session/login.yaml | ||
/session/logout: | ||
$ref: paths/session/logout.yaml | ||
/session/admin/login: | ||
$ref: paths/session/admin/login.yaml | ||
/admin/user/deleteallusers: | ||
$ref: paths/admin/user/deleteallusers.yaml | ||
/admin/user/new: | ||
$ref: paths/admin/user/new.yaml | ||
/admin/user/delete: | ||
$ref: paths/admin/user/delete.yaml | ||
/admin/publish: | ||
$ref: paths/admin/publish.yaml | ||
/users/activeusers: | ||
$ref: paths/users/activeusers.yaml | ||
/users/fetchPublicKeys: | ||
$ref: paths/users/fetchPublicKeys.yaml | ||
/users/fetchall: | ||
$ref: paths/users/fetchall.yaml | ||
/users/fetchReturnHearts: | ||
$ref: paths/users/fetchReturnHearts.yaml | ||
/users/sendheartVirtual: | ||
$ref: paths/users/sendheartVirtual.yaml | ||
/users/sendheart: | ||
$ref: paths/users/sendheart.yaml | ||
/users/claimheart: | ||
$ref: paths/users/claimheart.yaml | ||
/users/verifyreturnhearts: | ||
$ref: paths/users/verifyreturnhearts.yaml | ||
/users/sentHeartDecoded: | ||
$ref: paths/users/sentHeartDecoded.yaml | ||
/users/special/returnclaimedheartlate: | ||
$ref: paths/users/special/returnclaimedheartlate.yaml | ||
/users/publish: | ||
$ref: paths/users/publish.yaml | ||
/users/mymatches: | ||
$ref: paths/users/mymatches.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
get: | ||
tags: | ||
- Admin | ||
summary: Publish Results | ||
description: Receive the exact message you've sent | ||
operationId: publish |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- Admin | ||
summary: Delete User | ||
description: Receive the exact message you've sent | ||
operationId: delete |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
get: | ||
tags: | ||
- Admin | ||
summary: Delete All Users | ||
description: Receive the exact message you've sent | ||
operationId: deleteAll |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- Admin | ||
summary: Add New Users | ||
description: Receive the exact message you've sent | ||
operationId: newUsers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
post: | ||
tags: | ||
- Admin | ||
- Session | ||
summary: Admin Login | ||
description: Receive the exact message you've sent | ||
operationId: adminLogin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
post: | ||
tags: | ||
- User | ||
- Session | ||
summary: User Login | ||
description: Receive the exact message you've sent | ||
operationId: userLogin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
get: | ||
tags: | ||
- User | ||
- Session | ||
- Admin | ||
summary: Logout | ||
description: Receive the exact message you've sent | ||
operationId: Logout |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
get: | ||
tags: | ||
- User | ||
- Fetch | ||
summary: Fetch All Active Users | ||
description: Receive the exact message you've sent | ||
operationId: activeUsers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
post: | ||
tags: | ||
- User | ||
- Verify | ||
summary: Claim from send_hearts Table | ||
description: Receive the exact message you've sent | ||
operationId: claimHeart |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
get: | ||
tags: | ||
- User | ||
- Fetch | ||
summary: Fetch Public Keys | ||
description: Receive the exact message you've sent | ||
operationId: fetchKeys |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
get: | ||
tags: | ||
- User | ||
- Fetch | ||
summary: Fetch return_hearts Table | ||
description: Receive the exact message you've sent | ||
operationId: fetchReturnHearts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
get: | ||
tags: | ||
- User | ||
- Fetch | ||
summary: Fetch send_hearts Table | ||
description: Receive the exact message you've sent | ||
operationId: fetchAll |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- User | ||
summary: Register User | ||
description: Receive the exact message you've sent | ||
operationId: register |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- User | ||
summary: Mail Authentication Code | ||
description: Receive the exact message you've sent | ||
operationId: mail |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
get: | ||
tags: | ||
- User | ||
summary: Matching Results | ||
description: Receive the exact message you've sent | ||
operationId: results |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- User | ||
summary: User Permission to Publish his/her result | ||
description: Receive the exact message you've sent | ||
operationId: permisssion |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
post: | ||
tags: | ||
- User | ||
- Send | ||
summary: Send Hearts | ||
description: Receive the exact message you've sent | ||
operationId: sendHearts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
post: | ||
tags: | ||
- User | ||
- Send | ||
summary: Save User Selections | ||
description: Receive the exact message you've sent | ||
operationId: sendHeartsVirtual |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- User | ||
summary: Gender Wise Heart Count | ||
description: Receive the exact message you've sent | ||
operationId: heartCount |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
post: | ||
tags: | ||
- User | ||
summary: Returning claim in return_hearts Table | ||
description: Receive the exact message you've sent | ||
operationId: late |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
post: | ||
tags: | ||
- User | ||
- Verify | ||
summary: Matching | ||
description: Receive the exact message you've sent | ||
operationId: matching |