wedding-planner/spec/swagger_response_helper.rb

73 lines
1.7 KiB
Ruby
Raw Normal View History

2025-01-13 20:38:47 +00:00
# Copyright (C) 2024 Manuel Bustillo
# Copyright (C) 2024-2025 LibreWeddingPlanner contributors
2024-11-16 01:52:48 +00:00
# frozen_string_literal: true
module SwaggerResponseHelper
TIMESTAMP_FORMAT = '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z'
TIMESTAMP_EXAMPLE = Time.zone.now.iso8601(3)
2024-12-28 18:07:22 +01:00
TIMESTAMP = { type: :string, pattern: TIMESTAMP_FORMAT, example: TIMESTAMP_EXAMPLE }.freeze
PASSWORD = { type: :string, minLength: User.password_length.begin, maxLength: User.password_length.end }.freeze
def regular_api_responses
2024-12-28 18:07:22 +01:00
response401
end
2024-12-28 18:07:22 +01:00
def response422
response(422, 'Validation errors in input parameters') do
produces 'application/json'
error_schema
xit
end
end
2024-12-28 18:07:22 +01:00
def response_empty200
response(200, 'Success') do
produces 'application/json'
schema type: :object
xit
end
end
2024-12-28 18:07:22 +01:00
def response_empty201
response(201, 'Created') do
produces 'application/json'
schema type: :object
xit
end
end
2024-12-28 18:07:22 +01:00
def response404
response(404, 'Record not found') do
produces 'application/json'
error_schema
xit
end
end
2024-12-28 18:07:22 +01:00
def response401(message: nil)
response(401, 'Unauthorized') do
produces 'application/json'
schema type: :object,
2024-12-28 18:07:22 +01:00
required: %i[error],
properties: {
error: { type: :string, example: message || 'You need to sign in or sign up before continuing.' }
}
xit
end
end
private
def error_schema
schema type: :object,
required: %i[message errors],
properties: {
message: { type: :string },
errors: { type: :array, items: { type: :string } }
}
end
end