sipwise
/
ngcp-panel
mirror of https://github.com/sipwise/ngcp-panel.git
1
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3bb5df875a'
${ noResults }
ngcp-panel/share/templates/api/root/collection.tt

422 lines
12 KiB
Raw Blame History

<h[% level %] id="[% id %]">
[% IF uri -%]
<a href="[% uri %]" rel="collection">
[% END -%]
[% title %]
[% IF uri -%]
</a>
[% END -%]
</h[% level %]>
<h[% level + 1 %]>Description</h[% level + 1%]>
[% col.description %]
[%-
#props_plain = '"id" : 1';
props_creation_first_flag = 1;
FOREACH p IN col.fields;
NEXT IF p.types.0 == 'null';
IF props_creation_first_flag;
props_creation_first_flag = 0;
ELSE;
props_plain = props_plain _ ",\n";
END;
IF p.types.0 == "Number";
val = 4;
ELSIF p.types.0 == "String";
val = '"test"';
ELSIF p.types.0 == "Boolean";
val = 'true';
ELSIF p.types.0 == "Array";
val = '[]';
ELSE;
val = '"missing"';
END;
props_plain = props_plain _ '"' _ p.name _ '" : ' _ val;
END;
props_plain = props_plain _ "\n";
IF col.sample;
props_plain = col.sample _ "\n";
END;
%]
<h[% level + 1 %]>Collection Actions</h[% level + 1%]>
Allowed methods for the collection as in <span>METHOD [% uri %]</span>:
[% UNLESS col.actions.size -%]
<br/>None.
[% ELSE -%]
<ul id="[% id %]-actions">
[% FOR a IN col.actions -%]
<li>[% a %]</li>
[% END -%]
</ul>
[% END -%]
<h[% level + 1 %]>Item Actions</h[% level + 1%]>
Allowed methods for a collection item as in <span>METHOD [% uri %]id</span>:
[% UNLESS col.item_actions.size -%]
<br/>None.
[% ELSE -%]
<ul id="[% id %]-itemactions">
[% FOR a IN col.item_actions -%]
<li>[% a %]</li>
[% END -%]
</ul>
[% END -%]
<h[% level + 1 %]>Properties</h[% level + 1%]>
[% UNLESS col.fields.size -%]
See description how to obtain properties, if any.
[% ELSE -%]
<ul id="[% id %]-props">
[% FOREACH f IN col.fields -%]
<li><b>[% f.name %] </b>(<i>[% f.types.join(', ') %]</i>): [% f.description %]</li>
[% END -%]
</ul>
[% END -%]
<h[% level + 1 %]>Query Parameters</h[% level + 1%]>
<ul id="[% id %]-qparams">
[% FOREACH f IN col.query_params -%]
<li><b>[% f.param %]</b>: [% f.description %]</li>
[% END -%]
<li><b>order_by</b>: Order collection by a specific attribute. Possible values are: <i>[% col.sorting_cols.join(', ') %]</i></li>
<li><b>order_by_direction</b>: Direction which the collection should be ordered by. Possible values are: <i>asc (default), desc</i></li>
</ul>
<h[% level + 1 %]>Examples</h[% level + 1 %]>
<div class="examples">
[% IF col.actions.grep('^OPTIONS$').size -%]
<h[% level + 2 %]>Request available HTTP methods on the URI</h[% level + 2 %]>
<p>
[%
cmd = 'curl -i -X OPTIONS -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem https://example.org:1443' _ uri;
INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
request =
'OPTIONS /api/' _ id _ '/ HTTP/1.1';
response =
'HTTP/1.1 200 OK
Allow: GET, HEAD, OPTIONS, POST
Accept-Post: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/#rel-' _ id _ '"';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
-%]
</p>
[% END -%]
[% IF col.actions.grep('^GET$').size -%]
<h[% level + 2 %]>Request the entire <i>[% id %]</i> collection</h[% level + 2 %]>
<p>
<p>
You cannot request the entire collection at once, but instead you can simply page through the results. The response provides <i>prev</i> and <i>next</i> links you can follow to get the next page.
To define the page number and the rows per page to return, you can pass the parameters <i>page</i> and <i>rows</i>. Default values are <i>page=1</i> and <i>rows=10</i>, if you do not provide them.
</p>
[%
cmd = 'curl -i -X GET -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/?page=1&rows=1\'';
INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
props = props_plain | indent(12);
request =
'GET /api/' _ id _ '/?page=1&rows=1 HTTP/1.1';
response =
'HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/"
{
"_embedded" : {
"ngcp:' _ id _ '" : [
{
"_links" : {
"collection" : {
"href" : "/api/' _ id _ '/"
},
"curies" : {
"href" : "http://purl.org/sipwise/ngcp-api/#rel-{rel}",
"name" : "ngcp",
"templated" : true
},
"profile" : {
"href" : "http://purl.org/sipwise/ngcp-api/"
},
"self" : {
"href" : "/api/' _ id _ '/1"
}
},
' _ props _ ' },
]
},
"_links" : {
"curies" : {
"href" : "http://purl.org/sipwise/ngcp-api/#rel-{rel}",
"name" : "ngcp",
"templated" : true
},
"next" : {
"href" : "/api/' _ id _ '/?page=2&rows=1"
},
"ngcp:' _ id _ '" : [
{
"href" : "/api/' _ id _ '/1"
},
],
"profile" : {
"href" : "http://purl.org/sipwise/ngcp-api/"
},
"self" : {
"href" : "/api/' _ id _ '/?page=1&rows=1"
}
},
"total_count" : 100
}';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
-%]
</p>
[% END -%]
[% IF col.item_actions.grep('^GET$').size -%]
<h[% level + 2 %]>Request a specific <i>[% id %]</i> item</h[% level + 2 %]>
<p>
[%
cmd = 'curl -i -X GET -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/1\'';
INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
props = props_plain | indent(3);
request =
'GET /api/' _ id _ '/1 HTTP/1.1';
response =
'HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/"
Link: </api/' _ id _ '/>; rel=collection
Link: <http://purl.org/sipwise/ngcp-api/>; rel=profile
Link: </api/' _ id _ '/1>; rel="item self"
{
"_links" : {
"collection" : {
"href" : "/api/' _ id _ '/"
},
"curies" : {
"href" : "http://purl.org/sipwise/ngcp-api/#rel-{rel}",
"name" : "ngcp",
"templated" : true
},
"profile" : {
"href" : "http://purl.org/sipwise/ngcp-api/"
},
"self" : {
"href" : "/api/' _ id _ '/1"
}
},
' _ props _ ' }';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
-%]
</p>
[% END -%]
[% IF col.actions.grep('^POST$').size -%]
<h[% level + 2 %]>Create a new <i>[% id %]</i> item</h[% level + 2 %]>
<p>
[%
props = props_plain | collapse;
cmd = 'curl -i -X POST -H \'Connection: close\' -H \'Content-Type: application/json\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/\' --data-binary \'{ ' _ props _ ' }\'';
INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
props = props_plain | indent(3);
request =
'POST /api/' _ id _ '/ HTTP/1.1
Content-Type: application/json
{
' _ props _ '}';
response =
'HTTP/1.1 201 Created
Location: /api/' _ id _ '/2';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
%]
</p>
[% END -%]
[% IF col.item_actions.grep('^PUT$').size -%]
<h[% level + 2 %]>Update an existing <i>[% id %]</i> item</h[% level + 2 %]>
<p>
[%
props = props_plain | collapse;
cmd = 'curl -i -X PUT -H \'Connection: close\' -H \'Content-Type: application/json\' -H \'Prefer: return=minimal\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/2\' --data-binary \'{ ' _ props _ ' }\'';
INCLUDE helpers/api_command.tt cmd=cmd extended=1 level=level+3;
props = props_plain | indent(3);
request =
'PUT /api/' _ id _ '/2 HTTP/1.1
Content-Type: application/json
Prefer: return=minimal
{
' _ props _ '}';
response =
'HTTP/1.1 204 No Content
Preference-Applied: return=minimal';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
-%]
</p>
[% END -%]
[% IF col.item_actions.grep('^PATCH$').size -%]
<h[% level + 2 %]>Update specific fields of an existing <i>[% id %]</i> item</h[% level + 2 %]>
<p>
[%
props = ''; rem = 0; rep = 0;
FOREACH p IN col.fields;
type = p.types.0;
IF type == 'null';
NEXT IF rem >= 1;
op = "remove";
type = p.types.1;
rem = rem + 1;
ELSE;
NEXT IF rep >= 1;
op = "replace";
rep = rep + 1;
END;
IF type == "Number";
val = 5;
ELSIF type == "String";
val = '"other"';
ELSIF type == "Boolean";
val = 'false';
ELSIF type == "Array";
val = '[]';
ELSE;
val = '"missing"';
END;
props = props _ '{ ';
props = props _ '"op" : "' _ op _ '", "path" : "/' _ p.name _ '"';
UNLESS op == "remove";
props = props _ ', "value" : ' _ val;
END;
props = props _ ' }, ';
LAST IF rep >= 1 && rem >= 1;
END;
props = props.substr(0, props.length - 2);
cmd = 'curl -i -X PATCH -H \'Connection: close\' -H \'Content-Type: application/json-patch+json\' -H \'Prefer: return=minimal\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/2\' --data-binary \'[ ' _ props _ ' ]\'';
INCLUDE helpers/api_command.tt cmd=cmd extended=1 level=level+3;
%]
<p>
The PATCH method allows to operate on specific fields of an item. The <b>path</b> attribute can point to a normal property (e.g. /something) or to a specific element in an array (e.g. /something/0). Available <b>op</b> values are:
<ul>
<li>
<b>remove</b>
<p>Removes the property pointed to by <b>path</b>. You can point to a normal property (e.g. /something) or to a specific element in an array (e.g. /something/0).</p>
</li>
<li>
<b>replace</b>
<p>Replaces the value pointed to by <b>path</b> by the new value passed via <b>value</b>.</p>
</li>
<li>
<b>add</b>
<p>Adds a new property <b>path</b> by the new value passed via <b>value</b>.</p>
</li>
<li>
<b>copy, move</b>
<p>Copies or moves (copy, then remove) the value from property defined by <b>from</b> to the propery defined by <b>path</b>.</p>
</li>
</ul>
</p>
[%
props = ''; rem = 0; rep = 0;
FOREACH p IN col.fields;
type = p.types.0;
IF type == 'null';
NEXT IF rem >= 1;
op = "remove";
type = p.types.1;
rem = rem + 1;
ELSE;
NEXT IF rep >= 1;
op = "replace";
rep = rep + 1;
END;
IF type == "Number";
val = 5;
ELSIF type == "String";
val = '"other"';
ELSIF type == "Boolean";
val = 'false';
ELSIF type == "Array";
val = '[]';
ELSE;
val = '"missing"';
END;
props = props _ '
{
';
props = props _ ' "op" : "' _ op _ '",
"path" : "/' _ p.name _ '"';
UNLESS op == "remove";
props = props _ ',
"value" : ' _ val;
END;
props = props _ '
}, ';
LAST IF rep >= 1 && rem >= 1;
END;
props = props.substr(0, props.length - 2);
request =
'PATCH /api/' _ id _ '/2 HTTP/1.1
Content-Type: application/json-patch+json
Prefer: return=minimal
[' _ props _ '
]';
response =
'HTTP/1.1 204 No Content
Preference-Applied: return=minimal';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
-%]
</p>
[% END -%]
[% IF col.item_actions.grep('^DELETE$').size -%]
<h[% level + 2 %]>Delete a specific <i>[% id %]</i> item</h[% level + 2 %]>
<p>
[%
cmd = 'curl -i -X DELETE -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/1\'';
INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
request =
'DELETE /api/' _ id _ '/1 HTTP/1.1';
response =
'HTTP/1.1 204 No Content';
INCLUDE helpers/api_req_res.tt request=request response=response level=level+3;
-%]
</p>
[% END -%]
</div>
[% # vim: set tabstop=4 syntax=html expandtab: -%]
Reference in new issue View Git Blame Copy Permalink