Select Git revision
boxes.yaml 9.19 KiB
---
openapi: "3.0.0"
info:
version: 1.0.0
title: Boxes API
description: Home inventory system
termsOfService: https://phrye.com
contact:
name: Kevin Lyda
email: kevin@lyda.ie
url: https://git.lyda.ie/kevin/boxes/
license:
name: MIT
servers:
- url: https://localhost:8080/
paths:
/location/{lid}:
get:
summary: Location
description: Get a location.
operationId: GetLocation
parameters:
- $ref: '#/components/parameters/LID'
responses:
'200':
$ref: '#/components/responses/Location'
'403':
$ref: '#/components/responses/Error'
post:
summary: Location
description: Create a location.
operationId: CreateLocation
parameters:
- $ref: '#/components/parameters/LID'
requestBody:
description: New location.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Location"
responses:
'200':
$ref: '#/components/responses/Location'
'403':
$ref: '#/components/responses/Error'
patch:
summary: Location
description: Update a location.
operationId: UpdateLocation
parameters:
- $ref: '#/components/parameters/LID'
requestBody:
description: Updated location.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Location"
responses:
'200':
$ref: '#/components/responses/Location'
'403':
$ref: '#/components/responses/Error'
delete:
summary: Location
description: Delete a location.
operationId: DeleteLocation
parameters: