lucca openapi v2.yaml

À propos

Type de fichier: Fichier YAML de 4 Ko (text/plain)
Confidentialité: Fichier public, envoyé le 13 février 2020 à 13:51, depuis l'adresse IP 91.164.x.x (France)
Sécurité: Ne contient aucun Virus ou Malware connus - Dernière vérification: 39 minutes
Statistiques: La présente page de téléchargement a été vue 8 fois depuis l'envoi du fichier
Page de téléchargement: https://www.petit-fichier.fr/2020/02/13/luccaopenapiv2/ Copier

Aperçu du fichier

openapi: 3.0.1
info:
  title: Lucca Core Calendar Management
  description: 'This is a sample of services for Calendar, special days and holidays management in Lucca Core. You can find the standard Lucca API at [https://developers.lucca.fr](https://developers.lucca.fr/)'
  version: 1.0.0
externalDocs:
  description: Find out more about Lucca API
  url: https://developers.lucca.fr
servers:
- url: https://sandbox.ilucca-demo.net/api/v3
- url: http://sandbox.ilucca-demo.net/api/v3
tags:
- name: calendars
  description: Everything about your calendars

paths:

  /calendars:
  
    get:
      tags:
      - calendars
      summary: Find calendars by query
      operationId: findCalendars
      parameters:
      - name: name
        in: query
        description: Calendar name filter
        example: 'like,Base'
        schema:
          type: string
      - name: fields
        in: query
        description: List of properties requested, comma separated
        schema:
          type: string
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calendarCollection'
        400:
          description: Invalid parameters supplied

  
    post:
      tags:
      - calendars
      summary: Add a new calendar to the system
      operationId: addCalendar
      requestBody:
        description: Calendar object that needs to be added to the system
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/calendar'
        required: true
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calendarObject'
        400:
          description: Bad Request
        403:
          description: Insufficient privileges
        500:
          description: Server error


  


  /calendars/{id}:
    get:
      tags:
      - calendars
      summary: Find calendar by ID
      description: Returns a single calendar object
      operationId: getCalendarById
      parameters:
      - name: id
        in: path
        description: ID of calendar to return
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calendarObject'
        400:
          description: Invalid ID supplied
        404:
          description: Calendar not found
    delete:
      tags:
      - calendars
      summary: Deletes a calendar
      operationId: deleteCalendar
      parameters:
      - name: id
        in: path
        description: Calendar id to delete
        required: true
        schema:
          type: integer
          format: int64
      responses:
        400:
          description: Invalid ID supplied
        403:
          description: Insufficient privileges
        404:
          description: Calendar not found



          
          
components:
  schemas:

    calendar:
      type: object
      properties:
        name:
          type: string
          example: 'France Jours Fériés base'


    calendarObject:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 12
        name:
          type: string
          example: 'France Jours Fériés base'
        creationDate:
          type: string
          format: date-time
        ownership:
          type: string
          description: calendar ownership
          enum:
          - base
          - client
          example: 'client'

    calendarCollection:
      type: object
      properties:
        data:
          type: object
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/calendarObject'



          
  securitySchemes:
    petstore_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://sandbox.ilucca-demo.net/oauth/dialog
          scopes:
            write:calendars: Modify calendars
            read:calendars: Read calendars
            write:specialDays: Modify special days
            read:specialDays: Read special days
    api_key:
      type: apiKey
      name: api_key
      in: header

Partager le fichier

Télécharger lucca_openapi_v2.yaml

Télécharger le fichier (4 Ko)