Outdoorsy Toweable API

The toweable API from Outdoorsy — 1 operation(s) for toweable.

OpenAPI Specification

outdoorsy-toweable-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'The Outdoorsy API (or simply "API") is organized around REST. It uses

    predictable, resource-oriented URLs and implements standard HTTP response

    codes, verbs, authentication mechanisms, and a variety of request encodings.


    ## Versioning


    The API implements semantic versioning.'
  title: Outdoorsy API Documentation Toweable API
  version: 0.0.1
servers:
- url: /v0
security:
- Bearer:
  - '[]'
- API-Key:
  - '[]'
tags:
- name: toweable
paths:
  /towable_features:
    get:
      description: Returns a list of toweable features
      tags:
      - toweable
      operationId: features
      responses:
        '200':
          $ref: '#/components/responses/towableFeaturesResponse'
        default:
          $ref: '#/components/responses/genericError'
components:
  schemas:
    DBStringMap:
      description: DBStringMap is a map[string]string with database conversion methods
      type: object
      additionalProperties:
        type: string
      x-go-package: github.com/outdoorsy/api/utils
    TowableFeature:
      type: object
      properties:
        feature:
          type: string
          x-go-name: Slug
        name:
          type: string
          x-go-name: Name
        options:
          $ref: '#/components/schemas/DBStringMap'
      x-go-package: github.com/outdoorsy/api/internal/towable_features
  responses:
    towableFeaturesResponse:
      description: ''
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/TowableFeature'
    genericError:
      description: An unknown, unexpected error.
  securitySchemes:
    API-Key:
      type: apiKey
      name: API-Key
      in: header
    Bearer:
      type: apiKey
      name: Authorization
      in: header