Skip to content

Commit 5e025ea

Browse files
committed
PR5050-Follow-up Minor Edits
1 parent d3e4e32 commit 5e025ea

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

rest_api/examples.adoc

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[rest-api-examples]]
2-
= Examples
2+
= Rest API Examples
33
{product-author}
44
{product-version}
55
:data-uri:
@@ -10,9 +10,9 @@
1010

1111
toc::[]
1212
{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
1616
parameterised using environment variables as follows:
1717

1818
[options="header",cols="1,3"]
@@ -21,21 +21,21 @@ parameterised using environment variables as follows:
2121
| Purpose
2222

2323
| 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.
2727

2828
| 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
3131
HTTPS and that it may be accessed insecurely.
3232

3333
| NAMESPACE
3434
| Namespace to use for namespaced objects.
3535
|===
3636

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:
3939

4040
----
4141
TOKEN=$(oc whoami -t)
@@ -48,7 +48,7 @@ NAMESPACE=$(oc config current-context | cut -d/ -f1)
4848

4949
<<apis-template.openshift.io/v1.Template.adoc#,Templates>> include one or more
5050
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
5252
<<apis-template.openshift.io/v1.Template.adoc#,Template>> using the
5353
<<apis-template.openshift.io/v1.TemplateInstance.adoc#,TemplateInstance>> API
5454
follows:

0 commit comments

Comments
 (0)