Skip to main content

Swagger File | Devise Token Auth

on

openapi: 3.0.1
info:
title: API
consumes:
- application/json
produces:
- application/json
servers:
- url: http://localhost:3000

schemes:
- "https"
- "http"
paths:
"/auth":
post:
summary: User registration
requestBody:
content:
application/json:
schema:
$ref: "#/definitions/UserRegistrationParameters"
responses:
"200":
description: "Valid input"
content:
application/json:
example:
status: 'success'
data:
email: "testuser2@yopmail.com"
uid: "testuser2@yopmail.com"
first_name: "testuser2"
last_name: "lname"
role: "ABA Admin"
"422":
description: "Invalid input"
content:
application/json:
example:
status: 'error'
data:
uid: ""
first_name: "testuser2"
last_name: "lname"
email: "testuser2@yopmail.com"
role: "ABA Admin"
errors:
email: ["has already been taken"]
full_messages: ["Email has already been taken"]
put:
summary: User update
parameters:
- in: "header"
name: "access-token"
description: "Request headers"
required: true
- in: "header"
name: "client"
description: "Request headers"
required: true
- in: "header"
name: "uid"
description: "Request headers"
required: true
requestBody:
content:
application/json:
schema:
$ref: "#/definitions/UserUpdateParameters"
responses:
"200":
description: "Valid input"
content:
application/json:
example:
status: 'success'
data:
email: "testuser2@yopmail.com"
uid: "testuser2@yopmail.com"
first_name: "testuser2"
last_name: "lname"
role: "ABA Admin"
"404":
description: "Invalid input"
content:
application/json:
example:
success: false
errors: [
"User not found."
]
status: "error"

"/auth/sign_in":
post:
summary: User signin
requestBody:
content:
application/json:
schema:
$ref: "#/definitions/UserSigninParameters"
responses:
"200":
description: "Valid input"
content:
application/json:
example:
data:
email: "user1@yopmail.com"
uid: "user1@yopmail.com"
name: "Mike Tyson"
"401":
description: "Invalid input"
content:
application/json:
example:
success: false
errors: ["Invalid login credentials. Please try again."]

"/auth/sign_out":
delete:
summary: User signout
parameters:
- in: "header"
name: "access-token"
description: "Request headers"
required: true
- in: "header"
name: "client"
description: "Request headers"
required: true
- in: "header"
name: "uid"
description: "Request headers"
required: true
responses:
"200":
description: "Valid input"
content:
application/json:
example:
success: true
"404":
description: "Invalid input"
content:
application/json:
example:
success: false
errors: ["User was not found or was not logged in."]

"/auth/password":
post:
summary: Password reset
requestBody:
content:
application/json:
schema:
$ref: "#/definitions/PasswordResetParameters"
responses:
"200":
description: "Valid input"
content:
application/json:
example:
success: true
message: "An email has been sent to 'user1@yopmail.com' containing instructions for resetting your password."
"404":
description: "Invalid input"
content:
application/json:
example:
success: false
errors: ["Unable to find user with email 'user1@yopmail.com1'."]
put:
summary: Password update
parameters:
- in: "header"
name: "access-token"
description: "Request headers"
required: true
- in: "header"
name: "client"
description: "Request headers"
required: true
- in: "header"
name: "uid"
description: "Request headers"
required: true
requestBody:
content:
application/json:
schema:
$ref: "#/definitions/PasswordUpdateParameters"

responses:
"200":
description: "Valid input"
content:
application/json:
example:
success: true
data:
email: "user@yopmail.com"
uid: "user@yopmail.com"
name: "Mike Tyson"
message: "Your password has been successfully updated."
"401":
description: "Invalid input"
content:
application/json:
example:
success: false
errors: ["Unauthorized"]

definitions:
UserRegistrationParameters:
type: "object"
required:
- email
- password
properties:
email:
type: "string"
password:
type: "string"

UserUpdateParameters:
type: "object"
required:
- email
properties:
email:
type: "string"

UserSigninParameters:
type: "object"
required:
- email
- password
properties:
email:
type: "string"
password:
type: "string"
PasswordResetParameters:
type: "object"
required:
- email
- redirect_url
properties:
email:
type: "string"
redirect_url:
type: "string"
description: 'for redirection, after password change'
PasswordUpdateParameters:
type: "object"
required:
- password
- password_confirmation
- current_password
properties:
password:
type: "string"
password_confirmation:
type: "string"
description: 'should be same as password'
current_password:
type: "string"
PasswordUpdateHeaders:
type: "object"
required:
- access-token
- client
- uid
properties:
access-token:
type: "string"
client:
type: "string"
uid:
type: "string"
UserSignoutHeaders:
type: "object"
required:
- access-token
- client
- uid
properties:
access-token:
type: "string"
client:
type: "string"
uid:
type: "string"

Comments

Post a Comment

suggestions

Popular posts from this blog

Why "F" and "L" suffix | (10.0F, 10L)

on
Let us take it this way, We will create their needs. So we will get why they are needed. Try to guess, which functions will be executed in the following program: public class MyClass {     public static void main(String args[]) {         MyClass obj = new MyClass();         obj.fun1(10);     }     void fun1(byte val){         System.out.println(val);     }     void fun1(int val){         System.out.println(val);     }     void fun1(float val){         System.out.println(val);     }     void fun1(long val){         System.out.println(val);     }     } It seems like every method is capable to run this program because 10 is still literal because It has no data type. Before Java, In previous technologies, this scenario gave an ambiguity error. But Java solves this problem by removing the concepts of literals. It means Java provide a data type immediately when these born. So here 10 is no more literal. Java provides Integer data type for it. So now it is of Integer t
7 comments
Read more

only large files upload on S3 | Ruby On Rails

on
models/attachment.rb class Attachment < ApplicationRecord after_initialize :set_storage private def set_storage # larger that 5mb file would be upload on s3 if file . blob . byte_size > 5_000_000 Rails . application . config . active_storage . service = :amazon else Rails . application . config . active_storage . service = :local end end # end of private end
Post a Comment
Read more

Typecasting | How is Long to Float Conversion possible?

on
We will take a brief description of Typecasting and will try to do focus on Log to Float Conversion. Typecasting: Assigning a value of one data type to another. When we assign a value of smaller data type to a bigger one. it is called Widening. Java did this conversion automatically as they are compatible. As shown in the following figure: One another kind of conversion, when automatic conversion not possible i.e. when they are not compatible is Shortening. It will be just opposite of above and diagram will be reversed. How is Long to Float Conversion possible? If we look carefully at the diagram, there is one conversion which looks questionable is Long(8 bytes) to Float(4 bytes) conversion. It looks like data lossy conversion. Actually, Type conversion does two things: Either change in range or change in behavior or both. Change in Range: short a = 3456 // this value can be varied within the range of -32768 to 32767 int b = a // now this value can be varied wi
4 comments
Read more