mirror of
https://github.com/GSA/notifications-api.git
synced 2026-01-31 23:26:23 -05:00
Add schemas, endpoints and supporting tests
This commit is contained in:
7
app/v2/template/__init__.py
Normal file
7
app/v2/template/__init__.py
Normal file
@@ -0,0 +1,7 @@
|
||||
from flask import Blueprint
|
||||
|
||||
from app.v2.errors import register_errors
|
||||
|
||||
template_blueprint = Blueprint("v2_template", __name__, url_prefix='/v2/template')
|
||||
|
||||
register_errors(template_blueprint)
|
||||
31
app/v2/template/get_template.py
Normal file
31
app/v2/template/get_template.py
Normal file
@@ -0,0 +1,31 @@
|
||||
import uuid
|
||||
|
||||
from flask import jsonify, request
|
||||
from werkzeug.exceptions import abort
|
||||
|
||||
from app import api_user
|
||||
from app.dao import templates_dao
|
||||
from app.schema_validation import validate
|
||||
from app.v2.template import template_blueprint
|
||||
from app.v2.template.template_schemas import get_template_by_id_request
|
||||
|
||||
|
||||
@template_blueprint.route("/<template_id>", methods=['GET'])
|
||||
@template_blueprint.route("/<template_id>/version/<version>", methods=['GET'])
|
||||
def get_template_by_id(template_id, version=None):
|
||||
try:
|
||||
casted_id = uuid.UUID(template_id)
|
||||
|
||||
_data = {}
|
||||
_data['id'] = template_id
|
||||
if version:
|
||||
_data['version'] = int(version)
|
||||
|
||||
data = validate(_data, get_template_by_id_request)
|
||||
except ValueError or AttributeError:
|
||||
abort(404)
|
||||
|
||||
template = templates_dao.dao_get_template_by_id_and_service_id(
|
||||
casted_id, api_user.service_id, data.get('version'))
|
||||
|
||||
return jsonify(template.serialize()), 200
|
||||
41
app/v2/template/template_schemas.py
Normal file
41
app/v2/template/template_schemas.py
Normal file
@@ -0,0 +1,41 @@
|
||||
from app.models import TEMPLATE_TYPES
|
||||
from app.schema_validation.definitions import uuid
|
||||
|
||||
|
||||
get_template_by_id_request = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "schema for query parameters allowed when getting list of notifications",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": uuid,
|
||||
"version": {"type": ["integer", "null"], "minimum": 1}
|
||||
},
|
||||
"required": ["id"],
|
||||
"additionalProperties": False,
|
||||
}
|
||||
|
||||
get_template_by_id_response = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "GET template by id schema response",
|
||||
"type": "object",
|
||||
"title": "reponse v2/template",
|
||||
"properties": {
|
||||
"id": uuid,
|
||||
"type": {"enum": TEMPLATE_TYPES},
|
||||
"created_at": {
|
||||
"format": "date-time",
|
||||
"type": "string",
|
||||
"description": "Date+time created"
|
||||
},
|
||||
"updated_at": {
|
||||
"format": "date-time",
|
||||
"type": "string",
|
||||
"description": "Date+time updated"
|
||||
},
|
||||
"created_by": {"type": "string"},
|
||||
"version": {"type": "integer"},
|
||||
"body": {"type": "string"},
|
||||
"subject": {"type": ["string", "null"]}
|
||||
},
|
||||
"required": ["id", "type", "created_at", "updated_at", "version", "created_by", "body"]
|
||||
}
|
||||
Reference in New Issue
Block a user