##// END OF EJS Templates
comments: extend API data with references to commit_id or pull_request_id for audit-logs.
comments: extend API data with references to commit_id or pull_request_id for audit-logs.

File last commit:

r3423:f8efae2b merge default
r4304:a588c9e6 default
Show More
extra_fields.py
55 lines | 2.0 KiB | text/x-python | PythonLexer
# -*- coding: utf-8 -*-
# Copyright (C) 2016-2019 RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/
"""
example usage in hooks::
from .helpers import extra_fields
# returns list of dicts with key-val fetched from extra fields
repo_extra_fields = extra_fields.run(**kwargs)
repo_extra_fields.get('endpoint_url')
# the field stored the following example values
{u'created_on': datetime.datetime(),
u'field_key': u'endpoint_url',
u'field_label': u'Endpoint URL',
u'field_desc': u'Full HTTP endpoint to call if given',
u'field_type': u'str',
u'field_value': u'http://server.com/post',
u'repo_field_id': 1,
u'repository_id': 1}
# for example to obtain the value:
endpoint_field = repo_extra_fields.get('endpoint_url')
if endpoint_field:
url = endpoint_field['field_value']
"""
def run(*args, **kwargs):
from rhodecode.model.db import Repository
# use temp name then the main one propagated
repo_name = kwargs.pop('REPOSITORY', None) or kwargs['repository']
repo = Repository.get_by_repo_name(repo_name)
fields = {}
for field in repo.extra_fields:
fields[field.field_key] = field.get_dict()
return fields