Documentation Powered by Redocly

カルタグラフ (0.0.1)

Download OpenAPI specification:Download

URL: https://kotatool.vercel.app/ License: MIT

カルタグラフ用API

Authentication

OAuth2

For more information, see https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://{{OutputDomainPrefix}}.auth.ap-northeast-1.amazoncognito.com/oauth2/authorize
Token URL: https://{{OutputDomainPrefix}}.auth.ap-northeast-1.amazoncognito.com/oauth2/token
Scopes:
  • openid -

    openid token

user

get user list

description

query Parameters
page
integer

page number

per_page
integer

number of items per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_info": {
    }
}

create new user

description

Request Body schema: application/json

user information

required
object

user information

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "email": "user@example.com",
  • "name": "A"
}

get user

description

path Parameters
user_id
required
integer

user id

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "email": "user@example.com",
  • "name": "A"
}

update user

description

path Parameters
user_id
required
integer

user id

Request Body schema: application/json

user information

required
object

user information

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "email": "user@example.com",
  • "name": "A"
}

delete user

description

path Parameters
user_id
required
integer

user id

Responses

scenarios

Authorizations:
OAuth2 (
  • openid
  • token
)

Responses

Response samples

Content type
application/json
{
  • "scenarios": [
    ]
}

logs

Request Body schema: application/json

user information

uid
required
string
id
required
string
title
string
text
string
exLinks
string
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "uid": "string",
  • "id": "string",
  • "title": "string",
  • "text": "string",
  • "exLinks": "string",
  • "links": [
    ]
}

logs

Request Body schema: application/json

user information

uid
required
string
id
required
string
title
string
text
string
exLinks
string
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "uid": "string",
  • "id": "string",
  • "title": "string",
  • "text": "string",
  • "exLinks": "string",
  • "links": [
    ]
}