Document tables arrangements controller
All checks were successful
Check usage of free licenses / check-licenses (pull_request) Successful in 34s
Add copyright notice / copyright_notice (pull_request) Successful in 1m9s
Run unit tests / unit_tests (pull_request) Successful in 3m51s

This commit is contained in:
Manuel Bustillo 2024-12-08 14:00:53 +01:00
parent b38e845b90
commit 9d90ade40c
2 changed files with 66 additions and 0 deletions

View File

@ -9,6 +9,13 @@ module Swagger
updated_at: SwaggerResponseHelper::TIMESTAMP
}
ID = {
name: 'id',
in: :path,
type: :string,
format: :uuid,
}
GROUP = {
name: { type: :string },
icon: { type: :string, example: 'pi pi-crown', description: 'The CSS classes used by the icon' },

View File

@ -0,0 +1,59 @@
require 'swagger_helper'
RSpec.describe 'tables_arrangements', type: :request do
path '/{slug}/tables_arrangements' do
get('list tables arrangements') do
tags 'Tables Arrangements'
produces 'application/json'
parameter Swagger::Schema::SLUG
response(200, 'successful') do
schema type: :array,
items: {
type: :object,
required: %i[id name discomfort],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string },
discomfort: { type: :integer }
}
}
xit
end
regular_api_responses
end
end
path '/{slug}/tables_arrangements/{id}' do
get('show tables arrangement') do
tags 'Tables Arrangements'
produces 'application/json'
parameter Swagger::Schema::SLUG
parameter Swagger::Schema::ID
response(200, 'successful') do
schema type: :array,
items: {
type: :object,
required: %i[number guests],
properties: {
number: { type: :integer },
guests: {
type: :array,
items: {
type: :object,
required: %i[id name color],
properties: {
id: { type: :string, format: :uuid },
name: { type: :string },
color: { type: :string }
}
}
}
}
}
xit
end
regular_api_responses
end
end
end