mirror of
https://github.com/GSA/notifications-api.git
synced 2026-09-09 10:59:50 -04:00
Add template list and show API methods to openapi
This commit is contained in:
@@ -167,6 +167,47 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
version:
|
version:
|
||||||
type: number
|
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:
|
paths:
|
||||||
/_status?simple=1:
|
/_status?simple=1:
|
||||||
get:
|
get:
|
||||||
@@ -449,6 +490,54 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/userObject"
|
$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:
|
/v2/notifications/sms:
|
||||||
post:
|
post:
|
||||||
security:
|
security:
|
||||||
|
|||||||
Reference in New Issue
Block a user