fab-manager/app/doc/open_api/v1/events_doc.rb

# frozen_string_literal: true

# openAPI documentation for events endpoint
class OpenAPI::V1::EventsDoc < OpenAPI::V1::BaseDoc
  resource_description do
    short 'Events'
    desc 'Events of Fab-manager'
    formats FORMATS
    api_version API_VERSION
  end

  include OpenAPI::V1::Concerns::ParamGroups

  doc_for :index do
    api :GET, "/#{API_VERSION}/events", 'Events index'
    param_group :pagination
    param :id, [Integer, Array], optional: true, desc: 'Scope the request to one or various events.'
    param :upcoming, [FalseClass, TrueClass], optional: true, desc: 'Scope for the upcoming events.'
    description 'Events index, pagniated. Ordered by *created_at* desc.'
    example <<-EVENTS
      # /open_api/v1/events?page=1&per_page=2
      {
        "events": [
          {
            "id": 183,
            "title": "OPEN LAB",
            "description": "Que vous soyez Fab user, visiteur, curieux ou bricoleur, l’atelier de fabrication numérique vous ouvre ses portes les mercredis soirs pour avancer vos projets ou rencontrer la «communauté» Fab Lab. \r\n\r\nCe soir, venez spécialement découvrir les machines à commandes numérique de la Fabrique de Fab-manager, venez comprendre ce lieux ouvert à tous. \r\n\r\n\r\nVenez découvrir un concept, une organisation, des machines, pour stimuler votre sens de la créativité.",
            "updated_at": "2016-04-25T10:49:40.055+02:00",
            "created_at": "2016-04-25T10:49:40.055+02:00",
            "nb_total_places": 18,
            "nb_free_places": 16,
            "start_at": "2016-05-02T18:00:00.000+02:00",
            "end_at": "2016-05-02T22:00:00.000+02:00",
            "category": "Openlab",
            "event_image": {
                "large_url": "https://example.com/uploads/event_image/3454/large_event_image.jpg",
                "medium_url": "https://example.com/uploads/event_image/3454/medium_event_image.jpg",
                "small_url": "https://example.com/uploads/event_image/3454/small_event_image.jpg"
            },
            "prices": {
              "normal": {
                "name": "Plein tarif",
                "amount": 0
              }
            },
            "url": "https://example.com/#!/events/183"
          },
          {
            "id": 182,
            "title": "ATELIER SKATE : SEANCE 1",
            "description": "Envie de rider à travers Grenoble sur une planche unique ? Envie de découvrir la fabrication éco-responsable d'un skate ? Alors bienvenue à l'atelier Skate Board du Fablab ! Encadré par Ivan Mago et l'équipe du FabLab, vous réaliserez votre planche (skate, longboard,...) depuis son design jusqu'à sa décoration sur 4 séances.\r\n\r\nLe tarif 50€ inclut  la participation aux ateliers, l'utilisations des machines, et tout le matériel de fabrication (bois+colle+grip+vinyle).\r\n\r\nCette première séance sera consacré au design de votre planche et à la découpe des gabarits. N'hésitez pas à venir avec votre ordinateur et vos logiciels de création 2D si vous le souhaitez.\r\n\r\nNous vous attendons nombreux !",
            "updated_at": "2016-04-11T17:40:15.146+02:00",
            "created_at": "2016-04-11T17:40:15.146+02:00",
            "nb_total_places": 8,
            "nb_free_places": 0,
            "start_at": "2016-05-02T18:00:00.000+01:00",
            "end_at": "2026-05-02T22:00:00.000+01:00",
            "category": "Atelier",
            "themes": [
                "DIY",
                "Sport"
            ],
            "age_range": "14 - 18 ans",
            "event_image": {
                "large_url": "https://example.com/uploads/event_image/3453/large_event_image.jpg",
                "medium_url": "https://example.com/uploads/event_image/3453/medium_event_image.jpg",
                "small_url": "https://example.com/uploads/event_image/3453/small_event_image.jpg"
            },
            "prices": {
              "normal": {
                "name": "Plein tarif",
                "amount": 5000
              },
              "1": {
                "name": "Tarif réduit",
                "amount": 4000
              },
            },
            "url": "https://example.com/#!/events/182"
          }
        ]
      }
    EVENTS
  end
end