openapi.yaml

openapi: 3.0.0
info:
  title: Clinic and Payment API
  version: 1.0.0
  description: API for managing clinics, plans, and payments.
servers:
  - url: http://localhost:3003/api/v1
    description: Development server
  - url: /api/v1
    description: Production server
  
tags:
  - name: Clinic
    description: Operations related to clinics
  - name: Payment
    description: Operations related to payments
  - name: Plan
    description: Operations related to plans
paths:
  /plans:
    get:
      tags:
        - Plan
      summary: Retrieve all plans
      responses:
        '200':
          description: A list of plans
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Plan'
              examples:
                example1:
                  value: 
                    - id: "1"
                      name: "Basic Plan"
                      price: 10.0
                      features:
                        - "Feature A"
                        - "Feature B"
  /plans/{id}:
    get:
      tags:
        - Plan
      summary: Retrieve a plan by ID
      description: Retrieves details of a specific plan by its unique ID.
      parameters:
        - name: id
          in: path
          required: true
          description: The unique identifier for the plan
          schema:
            type: string
      responses:
        '200':
          description: Plan successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
        '400':
          description: Missing plan ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Missing plan ID
        '404':
          description: Plan not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Plan not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: An unexpected error occurred

  /payments:
    get:
      tags:
        - Payment
      summary: Retrieve all payments
      security:
        - cookieAuth: []
      responses:
        '200':
          description: A list of payments
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment'
    post:
      security:
        - cookieAuth: []
      tags:
        - Payment
      summary: Process a new payment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      responses:
        '201':
          description: Payment successfully processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
  /payments/{id}:
    get:
      tags:
        - Payment
      summary: Retrieve a payment by ID
      security:
        - cookieAuth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Details of a specific payment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '404':
          description: Payment not found
  /payments/clinic/{clinicId}:
    get:
      tags:
        - Payment
      summary: Retrieve all payments by clinic ID
      security:
        - cookieAuth: []
      parameters:
        - name: clinicId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A list of payments for the specified clinic
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment'
        '400':
          description: Clinic ID is required
        '500':
          description: Server error

  /clinics:
    post:
      tags:
        - Clinic
      security:
        - cookieAuth: []
      summary: Register a new clinic
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClinicRequest'
      responses:
        '201':
          description: Clinic successfully registered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Clinic'
    get:
      tags:
        - Clinic
      summary: Retrieve all clinics
      responses:
        '200':
          description: A list of clinics
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Clinic'
  /clinics/{id}:
    get:
      tags:
        - Clinic
      summary: Retrieve a clinic by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Details of a specific clinic
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Clinic'
        '404':
          description: Clinic not found
    delete:
      tags:
        - Clinic
      summary: Delete a clinic by ID
      security:
        - cookieAuth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Clinic successfully deleted
    put:
      tags:
        - Clinic
      summary: Update a clinic by ID
      security:
        - cookieAuth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClinicRequest'
      responses:
        '200':
          description: Clinic successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Clinic'
components:
  schemas:
    Clinic:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        city:
          type: string
        district:
          type: string
        plan:
          type: string
        active:
          type: boolean
        postalCode:
          type: string
        countryCode:
          type: string
    ClinicRequest:
      type: object
      properties:
        name:
          type: string
        city:
          type: string
        district:
          type: string
        plan:
          type: string
        active:
          type: boolean
        postalCode:
          type: string
        countryCode:
          type: string
    Payment:
      type: object
      properties:
        id:
          type: string
        date:
          type: string
          format: date-time
        clinicId:
          type: string
        status:
          type: string
        planId:
          type: string
    PaymentRequest:
      type: object
      properties:
        planId:
          type: string
        clinicId:
          type: string
    Plan:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        price:
          type: number
        features:
          type: array
          items:
            type: string
  securitySchemes:
    cookieAuth:
        type: apiKey
        in: cookie
        name: token