openapi: 3.0.1
info:
  title: Diary
  description: This plugin helps users to manage diary.
  version: 'v1'
servers:
  - url: https://diary-chatgptplugin.derekxwang.com
paths:
  /diary/start:
    get:
      operationId: startDiary
      summary: Obtain the diary prompt and provide useful information for starting diary.
      parameters:
      - in: query
        name: language
        required: true
        schema:
          type: string
        description: The language of the diary that user want to use. use ISO 639 code. Required Default is en. Currently support en and zh.
      - in: query
        name: today
        required: true
        schema:
          type: string
        description: A date string in format of YYYY-MM-DD. Default is today's date.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/startResponse'
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  /diary/stop:
    get:
      operationId: stopDiary
      summary: Obtain the diary summarization prompt and provide useful information.
      parameters:
      - in: query
        name: language
        schema:
          type: string
        description: The language of the diary.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stopResponse'
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  /diary/connect/calendar:
    get:
      operationId: connectCalendar
      summary: Obtain the ics calender file download link, so the user can easily add calendar events.
      parameters:
      - in: query
        name: text
        schema:
          type: string
        description: The text input in format of ICS for Calendar.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connectCalendarResponse'
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"

components:
  schemas:
    startResponse:
      type: object
      required:
      - prompt
      properties:
        prompt:
          type: string
          description: The prompt that instruct AI about how to help user to start a diary.
    stopResponse:
      type: object
      required:
      - prompt
      properties:
        prompt:
          type: string
          description: The prompt that instruct AI about how to wrap up a diary.
    connectCalendarResponse:
      type: object
      required:
      - link
      properties:
        link:
          type: string
          description: The download link to ics file.
    HTTPError:
      title: HTTPError
      type: object
      properties:
        message:
          title: Message
          type: string
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: "#/components/schemas/ValidationError"
    ValidationError:
      title: ValidationError
      required:
        - loc
        - msg
        - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string