Homeless Helper by OurTechnology.co (beta) - Open API Spec

open-api-spec-homeless-resource.yml

openapi: 3.0.1
info:
  title: Typesense Resource Search API
  description: API to search for resources using Typesense.
  version: 1.0.0
servers:
  - url: https://cameronpak-homeless.web.val.run
paths:
  /resources:
    get:
      operationId: getResources
      summary: Retrieve resources based on location and query.
      description: Returns a list of resources that match the search criteria based on the provided location and query parameters.
      parameters:
        - name: lat
          in: query
          required: true
          schema:
            type: number
            format: float
          description: Latitude of the location to search.
        - name: lng
          in: query
          required: true
          schema:
            type: number
            format: float
          description: Longitude of the location to search.
        - name: query
          in: query
          required: true
          schema:
            type: string
          description: Search query string.
        - name: radius
          in: query
          required: false
          schema:
            type: number
            format: float
            minimum: 1
            maximum: 20
          description: Search radius in miles.
      responses:
        '200':
          description: A list of resources that match the search criteria.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    address:
                      type: object
                      properties:
                        full_address:
                          type: string
                        latitude:
                          type: number
                          format: float
                        longitude:
                          type: number
                          format: float
                    website:
                      type: string
                    phone:
                      type: string
                    user_email:
                      type: string
                    description:
                      type: string
                    utc_offset:
                      type: number
                    featured_image_url:
                      type: string
                    hours_text:
                      type: string
                      nullable: true
                    hours:
                      type: array
                      items:
                        type: object
                        properties:
                          day:
                            type: string
                          day_int:
                            type: number
                          open_time:
                            type: string
                            nullable: true
                          close_time:
                            type: string
                            nullable: true
                    services:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          description:
                            type: string
                          category:
                            type: object
                            properties:
                              icon:
                                type: string
                              name:
                                type: string
                    qualifications:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                    distance_between:
                      type: number
                      format: float
        '400':
          description: Invalid parameters.
        '500':
          description: Server error.