Skip to content

Commit 65a4298

Browse files
uttamukkojiuttamukkoji
committed
API documentation
1 parent 01f78b6 commit 65a4298

32 files changed

+4876
-1614
lines changed

‎api_reference/Contentstack.html‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@
2424
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
2525
})(window,document,'script','dataLayer','GTM-WGP99J7');</script>
2626
<!-- End Google Tag Manager -->
27-
27+
2828

2929
</head>
3030

3131
<body id="namespace" data-name="namespace:Contentstack" data-root-path="">
3232
<!-- Google Tag Manager (noscript) -->
3333
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
3434
<!-- End Google Tag Manager (noscript) -->
35-
<div id="content">
35+
<div id="content">
3636
<div id="left-column">
3737
<div id="control-panel">
3838
<script>
@@ -89,7 +89,7 @@ <h1>Contentstack</h1>
8989

9090
<h2>Namespaces</h2>
9191
<div class="namespace-list">
92-
<a href="Contentstack/Error.html">Contentstack\Error</a><a href="Contentstack/Result.html">Contentstack\Result</a><a href="Contentstack/Stack.html">Contentstack\Stack</a> </div>
92+
<a href="Contentstack/Error.html">Contentstack\Error</a><a href="Contentstack/Result.html">Contentstack\Result</a><a href="Contentstack/Stack.html">Contentstack\Stack</a><a href="Contentstack/Support.html">Contentstack\Support</a> </div>
9393

9494
<h2>Classes</h2>
9595

@@ -100,7 +100,16 @@ <h2>Classes</h2>
100100

101101
</div>
102102
<div class="col-md-6">
103-
103+
Contentstack abstract class to provide access to Stack Object
104+
</div>
105+
</div>
106+
<div class="row">
107+
<div class="col-md-6">
108+
<a href="Contentstack/ContentstackRegion.html"><abbr title="Contentstack\ContentstackRegion">ContentstackRegion</abbr></a>
109+
110+
</div>
111+
<div class="col-md-6">
112+
Contentstack Regions
104113
</div>
105114
</div>
106115
</div>

‎api_reference/Contentstack/Contentstack.html‎

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,15 @@
2424
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
2525
})(window,document,'script','dataLayer','GTM-WGP99J7');</script>
2626
<!-- End Google Tag Manager -->
27-
27+
2828

2929
</head>
3030

3131
<body id="class" data-name="class:Contentstack_Contentstack" data-root-path="../">
32-
<div id="content">
32+
<!-- Google Tag Manager (noscript) -->
33+
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
34+
<!-- End Google Tag Manager (noscript) -->
35+
<div id="content">
3336
<div id="left-column">
3437
<div id="control-panel">
3538
<script>
@@ -94,6 +97,8 @@ <h1>
9497

9598

9699

100+
<div class="description">
101+
<p>Contentstack abstract class to provide access to Stack Object</p> </div>
97102

98103

99104

@@ -103,13 +108,12 @@ <h2>Methods</h2>
103108
<div class="container-fluid underlined">
104109
<div class="row">
105110
<div class="col-md-2 type">
106-
static&nbsp;
111+
static&nbsp;<a href="../Contentstack/Stack/Stack.html"><abbr title="Contentstack\Stack\Stack">Stack</abbr></a>
107112
</div>
108113
<div class="col-md-8 type">
109-
<a href="#method_Stack">Stack</a>($api_key = &#039;&#039;, $access_token = &#039;&#039;, $environment = &#039;&#039;, $region = &#039;&#039;)
114+
<a href="#method_Stack">Stack</a>(string $api_key = &#039;&#039;, string $access_token = &#039;&#039;, string $environment = &#039;&#039;, <a href="../Contentstack/ContentstackRegion.html"><abbr title="Contentstack\ContentstackRegion">ContentstackRegion</abbr></a> $region = &#039;&#039;)
110115

111-
<p class="no-description">No description</p>
112-
</div>
116+
<p>Static method for the Stack constructor</p> </div>
113117
<div class="col-md-2"></div>
114118
</div>
115119
</div>
@@ -120,42 +124,53 @@ <h2>Details</h2>
120124
<div id="method-details">
121125
<div class="method-item">
122126
<h3 id="method_Stack">
123-
<div class="location">at line 20</div>
124-
<code> static
125-
<strong>Stack</strong>($api_key = &#039;&#039;, $access_token = &#039;&#039;, $environment = &#039;&#039;, $region = &#039;&#039;)
127+
<div class="location">at line 44</div>
128+
<code> static <a href="../Contentstack/Stack/Stack.html"><abbr title="Contentstack\Stack\Stack">Stack</abbr></a>
129+
<strong>Stack</strong>(string $api_key = &#039;&#039;, string $access_token = &#039;&#039;, string $environment = &#039;&#039;, <a href="../Contentstack/ContentstackRegion.html"><abbr title="Contentstack\ContentstackRegion">ContentstackRegion</abbr></a> $region = &#039;&#039;)
126130
</code>
127131
</h3>
128132
<div class="details">
129133

130134

131135

136+
<div class="method-description">
137+
<p>Static method for the Stack constructor</p> </div>
132138
<div class="tags">
133139
<h4>Parameters</h4>
134140

135141
<table class="table table-condensed">
136142
<tr>
137-
<td></td>
143+
<td>string</td>
138144
<td>$api_key</td>
139-
<td></td>
145+
<td>: Contentstack Stack API KEY.</td>
140146
</tr>
141147
<tr>
142-
<td></td>
148+
<td>string</td>
143149
<td>$access_token</td>
144-
<td></td>
150+
<td>: Contentstack Stack ACCESS TOKEN.</td>
145151
</tr>
146152
<tr>
147-
<td></td>
153+
<td>string</td>
148154
<td>$environment</td>
149-
<td></td>
155+
<td>: Environment Name.</td>
150156
</tr>
151157
<tr>
152-
<td></td>
158+
<td><a href="../Contentstack/ContentstackRegion.html"><abbr title="Contentstack\ContentstackRegion">ContentstackRegion</abbr></a></td>
153159
<td>$region</td>
154-
<td></td>
160+
<td>: Region name of Contentstack.</td>
155161
</tr>
156162
</table>
157163

158164

165+
<h4>Return Value</h4>
166+
167+
<table class="table table-condensed">
168+
<tr>
169+
<td><a href="../Contentstack/Stack/Stack.html"><abbr title="Contentstack\Stack\Stack">Stack</abbr></a></td>
170+
<td></td>
171+
</tr>
172+
</table>
173+
159174

160175

161176
</div>

api_reference/ContentstackRegion.html renamed to api_reference/Contentstack/ContentstackRegion.html

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,19 @@
33
<head>
44
<meta charset="UTF-8" />
55
<meta name="robots" content="index, follow, all" />
6-
<title>ContentstackRegion | API</title>
6+
<title>Contentstack\ContentstackRegion | API</title>
77

8-
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
9-
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
10-
<link rel="stylesheet" type="text/css" href="css/sami.css">
8+
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
9+
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
10+
<link rel="stylesheet" type="text/css" href="../css/sami.css">
1111
<link rel="canonical" href="https://www.contentstack.com/docs/platforms/php/api-reference/" />
12-
<script src="js/jquery-1.11.1.min.js"></script>
13-
<script src="js/bootstrap.min.js"></script>
14-
<script src="js/typeahead.min.js"></script>
15-
<script src="sami.js"></script>
12+
<script src="../js/jquery-1.11.1.min.js"></script>
13+
<script src="../js/bootstrap.min.js"></script>
14+
<script src="../js/typeahead.min.js"></script>
15+
<script src="../sami.js"></script>
1616
<meta name="MobileOptimized" content="width">
1717
<meta name="HandheldFriendly" content="true">
1818
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
19-
<link rel="shortcut icon" href="./favicon.ico">
2019
<!-- Google Tag Manager -->
2120
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
2221
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
@@ -28,17 +27,17 @@
2827

2928
</head>
3029

31-
<body id="class" data-name="class:ContentstackRegion" data-root-path="">
32-
<!-- Google Tag Manager (noscript) -->
33-
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
34-
<!-- End Google Tag Manager (noscript) -->
35-
<div id="content">
30+
<body id="class" data-name="class:Contentstack_ContentstackRegion" data-root-path="../">
31+
<!-- Google Tag Manager (noscript) -->
32+
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
33+
<!-- End Google Tag Manager (noscript) -->
34+
<div id="content">
3635
<div id="left-column">
3736
<div id="control-panel">
3837
<script>
3938
$('option[data-version="'+window.projectVersion+'"]').prop('selected', true);
4039
</script>
41-
<form id="search-form" action="search.html" method="GET">
40+
<form id="search-form" action="../search.html" method="GET">
4241
<span class="glyphicon glyphicon-search"></span>
4342
<input name="search"
4443
class="typeahead form-control"
@@ -60,22 +59,28 @@
6059
<span class="icon-bar"></span>
6160
<span class="icon-bar"></span>
6261
</button>
63-
<a class="navbar-brand" href="index.html">API</a>
62+
<a class="navbar-brand" href="../index.html">API</a>
6463
</div>
6564
<div class="collapse navbar-collapse" id="navbar-elements">
6665
<ul class="nav navbar-nav">
67-
<li><a href="classes.html">Classes</a></li>
68-
<li><a href="namespaces.html">Namespaces</a></li>
69-
<li><a href="interfaces.html">Interfaces</a></li>
70-
<li><a href="traits.html">Traits</a></li>
71-
<li><a href="doc-index.html">Index</a></li>
72-
<li><a href="search.html">Search</a></li>
66+
<li><a href="../classes.html">Classes</a></li>
67+
<li><a href="../namespaces.html">Namespaces</a></li>
68+
<li><a href="../interfaces.html">Interfaces</a></li>
69+
<li><a href="../traits.html">Traits</a></li>
70+
<li><a href="../doc-index.html">Index</a></li>
71+
<li><a href="../search.html">Search</a></li>
7372
</ul>
7473
</div>
7574
</div>
7675
</nav>
7776

78-
<div id="page-content">
77+
<div class="namespace-breadcrumbs">
78+
<ol class="breadcrumb">
79+
<li><span class="label label-default">class</span></li>
80+
<li><a href="../Contentstack.html">Contentstack</a></li><li class="backslash">\</li><li>ContentstackRegion</li>
81+
</ol>
82+
</div>
83+
<div id="page-content">
7984

8085
<div class="page-header">
8186
<h1>
@@ -91,6 +96,8 @@ <h1>
9196

9297

9398

99+
<div class="description">
100+
<p>Contentstack Regions</p> </div>
94101

95102

96103
<h2>Constants</h2>

‎api_reference/Contentstack/Error.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@
2424
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
2525
})(window,document,'script','dataLayer','GTM-WGP99J7');</script>
2626
<!-- End Google Tag Manager -->
27-
27+
2828

2929
</head>
3030

3131
<body id="namespace" data-name="namespace:Contentstack_Error" data-root-path="../">
3232
<!-- Google Tag Manager (noscript) -->
3333
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
3434
<!-- End Google Tag Manager (noscript) -->
35-
<div id="content">
35+
<div id="content">
3636
<div id="left-column">
3737
<div id="control-panel">
3838
<script>
@@ -99,7 +99,8 @@ <h2>Exceptions</h2>
9999

100100
</div>
101101
<div class="col-md-6">
102-
102+
CSException
103+
CSException Class is used to wrap the REST API error
103104
</div>
104105
</div>
105106
</div>

0 commit comments

Comments
 (0)