darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-01-31 23:26:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add template list and show API methods to openapi

Browse Source
This commit is contained in:
Ryan Ahearn
2022-12-02 11:33:29 -05:00
parent 38692c5c6e
commit 34def50f69
1 changed files with 89 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
docs/openapi.yml
View File

@@ -167,6 +167,47 @@ components:
type: string
version:
type: number
templateObject:
type: object
properties:
body:
type: string
created_at:
type: string
created_by:
type: string
id:
type: string
letter_contact_block:
type: object
name:
type: string
personalisation:
type: object
postage:
type: string
subject:
type: string
type:
type: string
updated_at:
type: string
version:
type: integer
required:
- body
- created_at
- created_by
- id
- letter_contact_block
- name
- personalisation
- postage
- subject
- type
- updated_at
- version
additionalProperties: false
paths:
/_status?simple=1:
get:
@@ -449,6 +490,54 @@ paths:
type: array
items:
$ref: "#/components/schemas/userObject"
/v2/templates:
get:
security:
- bearerAuth: []
description: 'Get list of templates'
tags:
- external-api
parameters:
- name: type
in: query
schema:
type: string
enum: ["sms", "email"]
examples:
"SMS Templates":
value: "sms"
"Email Templates":
value: "email"
"All Templates":
value: ""
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
templates:
type: array
items:
$ref: "#/components/schemas/templateObject"
/v2/template/{uuid}:
get:
security:
- bearerAuth: []
description: 'Get details for a single template'
tags:
- external-api
parameters:
- $ref: "#/components/parameters/uuidPath"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/templateObject"
/v2/notifications/sms:
post:
security: