Skip to content

Proposal: get currencies #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Proposal: get currencies #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88d26fc
Proposal for currencies endpoint
lroellin Jun 19, 2017
738c0f1
Update teiler-io.api.yaml
lroellin Jun 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions src/teiler-io.api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ info:

Also, our backend server is correctly configured for CORS so you can just start whenever you want! And if something goes wrong, don't hesitate to contact us.

The enumeration values for ``currency`` are currently:
* ``chf``
* ``eur``

All time values follow the ISO time format standard [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
version: 1.0.0
title: Teiler.io API
Expand Down Expand Up @@ -580,6 +576,18 @@ paths:
$ref: '#/definitions/SettleUp'
'401':
$ref: '#/responses/Unauthorized'
'/info/currencies':
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if /info/currencies or /currencies is better tbh...

get:
tags:
- info
summary: List supported currency values
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Currency'
definitions:
Group:
type: object
Expand All @@ -597,10 +605,7 @@ definitions:
$ref: '#/definitions/Person'
readOnly: true
currency:
type: string
enum:
- chf
- eur
$ref: '#/definitions/Currency'
update-time:
type: string
format: date-time
Expand Down Expand Up @@ -710,11 +715,12 @@ definitions:
type: string
example: ERROR_STRING
description: Error Code
Currency:
type: string
example: chf
description: A currency literal
responses:
Unauthorized:
description: NOT_AUTHORIZED_TO_GROUP
schema:
$ref: '#/definitions/Error'
externalDocs:
description: Find out more about Swagger
url: 'http://swagger.io'