Created
October 14, 2018 18:41
-
-
Save gamesbrainiac/8704eff9f90bcc98503aa1c69373dfef to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swagger: "2.0" | |
info: | |
version: "1.0.0" | |
title: "Newsletter API" | |
license: | |
name: "Copyright Suitsupply BV" | |
host: "0.0.0.0:5000" | |
basePath: "/v1" | |
tags: | |
- name: "subscription" | |
description: "Everything to do with Subscriptions, from getting them and setting them" | |
schemes: | |
- "http" | |
- "https" | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
paths: | |
/subscriptionStatusByEmail/{email}: | |
get: | |
tags: | |
- "subscription" | |
summary: "Get the current subscription status of an email address" | |
description: "" | |
operationId: "api.get_subscription_status_by_email" | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
parameters: | |
- name: "email" | |
in: "path" | |
description: "Email address you want to query" | |
required: true | |
type: "string" | |
minLength: 3 | |
responses: | |
200: | |
description: "Successful Operation, email exists" | |
schema: | |
$ref: "#/definitions/SubscriptionInfo" | |
404: | |
description: "Subscription Info not found" | |
# TODO: Make sure to talk to Oleg about security and implement in security key | |
definitions: | |
SubscriptionInfo: | |
type: "object" | |
properties: | |
email: | |
type: "string" | |
isSubscribed: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment