Skip to content

Instantly share code, notes, and snippets.

@kinlane
Created October 6, 2018 19:57
Show Gist options
  • Save kinlane/716b653def40fff2e9f378d072362dae to your computer and use it in GitHub Desktop.
Save kinlane/716b653def40fff2e9f378d072362dae to your computer and use it in GitHub Desktop.
aliss-categories-api
swagger: '2.0'
info:
title: "ALISS API"
description: "HSDA Road Map Suggestion"
contact:
name: ALISS
url: https://docs.aliss.org
version: v1.2
host: www.aliss.org
basePath: /api/v4/
schemes:
- http
produces:
- application/json
paths:
/categories/:
get:
summary: Categories
description: This endpoint retrieves all categories.
operationId: categories
responses:
'200':
description: Response
schema:
type: array
items:
$ref: "#/definitions/response"
tags:
- Categories
definitions:
response:
description: 'The response structure.'
properties:
meta:
description: 'metadata associated with the result.'
type: string
data:
type: "array"
description: 'collection of category objects'
items:
$ref: "#/definitions/categories"
required:
- id
- name
categories:
description: 'The subcategories'
properties:
name:
description: 'The name of the category.'
type: string
slug:
description: 'The slug of the category.'
type: string
sub_categories:
type: "array"
description: 'collection of category objects'
items:
$ref: "#/definitions/categories"
required:
- id
- name
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment