mirror of
https://github.com/LaCasemate/fab-manager.git
synced 2024-12-01 12:24:28 +01:00
84 lines
2.6 KiB
Ruby
84 lines
2.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# openAPI documentation for trainings endpoint
|
|
class OpenAPI::V1::TrainingsDoc < OpenAPI::V1::BaseDoc
|
|
resource_description do
|
|
short 'Trainings'
|
|
desc 'Trainings of Fab-manager'
|
|
formats FORMATS
|
|
api_version API_VERSION
|
|
end
|
|
|
|
doc_for :index do
|
|
api :GET, "/#{API_VERSION}/trainings", 'Trainings index'
|
|
description 'Trainings index. Order by *created_at* ascendant.'
|
|
example <<-TRAININGS
|
|
# /open_api/v1/trainings
|
|
{
|
|
"trainings": [
|
|
{
|
|
"id": 1,
|
|
"name": "Formation Imprimante 3D",
|
|
"slug": "formation-imprimante-3d",
|
|
"disabled": null,
|
|
"updated_at": "2015-02-05T13:49:15.025+01:00",
|
|
"created_at": "2014-06-30T03:32:32.126+02:00",
|
|
"nb_total_places": 8,
|
|
"description": null
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "Formation Laser / Vinyle",
|
|
"slug": "formation-laser-vinyle",
|
|
"disabled": null,
|
|
"updated_at": "2015-02-05T13:49:19.046+01:00",
|
|
"created_at": "2014-06-30T03:32:32.138+02:00",
|
|
"nb_total_places": 8,
|
|
"description": null
|
|
},
|
|
{
|
|
"id": 3,
|
|
"name": "Formation Petite fraiseuse numerique",
|
|
"slug": "formation-petite-fraiseuse-numerique",
|
|
"disabled": true,
|
|
"updated_at": "2015-02-05T13:49:23.040+01:00",
|
|
"created_at": "2014-06-30T03:32:32.164+02:00",
|
|
"nb_total_places": 8,
|
|
"description": null
|
|
},
|
|
{
|
|
"id": 4,
|
|
"name": "Formation Shopbot Grande Fraiseuse",
|
|
"slug": "formation-shopbot-grande-fraiseuse",
|
|
"disabled": false,
|
|
"updated_at": "2015-02-03T10:22:21.908+01:00",
|
|
"created_at": "2014-06-30T03:32:32.168+02:00",
|
|
"nb_total_places": 6,
|
|
"description": null
|
|
},
|
|
{
|
|
"id": 5,
|
|
"name": "Formation logiciel 2D",
|
|
"slug": "formation-logiciel-2d",
|
|
"disabled": false,
|
|
"updated_at": "2015-02-05T13:49:27.460+01:00",
|
|
"created_at": "2014-06-30T09:37:42.778+02:00",
|
|
"nb_total_places": 8,
|
|
"description": null
|
|
},
|
|
{
|
|
"id": 6,
|
|
"name": "Pas de Reservation",
|
|
"slug": "pas-de-reservation",
|
|
"disabled": null,
|
|
"updated_at": "2014-07-22T14:18:11.784+02:00",
|
|
"created_at": "2014-07-22T14:18:11.784+02:00",
|
|
"nb_total_places": null,
|
|
"description": null
|
|
}
|
|
]
|
|
}
|
|
TRAININGS
|
|
end
|
|
end
|