Skip to content
Snippets Groups Projects
Commit 575f69ef authored by Miroslav Rouča's avatar Miroslav Rouča
Browse files

Delete openapi.yaml

parent fc39c93a
No related branches found
No related tags found
1 merge request!25Milestone 1
Pipeline #
openapi: 3.0.1
info:
title: OpenAPI definition
version: v0
servers:
- url: http://localhost:8080
description: Generated server url
tags:
- name: Device
description: Device API
paths:
/api/user/{id}:
get:
tags:
- user
summary: Find user by ID
description: Returns a single user
operationId: findById
parameters:
- name: id
in: path
description: ID of user to be searched
required: true
schema:
type: string
responses:
"200":
description: User found
content:
application/json:
schema:
$ref: '#/components/schemas/UserDto'
"404":
description: User not found
put:
tags:
- user-controller
summary: Update a user by ID
operationId: updateById
parameters:
- name: id
in: path
description: ID of the user to be updated
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateDto'
required: true
responses:
"200":
description: User updated successfully
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
"500":
description: Internal server error
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
"400":
description: Invalid input
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
"404":
description: User not found
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
delete:
tags:
- user-controller
summary: Delete a user by ID
operationId: deleteById
parameters:
- name: id
in: path
description: ID of the user to be deleted
required: true
schema:
type: string
responses:
"200":
description: User deleted successfully
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
"500":
description: Internal server error
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
"404":
description: User not found
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDto'
/api/manufacturer/{id}:
get:
tags:
- manufacturer-controller
summary: Get manufacturer by ID
description: Returns the manufacturer with the specified ID.
operationId: findById_2
parameters:
- name: id
in: path
description: The ID of the manufacturer.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ManufacturerDto'
put:
tags:
- manufacturer-controller
summary: Update device
description: Updates the device with the specified id.
operationId: updateById_1
parameters:
- name: id
in: path
description: The id of the manufacturer.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManufacturerUpdateDto'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ManufacturerDto'
delete:
tags:
- manufacturer-controller
summary: Delete manufacturer
description: Deletes the manufacturer with the specified id.
operationId: deleteById_1
parameters:
- name: id
in: path
description: The id of the manufacturer.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ManufacturerDto'
/api/house/{id}:
get:
tags:
- house-controller
summary: Get a house by ID
description: Retrieve a house with the specified ID.
operationId: findById_3
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/HouseDto'
put:
tags:
- house-controller
summary: Update specific house
description: Updates the house with the specified id.
operationId: updateById_2
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HouseUpdateDto'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/HouseDto'
delete:
tags:
- house-controller
summary: Deletes specific house
description: Deletes the house with the specified id.
operationId: deleteById_2
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/HouseDto'
/api/device/{id}:
get:
tags:
- Device
summary: Get device by id
description: Returns a device with the specified id.
operationId: findById_4
parameters:
- name: id
in: path
description: The id of the device.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DeviceDto'
put:
tags:
- Device
summary: Update device
description: Updates the device with the specified id.
operationId: updateById_3
parameters:
- name: id
in: path
description: The id of the device.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceUpdateDto'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DeviceDto'
delete:
tags:
- Device
summary: Delete device
description: Deletes the device with the specified id.
operationId: deleteById_3
parameters:
- name: id
in: path
description: The id of the device.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DeviceDto'
/api/user:
get:
tags:
- user
summary: Get all users
description: Returns all users
operationId: findAll
parameters:
- name: page
in: query
description: Page number of results to retrieve
required: true
schema:
type: integer
format: int32
responses:
"200":
description: Users found
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
post:
tags:
- user
summary: Create user
description: Creates a new user
operationId: create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreateDto'
required: true
responses:
"400":
description: Invalid input
"201":
description: User created
content:
application/json:
schema:
$ref: '#/components/schemas/UserDto'
"409":
description: User with the same name already exists
/api/smart-meter:
get:
tags:
- smart-meter-controller
summary: Get all smart meters
description: Returns a list of all smart meters.
operationId: findAll_1
responses:
"200":
description: Successfully retrieved the list of smart meters.
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/SmartMeterDto'
post:
tags:
- smart-meter-controller
summary: Create a new smart meter
description: Creates a new smart meter.
operationId: create_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SmartMeterCreateDto'
required: true
responses:
"201":
description: Successfully created a new smart meter.
content:
'*/*':
schema:
$ref: '#/components/schemas/SmartMeterDto'
/api/manufacturer:
get:
tags:
- manufacturer-controller
summary: Get all manufacturers
description: Returns a list of all manufacturers.
operationId: findAll_2
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ManufacturerDto'
post:
tags:
- manufacturer-controller
summary: Create manufacturer
description: Creates a new manufacturer.
operationId: create_2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManufacturerCreateDto'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ManufacturerDto'
/api/house:
get:
tags:
- house-controller
summary: Get all houses
description: Retrieve a list of all houses.
operationId: findAll_3
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/HouseDto'
post:
tags:
- house-controller
summary: Create a new house
description: Create a new house with the specified details.
operationId: create_3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HouseCreateDto'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/HouseDto'
/api/device:
get:
tags:
- Device
summary: Get all devices
description: Returns a list of all devices.
operationId: findAll_4
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/DeviceDto'
post:
tags:
- Device
summary: Create device
description: Creates a new device.
operationId: create_4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceCreateDto'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DeviceDto'
/api/smart-meter/{id}:
get:
tags:
- smart-meter-controller
summary: Get a smart meter by ID
description: Returns the smart meter with the specified ID.
operationId: findById_1
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"404":
description: Smart meter not found.
content:
'*/*':
schema:
$ref: '#/components/schemas/SmartMeterDto'
"200":
description: Successfully retrieved the smart meter.
content:
'*/*':
schema:
$ref: '#/components/schemas/SmartMeterDto'
/api/smart-meter/pageable:
get:
tags:
- smart-meter-controller
summary: Get a pageable list of smart meters
description: Returns a pageable list of smart meters.
operationId: findAllPageable
parameters:
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
"200":
description: Successfully retrieved the pageable list of smart meters.
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/SmartMeterDto'
/api/manufacturer/pageable:
get:
tags:
- manufacturer-controller
summary: Get all manufacturers (paginated)
description: Returns a pageable list of all manufacturers.
operationId: findAllPageable_1
parameters:
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ManufacturerDto'
/api/house/pageable:
get:
tags:
- house-controller
summary: Get all houses pageable
description: Retrieve a pageable list of all houses.
operationId: findAllPageable_2
parameters:
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/HouseDto'
components:
schemas:
UserUpdateDto:
type: object
properties:
id:
type: string
username:
type: string
password:
type: string
email:
type: string
firstName:
type: string
lastName:
type: string
UserDto:
type: object
properties:
id:
type: string
username:
type: string
email:
type: string
firstName:
type: string
lastName:
type: string
ManufacturerUpdateDto:
type: object
properties:
id:
type: string
name:
type: string
ManufacturerDto:
type: object
properties:
id:
type: string
name:
type: string
HouseUpdateDto:
type: object
properties:
id:
type: string
name:
type: string
city:
type: string
state:
type: string
zipcode:
type: string
HouseDto:
type: object
properties:
id:
type: string
address:
type: string
city:
type: string
state:
type: string
zipcode:
type: string
DeviceUpdateDto:
type: object
properties:
id:
type: string
name:
type: string
DeviceDto:
type: object
properties:
id:
type: string
name:
type: string
UserCreateDto:
type: object
properties:
id:
type: string
username:
type: string
password:
type: string
email:
type: string
firstName:
type: string
lastName:
type: string
description: User to be created
SmartMeterCreateDto:
type: object
properties:
id:
type: string
name:
type: string
deviceDto:
$ref: '#/components/schemas/DeviceDto'
SmartMeterDto:
type: object
properties:
id:
type: string
name:
type: string
deviceDto:
$ref: '#/components/schemas/DeviceDto'
ManufacturerCreateDto:
type: object
properties:
id:
type: string
name:
type: string
HouseCreateDto:
type: object
properties:
id:
type: string
address:
type: string
city:
type: string
state:
type: string
zipcode:
type: string
DeviceCreateDto:
type: object
properties:
id:
type: string
name:
type: string
DomainObjectDto:
type: object
properties:
id:
type: string
Result:
type: object
properties:
total:
type: integer
format: int64
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
items:
type: array
items:
$ref: '#/components/schemas/DomainObjectDto'
Pageable:
type: object
properties:
page:
minimum: 0
type: integer
format: int32
size:
minimum: 1
type: integer
format: int32
sort:
type: array
items:
type: string
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment