Commit 02993fe7 authored by Tobias Kuhn's avatar Tobias Kuhn
Browse files

update swagger yaml

parent 85d1e33a
---
swagger: '2.0'
swagger: "2.0"
info:
title: API V1
version: v1
description: This is the first version of my API
paths:
"/users.json":
get:
summary: list all the users
produces:
- abpplication/json
responses:
'200':
description: successful
schema:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
required:
- id
- name
- email
"/users/{id}.json":
get:
summary: show user
produces:
- application/json
parameters:
- name: id
in: path
type: string
required: true
responses:
'200':
description: successful
schema:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
required:
- id
- name
- email
"/api/v1/users":
get:
summary: list all the users
tags:
- User
produces:
- abpplication/json
- abpplication/json
responses:
'200':
"200":
description: successful
schema:
type: object
......@@ -82,21 +35,82 @@ paths:
email:
type: string
required:
- id
- name
- email
- id
- name
- email
post:
summary: creates a user
tags:
- User
consumes:
- application/json
produces:
- application/json
parameters:
- name: user
in: body
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
attributes:
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
required:
- name
- email
- password
responses:
"201":
description: user created
schema:
type: object
properties:
data:
type: object
properties:
id:
type: integer
example: 986702037
type:
type: string
example: "user"
attributes:
type: object
properties:
name:
type: string
example: "Good"
email:
type: string
example: "good@hier.net"
"422":
description: password can't be blank, name can't exist, e-mail can't exist
"/api/v1/users/{id}":
get:
summary: show user
tags:
- User
produces:
- application/json
- application/json
parameters:
- name: id
in: path
type: string
required: true
- name: id
in: path
type: string
required: true
responses:
'200':
"200":
description: successful
schema:
type: object
......@@ -115,7 +129,142 @@ paths:
type: string
email:
type: string
required:
required:
- name
- email
required:
- id
- type
- attributes
patch:
summary: update a user data
tags:
- User
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
type: string
required: true
- name: user
in: body
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
required:
- name
- email
- password
responses:
"200":
description: "user updated: Raider heisst jetzt Twix"
schema:
type: object
properties:
data:
type: object
properties:
id:
type: integer
example: 9383833
type:
type: string
example: "user"
attributes:
type: object
properties:
name:
type: string
example: "Twix"
email:
type: string
example: "twix@skywalker.net"
delete:
summary: deletes a users
tags:
- User
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
type: string
required: true
responses:
"204":
description: user updated
"/users.json":
get:
summary: list all the users
tags:
- Legacy
produces:
- application/json
responses:
"200":
description: successful
schema:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
required:
- id
- name
- email
\ No newline at end of file
- email
"/users/{id}.json":
get:
summary: show user
tags:
- Legacy
produces:
- application/json
parameters:
- name: id
in: path
type: string
required: true
responses:
"200":
description: successful
schema:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
required:
- id
- name
- email
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment