1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*
* SonarQube
* Copyright (C) 2009-2017 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
// @flow
import React from 'react';
import { Link } from 'react-router';
import classNames from 'classnames';
import { getActionKey } from '../utils';
import Params from './Params';
import ResponseExample from './ResponseExample';
import ActionChangelog from './ActionChangelog';
import DeprecatedBadge from './DeprecatedBadge';
import InternalBadge from './InternalBadge';
import LinkIcon from '../../../components/icons-components/LinkIcon';
import { TooltipsContainer } from '../../../components/mixins/tooltips-mixin';
import type { Action as ActionType, Domain as DomainType } from '../../../api/web-api';
type Props = {
action: ActionType,
domain: DomainType,
showDeprecated: boolean,
showInternal: boolean
};
type State = {
showChangelog: boolean,
showParams: boolean,
showResponse: boolean
};
export default class Action extends React.PureComponent {
props: Props;
state: State = {
showChangelog: false,
showParams: false,
showResponse: false
};
handleShowParamsClick = (e: SyntheticInputEvent) => {
e.preventDefault();
this.setState({
showChangelog: false,
showResponse: false,
showParams: !this.state.showParams
});
};
handleShowResponseClick = (e: SyntheticInputEvent) => {
e.preventDefault();
this.setState({
showChangelog: false,
showParams: false,
showResponse: !this.state.showResponse
});
};
handleChangelogClick = (e: SyntheticInputEvent) => {
e.preventDefault();
this.setState({
showChangelog: !this.state.showChangelog,
showParams: false,
showResponse: false
});
};
render() {
const { action, domain } = this.props;
const { showChangelog, showParams, showResponse } = this.state;
const verb = action.post ? 'POST' : 'GET';
const actionKey = getActionKey(domain.path, action.key);
return (
<div id={actionKey} className="web-api-action">
<TooltipsContainer>
<header className="web-api-action-header">
<Link
to={{ pathname: '/web_api/' + actionKey }}
className="spacer-right link-no-underline">
<LinkIcon />
</Link>
<h3 className="web-api-action-title">
{verb} {actionKey}
</h3>
{action.internal &&
<span className="spacer-left">
<InternalBadge />
</span>}
{action.since &&
<span className="spacer-left badge">
since {action.since}
</span>}
{action.deprecatedSince &&
<span className="spacer-left">
<DeprecatedBadge since={action.deprecatedSince} />
</span>}
</header>
</TooltipsContainer>
<div
className="web-api-action-description markdown"
dangerouslySetInnerHTML={{ __html: action.description }}
/>
{(action.params || action.hasResponseExample) &&
<ul className="web-api-action-actions tabs">
{action.params &&
<li>
<a
className={classNames({ selected: showParams })}
href="#"
onClick={this.handleShowParamsClick}>
Parameters
</a>
</li>}
{action.hasResponseExample &&
<li>
<a
className={classNames({ selected: showResponse })}
href="#"
onClick={this.handleShowResponseClick}>
Response Example
</a>
</li>}
{action.changelog.length > 0 &&
<li>
<a
className={classNames({ selected: showChangelog })}
href="#"
onClick={this.handleChangelogClick}>
Changelog
</a>
</li>}
</ul>}
{showParams &&
action.params &&
<Params
params={action.params}
showDeprecated={this.props.showDeprecated}
showInternal={this.props.showInternal}
/>}
{showResponse &&
action.hasResponseExample &&
<ResponseExample domain={domain} action={action} />}
{showChangelog && <ActionChangelog changelog={action.changelog} />}
</div>
);
}
}
|
