fedspendingtransparency/usaspending-api

import logging

from rest_framework.response import Response
from rest_framework.views import APIView

from usaspending_api.common.cache_decorator import cache_response
from usaspending_api.common.exceptions import NoDataFoundException
from usaspending_api.references.models import Rosetta


logger = logging.getLogger("console")


class DataDictionaryViewSet(APIView):
    """
    This route takes no parameters and returns a JSON structure of the Schema team's Rosetta Crosswalk Data Dictionary
    """

    endpoint_doc = "usaspending_api/api_contracts/contracts/v2/references/data_dictionary.md"

    @cache_response()
    def get(self, request, format=None):
        try:
            api_response = Rosetta.objects.filter(document_name="api_response").values("document")[0]
        except Exception:
            raise NoDataFoundException("Unable to locate and fetch a Data Dictionary object from the database")
        return Response(api_response)