34 lines
971 B
YAML
34 lines
971 B
YAML
|
openapi: 3.0.0
|
||
|
|
info:
|
||
|
|
title: Starpub API
|
||
|
|
description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
|
||
|
|
version: 1.0.0
|
||
|
|
|
||
|
|
servers:
|
||
|
|
- url: http://api.example.com/v1
|
||
|
|
description: Optional server description, e.g. Main (production) server
|
||
|
|
- url: http://staging-api.example.com
|
||
|
|
description: Optional server description, e.g. Internal staging server for testing
|
||
|
|
|
||
|
|
paths:
|
||
|
|
'/{user}':
|
||
|
|
get:
|
||
|
|
summary: Returns a list of users.
|
||
|
|
description: Optional extended description in CommonMark or HTML.
|
||
|
|
parameters:
|
||
|
|
- name: user
|
||
|
|
in: path
|
||
|
|
required: true
|
||
|
|
description: username
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
responses:
|
||
|
|
"200": # status code
|
||
|
|
description: A JSON array of user names
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
type: string
|