File size: 6,165 Bytes
312c2e2 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | openapi: 3.1.0
info:
# Do not change the title, if the title changes, the import paths will be broken
title: Api
version: 0.1.0
description: API specification for FB Group Publisher PRO
servers:
- url: /api
description: Base API path
tags:
- name: health
description: Health operations
- name: me
description: Current user
- name: subscription
description: PayPal subscription management
- name: paypal
description: PayPal webhook
- name: savedLists
description: Saved group lists
paths:
/healthz:
get:
operationId: healthCheck
tags: [health]
summary: Health check
responses:
"200":
description: Healthy
content:
application/json:
schema:
$ref: "#/components/schemas/HealthStatus"
/me:
get:
operationId: getMe
tags: [me]
summary: Get current user with subscription state
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/MeResponse"
"401":
description: Unauthorized
/subscription/create:
post:
operationId: createSubscription
tags: [subscription]
summary: Create PayPal subscription, returns approval URL
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSubscriptionResponse"
"401":
description: Unauthorized
/subscription/activate:
post:
operationId: activateSubscription
tags: [subscription]
summary: Activate subscription after PayPal approval
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ActivateSubscriptionBody"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionState"
/subscription/cancel:
post:
operationId: cancelSubscription
tags: [subscription]
summary: Cancel current subscription
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionState"
/paypal/webhook:
post:
operationId: paypalWebhook
tags: [paypal]
summary: PayPal webhook receiver
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/HealthStatus"
/saved-lists:
get:
operationId: listSavedLists
tags: [savedLists]
summary: List saved group lists
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ListSavedListsResponse"
"401":
description: Unauthorized
post:
operationId: createSavedList
tags: [savedLists]
summary: Save a group list
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSavedListBody"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/SavedList"
/saved-lists/{id}:
delete:
operationId: deleteSavedList
tags: [savedLists]
summary: Delete a saved list
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"204":
description: Deleted
components:
schemas:
HealthStatus:
type: object
properties:
status:
type: string
required:
- status
SubscriptionState:
type: object
properties:
status:
type: string
enum: [none, trialing, active, cancelled, suspended, expired]
trialEnd:
type: [string, "null"]
format: date-time
currentPeriodEnd:
type: [string, "null"]
format: date-time
paypalSubscriptionId:
type: [string, "null"]
hasAccess:
type: boolean
required:
- status
- hasAccess
MeResponse:
type: object
properties:
userId:
type: string
email:
type: [string, "null"]
subscription:
$ref: "#/components/schemas/SubscriptionState"
required:
- userId
- subscription
CreateSubscriptionResponse:
type: object
properties:
subscriptionId:
type: string
approvalUrl:
type: string
required:
- subscriptionId
- approvalUrl
ActivateSubscriptionBody:
type: object
properties:
subscriptionId:
type: string
required:
- subscriptionId
SavedList:
type: object
properties:
id:
type: integer
name:
type: string
groupIds:
type: array
items:
type: string
createdAt:
type: string
format: date-time
required:
- id
- name
- groupIds
- createdAt
ListSavedListsResponse:
type: array
items:
$ref: "#/components/schemas/SavedList"
CreateSavedListBody:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 80
groupIds:
type: array
items:
type: string
minItems: 1
required:
- name
- groupIds
|