Rails Blueprint Pro API (v1)

Download OpenAPI specification:

Rails Blueprint Pro provides a comprehensive API for managing posts, users, settings, and pages with JWT authentication and JSON:API format.

Authentication

Login user

Authenticate user and receive JWT tokens

Request Body schema: application/json

grant_type required	string Default: "password" Enum: "password" "refresh_token"
email	string <email>
password	string
refresh_token	string Required when grant_type is refresh_token

Responses

Response Schema: application/vnd.api+json

	object
	object

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "password123",
"grant_type": "password",
"refresh_token": "string"
}

Response samples

200
400
401

Content type

application/vnd.api+json

{"data": {"id": "string",
"type": "auth_token",
"attributes": {"access_token": "string",
"refresh_token": "string",
"expires_in": 0,
"refresh_expires_in": 0,
"token_type": "Bearer"
}
},
"meta": {"message": "string"
}
}

Logout user

Invalidate the current API session

Authorizations:

bearer_auth

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

data	object or null
	object

Response samples

200
401

Content type

application/vnd.api+json

{"data": { },
"meta": {"message": "string"
}
}

Posts

List posts

Get a paginated list of posts

Authorizations:

bearer_auth

query Parameters

page[after]	string Cursor for pagination (after this cursor)
page[before]	string Cursor for reverse pagination (before this cursor)
page[size]	integer Page size (max 100, default 25)
q	string Search query
include	string Include related resources (e.g., user)

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

	Array of objects
	object
	object

Response samples

200
401

Content type

application/vnd.api+json

{"data": [{"id": "string",
"type": "post",
"attributes": {"title": "string",
"slug": "string",
"body": "string",
"excerpt": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"relationships": {"user": {"data": {"id": "string",
"type": "string"
}
}
}
}
],
"meta": {"page_size": 0,
"has_next_page": true,
"has_previous_page": true,
"count": 0
},
"links": {"self": "string",
"next": "string",
"prev": "string"
}
}

Create post

Create a new post

Authorizations:

bearer_auth

header Parameters

Authorization

string

Bearer token

Request Body schema: application/vnd.api+json

required

object

Responses

Response Schema: application/vnd.api+json

	object
	object

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "posts",
"attributes": {"title": "string",
"body": "string"
}
}
}

Response samples

201
422

Content type

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"title": "string",
"slug": "string",
"body": "string"
}
},
"meta": {"message": "string"
}
}

Show post

Get a specific post

Authorizations:

bearer_auth

path Parameters

id

required

string

Post ID

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

object

Response samples

200
404

Content type

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": { }
}
}

Update post

Update a post

Authorizations:

bearer_auth

path Parameters

id

required

string

Post ID

header Parameters

Authorization

string

Bearer token

Request Body schema: application/vnd.api+json

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "posts",
"id": "string",
"attributes": {"title": "string",
"body": "string"
}
}
}

Response samples

403

Content type

application/vnd.api+json

{"errors": [{"status": "string",
"code": "string",
"title": "string",
"detail": "string"
}
]
}

Delete post

Delete a post

Authorizations:

bearer_auth

path Parameters

id

required

string

Post ID

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

data	object or null
	object

Response samples

200
403

Content type

application/vnd.api+json

{"data": { },
"meta": {"message": "string"
}
}

Settings

List settings

Get all application settings (admin only)

Authorizations:

bearer_auth

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

Array of objects

Response samples

200
403

Content type

application/vnd.api+json

{"data": [{"id": "string",
"type": "setting",
"attributes": {"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
]
}

Update settings

Update multiple settings at once (admin only)

Authorizations:

bearer_auth

header Parameters

Authorization

string

Bearer token

Request Body schema: application/vnd.api+json

required

Array of objects

Responses

Response Schema: application/vnd.api+json

	Array of objects
	object

Request samples

Payload

Content type

application/vnd.api+json

{"data": [{"type": "settings",
"attributes": {"key": "string",
"value": "string"
}
}
]
}

Response samples

200
422

Content type

application/vnd.api+json

{"data": [{"id": "string",
"type": "string",
"attributes": {"key": "string",
"value": "string"
}
}
],
"meta": {"message": "string"
}
}

Show setting

Get a specific setting by key (admin only)

Authorizations:

bearer_auth

path Parameters

key

required

string

Setting key

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

object

Response samples

200
404

Content type

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"key": "string",
"value": "string"
}
}
}

Update setting

Update a specific setting by key (admin only)

Authorizations:

bearer_auth

path Parameters

key

required

string

Setting key

header Parameters

Authorization

string

Bearer token

Request Body schema: application/vnd.api+json

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "settings",
"attributes": {"value": "string"
}
}
}

Response samples

404

Content type

application/vnd.api+json

{"errors": [{"status": "string",
"code": "string",
"title": "string",
"detail": "string"
}
]
}

Users

List users

Get a paginated list of users (admin only)

Authorizations:

bearer_auth

query Parameters

page[after]	string Cursor for pagination (after this cursor)
page[before]	string Cursor for reverse pagination (before this cursor)
page[size]	integer Page size (max 100, default 25)
q	string Search query

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

	Array of objects
	object
	object

Response samples

200
401

Content type

application/vnd.api+json

{"data": [{"id": "string",
"type": "user",
"attributes": {"email": "string",
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
],
"meta": {"page_size": 0,
"has_next_page": true,
"has_previous_page": true,
"count": 0
},
"links": {"self": "string",
"next": "string",
"prev": "string"
}
}

Create user

Create a new user (admin only)

Authorizations:

bearer_auth

header Parameters

Authorization

string

Bearer token

Request Body schema: application/vnd.api+json

required

object

Responses

Response Schema: application/vnd.api+json

	object
	object

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "users",
"attributes": {"email": "user@example.com",
"password": "string",
"password_confirmation": "string",
"name": "string"
}
}
}

Response samples

201
422

Content type

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"email": "string",
"name": "string"
}
},
"meta": {"message": "string"
}
}

Show user

Get a specific user (admin only)

Authorizations:

bearer_auth

path Parameters

id

required

string

User ID

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

object

Response samples

200
404

Content type

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"email": "string",
"name": "string"
}
}
}

Update user

Update a user (admin only)

Authorizations:

bearer_auth

path Parameters

id

required

string

User ID

header Parameters

Authorization

string

Bearer token

Request Body schema: application/vnd.api+json

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "users",
"id": "string",
"attributes": {"email": "user@example.com",
"name": "string",
"password": "string",
"password_confirmation": "string"
}
}
}

Response samples

403

Content type

application/vnd.api+json

{"errors": [{"status": "string",
"code": "string",
"title": "string",
"detail": "string"
}
]
}

Delete user

Delete a user (admin only)

Authorizations:

bearer_auth

path Parameters

id

required

string

User ID

header Parameters

Authorization

string

Bearer token

Responses

Response Schema: application/vnd.api+json

data	object or null
	object

Response samples

200
403

Content type

application/vnd.api+json

{"data": { },
"meta": {"message": "string"
}
}