API docs by Redocly

dashi-server (0.0.1)

Download OpenAPI specification:Download

Myxogastria0808: r.rstudio.c@gmail.com URL: https://yukiosada.work License: WTFPL

This is a dashi-server API document.

Item

物品に関係するエンドポイント

delete_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

image_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Request Body schema: multipart/form-data

ImageItemMultipartData

image
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

register_handler

Authorizations:
jwt_token
Request Body schema: multipart/form-data

RegisterItemMultipartData

color
required
string
connector
required
string
description
required
string
durability
string or null
image
required
string <binary>
is_depreciation
required
string
name
required
string
parent_visible_id
required
string
product_number
required
string
purchase_price
string or null
purchase_year
string or null
visible_id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

search_handler

Authorizations:
jwt_token
query Parameters
keywords
required
any

set search word

Responses

Response samples

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

transfer_handler

Authorizations:
jwt_token
Request Body schema: application/json

TransferItemData

id
required
integer <int32>
new_parent_id
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "new_parent_id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

trash_handler

Authorizations:
jwt_token

Responses

Response samples

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

update_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Request Body schema: application/json

UpdateItemDataJson

color
required
string
connector
required
Array of strings
description
required
string
durability
integer or null <int32>
is_depreciation
required
boolean
name
required
string
product_number
required
string
purchase_price
integer or null <int32>
purchase_year
integer or null <int32>
visible_id
required
string

Responses

Request samples

Content type
application/json
{
  • "color": "string",
  • "connector": [
    ],
  • "description": "string",
  • "durability": 0,
  • "is_depreciation": true,
  • "name": "string",
  • "product_number": "string",
  • "purchase_price": 0,
  • "purchase_year": 0,
  • "visible_id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

individual_item_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Responses

Response samples

Content type
application/json
{
  • "color": "string",
  • "connector": null,
  • "created_at": "string",
  • "description": "string",
  • "durability": 0,
  • "id": 0,
  • "is_depreciation": true,
  • "is_rent": true,
  • "latest_rent_at": "string",
  • "latest_replace_at": "string",
  • "name": "string",
  • "parent_id": 0,
  • "parent_visible_id": "string",
  • "product_number": "string",
  • "purchase_price": 0,
  • "purchase_year": 0,
  • "recipient": "string",
  • "record": "Qr",
  • "rental_description": "string",
  • "scheduled_replace_at": "string",
  • "updated_at": "string",
  • "visible_id": "string"
}

Csv

csv出力に関するエンドポイント

depreiation_handler

Authorizations:
jwt_token

Responses

Response samples

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

item_handler

Authorizations:
jwt_token

Responses

Response samples

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

Rental

レンタルに関係するエンドポイント

all_rental_items_handler

Authorizations:
jwt_token

Responses

Response samples

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

rent_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Request Body schema: application/json

RentalData

id
required
integer <int32>
recipient
required
string
rental_description
required
string
scheduled_replace_at
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "recipient": "string",
  • "rental_description": "string",
  • "scheduled_replace_at": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

replace_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

update_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set item id (not visible id)

Request Body schema: application/json

RentalData

id
required
integer <int32>
recipient
required
string
rental_description
required
string
scheduled_replace_at
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "recipient": "string",
  • "rental_description": "string",
  • "scheduled_replace_at": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Generate

QRまたはBarcodeを生成するエンドポイント

generate_handler

Authorizations:
jwt_token
Request Body schema: application/json

GenerateDataRequest

quantity
required
integer <int32> >= 0
record
required
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "record": "string"
}

Response samples

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

Connector

接続端子に関係するエンドポイント

all_connectors_handler

Authorizations:
jwt_token

Responses

Response samples

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

register_handler

Authorizations:
jwt_token
Request Body schema: application/json

RegisterConnectorData

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

search_handler

Authorizations:
jwt_token
query Parameters
keywords
required
any

set search word

Responses

Response samples

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

status_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set connector id (not name)

Request Body schema: application/json
id
required
integer <int32>
status
required
string (Status)
Enum: "Active" "Archive"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "status": "Active"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Color

ケーブルに貼るテープに関係するエンドポイント

all_colors_handler

Authorizations:
jwt_token

Responses

Response samples

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

register_handler

Authorizations:
jwt_token
Request Body schema: application/json

RegisterColorData

hex_color_code
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "hex_color_code": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

search_handler

Authorizations:
jwt_token
query Parameters
keywords
required
any

set search word

Responses

Response samples

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

update_handler

Authorizations:
jwt_token
path Parameters
id
required
integer <int32> >= 0

set color id (not name)

Request Body schema: application/json
hex_color_code
required
string
id
required
integer <int32>
status
required
string (Status)
Enum: "Active" "Archive"

Responses

Request samples

Content type
application/json
{
  • "hex_color_code": "string",
  • "id": 0,
  • "status": "Active"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Health Check

Health Checkのエンドポイント

healthcheck_handler

Authorizations:
jwt_token

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Ping

pingを送るエンドポイント

ping_handler

Authorizations:
jwt_token

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Joke

特殊なステータスコードを返すエンドポイント

teapot_handler

Authorizations:
jwt_token

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

unavailable_handler

Authorizations:
jwt_token

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}