1
1
[[rest-api-examples]]
2
- = Examples
2
+ = Rest API Examples
3
3
{product-author}
4
4
{product-version}
5
5
:data-uri:
10
10
11
11
toc::[]
12
12
{nbsp} +
13
- This page includes usage examples for OpenShift's REST API. The examples are
14
- presented as https://curl.haxx.se/[curl] and
15
- https://stedolan.github.io/jq/[jq] command calls. The examples are
13
+ This page includes usage examples for OpenShift's REST API. The examples are
14
+ presented as link: https://curl.haxx.se/[curl] and
15
+ link: https://stedolan.github.io/jq/[jq] command calls. The examples are
16
16
parameterised using environment variables as follows:
17
17
18
18
[options="header",cols="1,3"]
@@ -21,21 +21,21 @@ parameterised using environment variables as follows:
21
21
| Purpose
22
22
23
23
| TOKEN
24
- | Authentication token for OpenShift. If using X.509 authentication, remove
25
- lines referencing $TOKEN and provide a client certificate and key instead, e.g.
26
- via the curl `--cert` and `--key` arguments.
24
+ | Authentication token for OpenShift. If using X.509 authentication, remove lines
25
+ referencing $TOKEN and provide a client certificate and key instead. For
26
+ example, the curl `--cert` and `--key` arguments.
27
27
28
28
| ENDPOINT
29
- | TCP endpoint of OpenShift API server, e.g. 127.0.0.1:8443. Without loss of
30
- generality, in these examples it is assumed that the API server is presented via
29
+ | TCP endpoint of OpenShift API server, such as 127.0.0.1:8443. Without loss of
30
+ generality, in these examples it is assumed that the API server is presented by
31
31
HTTPS and that it may be accessed insecurely.
32
32
33
33
| NAMESPACE
34
34
| Namespace to use for namespaced objects.
35
35
|===
36
36
37
- To try out the usage examples via copy/paste, first set all of the above
38
- environment variables, e.g. as follows :
37
+ To try out the usage examples by copy/paste, first set all of the previously mentioned
38
+ environment variables, for example :
39
39
40
40
----
41
41
TOKEN=$(oc whoami -t)
@@ -48,7 +48,7 @@ NAMESPACE=$(oc config current-context | cut -d/ -f1)
48
48
49
49
<<apis-template.openshift.io/v1.Template.adoc#,Templates>> include one or more
50
50
objects to be instantiated, as well as optionally specifying parameters to be
51
- used at instantiation time. The flow to instantiate a
51
+ used at instantiation time. The flow to instantiate a
52
52
<<apis-template.openshift.io/v1.Template.adoc#,Template>> using the
53
53
<<apis-template.openshift.io/v1.TemplateInstance.adoc#,TemplateInstance>> API
54
54
follows:
0 commit comments