Nishiki Web API (1.0.0)

Download OpenAPI specification:Download

Nishiki

user

user of Nishiki system

Create a new user

Request Body schema: application/json
required

name	string or null username. this name is not provided, the name will be set as a default value.
emailAddress required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"emailAddress": "string"
}

Get a user

path Parameters

userId

required

string

ID of user

Responses

Response samples

200

Content type

application/json

{"id": "679adc58-b03a-4fb6-993b-c72404087375",
"name": "John"
}

Update a user data

path Parameters

userId

required

string

ID of user

Request Body schema: application/json
required

name	string user's name

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Delete a user.

The groups and containers will be deleted as well if those are possessed by only this user..

path Parameters

userId

required

string

ID of user

Responses

auth

Get a User ID

The user is identified by the token.

Responses

Response samples

200

Content type

application/json

{"userId": "2dd6dd70-5b3a-4329-9b70-01fd18c4b23c"
}

container

Get a list of the user's container

The requesting user is identified by the token of request.

Responses

Response samples

200

Content type

application/json

{"containers": [{"id": "11111111-ee7b-4558-b8d5-371514e77bed",
"name": "Shared-house's Fridge",
"group": {"groupId": "a3kdifut-a520-c2cb-1be7-d90710691861",
"groupName": "Shared-house"
},
"foods": [{"id": "11111111-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "arugula",
"quantity": 500,
"category": "vegetables",
"unit": "g",
"expiry": "2023-12-10T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
},
{"id": "22222222-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "tomato",
"quantity": 5,
"category": "vegetables",
"unit": null,
"expiry": "2023-12-25T00:00:00.000Z",
"createdAt": "2023-12-04T00:00:00.000Z"
}
]
},
{"id": "22222222-ee7b-4558-b8d5-371514e77bed",
"name": "Family's Fridge",
"group": {"groupId": "c3a8df3e-a520-c2cb-1be7-d90710691861",
"groupName": "Tom's family"
},
"foods": [{"id": "33333333-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "onion",
"quantity": 3,
"category": "vegetables",
"unit": null,
"expiry": "2023-12-15T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
},
{"id": "44444444-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "chicken thigh",
"quantity": 0.5,
"category": "meat",
"unit": "kg",
"expiry": "2023-12-15T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
}
]
},
{"id": "33333333-ee7b-4558-b8d5-371514e77bed",
"name": "Camping Fridge",
"group": {"groupId": "c3a8df3e-a520-c2cb-1be7-d90710691861",
"groupName": "Tom's family"
},
"foods": [{"id": "55555555-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "Beef steak",
"quantity": 700,
"category": "meat",
"unit": "g",
"expiry": "2023-12-20T00:00:00.000Z",
"createdAt": "2023-12-03T00:00:00.000Z"
},
{"id": "66666666-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "Beer",
"quantity": 10,
"category": "beverage",
"unit": "can",
"expiry": "2024-03-15T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
},
{"id": "77777777-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "Red Wine",
"quantity": 3,
"category": "beverage",
"unit": "bottle",
"expiry": "2024-06-15T00:00:00.000Z",
"createdAt": "2023-12-03T00:00:00.000Z"
}
]
}
]
}

create a new container

Request Body schema: application/json
required

groupId	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"groupId": "groupId",
"name": "my-container"
}

Response samples

201

Content type

application/json

{"containerId": "containerId"
}

get a container information

path Parameters

containerId

required

string

ID of container

Responses

Response samples

200

Content type

application/json

{"id": "939a4c50-ee7b-4558-b8d5-371514e77bed",
"name": "Shared-house's Fridge",
"group": {"groupId": "a3kdifut-a520-c2cb-1be7-d90710691861",
"groupName": "Shared-house"
},
"foods": [{"id": "3c740136-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "arugula",
"quantity": 1,
"category": "Vegetables",
"unit": "kg",
"expiry": "2023-12-15T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
}
]
}

Update a container's name

The requesting user is identified by the token of request.

path Parameters

containerId

required

string

ID of container

Request Body schema: application/json
required

containerName

string

Responses

Request samples

Payload

Content type

application/json

{"containerName": "new-container"
}

Delete a container

This operation also deletes all foods in the container.

path Parameters

containerId

required

string

ID of container

Responses

add a new food

path Parameters

containerId

required

string

Request Body schema: application/json
required

name required	string
unit required	string or null
category required	string
quantity required	integer or null <float>
expiry required	string or null <date-time> DateTime must follow ISO 8601 format including time zone.

Responses

Request samples

Payload

Content type

application/json

{"name": "bouillon",
"unit": "l",
"category": "Vegetables",
"quantity": 1,
"expiry": "1970-01-01T00:00:00.000Z"
}

Response samples

201

Content type

application/json

{"foodId": "foodId"
}

update a food

path Parameters

containerId required	string ID of container
foodId required	string ID of food

Request Body schema: application/json
required

name required	string
unit required	string or null
category required	string
quantity required	integer or null <float>
expiry required	string or null <date-time> DateTime must follow ISO 8601 format including time zone.

Responses

Request samples

Payload

Content type

application/json

{"name": "bouillon",
"unit": "l",
"category": "Vegetables",
"quantity": 1,
"expiry": "1970-01-01T00:00:00.000Z"
}

delete a food

path Parameters

containerId required	string ID of container
foodId required	string ID of food

Responses

group

Get a list of groups linked to a user

The requesting user is detected by the token.

Responses

Response samples

200

Content type

application/json

{"groups": [{"groupId": "82597aad-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Shared-house"
},
{"groupId": "22222222-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Tom's Family"
},
{"groupId": "33333333-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Nishiki"
},
{"groupId": "44444444-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "School Class A"
},
{"groupId": "55555555-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Running Club"
},
{"groupId": "66666666-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Secret Group"
},
{"groupId": "77777777-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Tom & Jelly"
},
{"groupId": "88888888-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Wright Brothers"
},
{"groupId": "99999999-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Gryffindor"
}
]
}

create a new group

Request Body schema: application/json

groupName

string or null

Responses

Request samples

Payload

Content type

application/json

{"groupName": "Shared-house"
}

Response samples

201

Content type

application/json

{"groupId": "d4825cf5-0b1b-dce3-1aa1-ed9adfd6b0bd"
}

Join to a group

Join to a group using the invitation link hash.

query Parameters

Action

required

string

a place holder, must be 'joinToGroup'

Request Body schema: application/json
required

invitationLinkHash

string

Responses

Request samples

Payload

Content type

application/json

{"invitationLinkHash": "3b6619cffb5f96e1acfa578badae372f"
}

Response samples

200

Content type

application/json

{"groupId": "d4825cf5-0b1b-dce3-1aa1-ed9adfd6b0bd"
}

Get a group

path Parameters

groupId

required

string

ID of group

Responses

Response samples

200

Content type

application/json

{"groupId": "82597aad-0d1b-4672-8b9a-fd3764cb9928",
"groupName": "Shared-house"
}

Update a group's name

The requesting user is identified by the token of request.

path Parameters

groupId

required

string

ID of group

Request Body schema: application/json
required

groupName

string

Responses

Request samples

Payload

Content type

application/json

{"groupName": "new-group"
}

Delete a group

This operation also deletes all containers and foods in the group.

path Parameters

groupId

required

string

ID of group

Responses

Generate an invitation link

Generate an invitation link, return hash of invitation link

query Parameters

Action

required

string

a place holder, must be 'generateInvitationLink'

Responses

Response samples

201

Content type

application/json

{"invitationLinkHash": "3b6619cffb5f96e1acfa578badae372f"
}

get a list of the group's container

path Parameters

groupId

required

string

ID of group

Responses

Response samples

200

Content type

application/json

{"containers": [{"id": "939a4c50-ee7b-4558-b8d5-371514e77bed",
"name": "Shared-house's Fridge",
"group": {"groupId": "a3kdifut-a520-c2cb-1be7-d90710691861",
"groupName": "Shared-house"
},
"foods": [{"id": "3c740136-58b7-4c3d-9548-fc0a4d3b3ef4",
"name": "arugula",
"quantity": 1,
"category": "Vegetables",
"unit": "kg",
"expiry": "2023-12-15T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
}
]
}
]
}

Get a list of users in the group

path Parameters

groupId

required

string

Responses

Response samples

200

Content type

application/json

{"users": [{"id": "11111111-ee7b-4558-b8d5-371514e77bed",
"name": "James Smith"
},
{"id": "22222222-ee7b-4558-b8d5-371514e77bed",
"name": "Emma Brown"
},
{"id": "33333333-ee7b-4558-b8d5-371514e77bed",
"name": "Michael Johnson"
},
{"id": "44444444-ee7b-4558-b8d5-371514e77bed",
"name": "Sophia Thompson"
}
]
}

Delete a user from their specific group

path Parameters

groupId required	string ID of group
userId required	string ID of user

Nishiki Web API (1.0.0)

user

Create a new user

Request Body schema: application/jsonrequired

Responses

Request samples

Get a user

path Parameters

Responses

Response samples

Update a user data

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Delete a user.

path Parameters

Responses

auth

Get a User ID

Responses

Response samples

container

Get a list of the user's container

Responses

Response samples

create a new container

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

get a container information

path Parameters

Responses

Response samples

Update a container's name

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Delete a container

path Parameters

Responses

add a new food

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

update a food

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

delete a food

path Parameters

Responses

group

Get a list of groups linked to a user

Responses

Response samples

create a new group

Request Body schema: application/json

Responses

Request samples

Response samples

Join to a group

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a group

path Parameters

Responses

Response samples

Update a group's name

path Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required