Skip to content

Commit cd62861

Browse files
stevsmitSteven Smith
andauthored
Addresses 9263 API request and some mod docs content types (quay#1396)
Co-authored-by: Steven Smith <[email protected]>
1 parent 46fb774 commit cd62861

38 files changed

+43
-74
lines changed

api/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ include::modules/creating-v2-oauth-access-token.adoc[leveloffset=+2]
4545
4646
//how to use the API
4747
include::modules/enabling-using-the-api.adoc[leveloffset=+1]
48-
include::modules/configuring-api-calls.adoc[leveloffset=+2]
4948
include::modules/using-the-api.adoc[leveloffset=+2]
49+
include::modules/configuring-api-calls.adoc[leveloffset=+2]
5050
include::modules/accessing-swagger-ui.adoc[leveloffset=+2]
5151
include::modules/automating-quay-using-the-api.adoc[leveloffset=+2]
5252

modules/accessing-swagger-ui.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
:_content-type: REFERENCE
1+
:_mod-docs-content-type: PROCEDURE
22
[id="accessing-swagger-ui"]
33
= Accessing {productname} Swagger UI
44

55
{productname} administrators and users can interacting with the API by using the Swagger UI-an interactive web interface that compiles executable commands. The Swagger UI can be launched as a container that points to your {productname} instance's API discovery endpoint (`/api/v1/discovery`). After deploying the container, you can access the Swagger UI, which loads the OpenAPI specification for {productname} from the specified URL. {productname} administrators and users can explore the available endpoints and their structure.
66

77
Use the following procedure to access the {productname} Swagger UI.
88

9+
.Prerequisites
10+
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
11+
912
.Procedure
1013

1114
. Enter the following command to deploy the Swagger UI container, pointing the URL to your {productname}'s API discovery endpoint. For example:

modules/adding-a-new-tag-to-image-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:_content-type: CONCEPT
1+
:_mod-docs-content-type: PROCEDURE
22
[id="adding-tags-api"]
33
= Adding a new tag to an image tag to an image by using the API
44

@@ -7,7 +7,6 @@ You can add a new tag, or restore an old one, to an image by using the API.
77
.Prerequisites
88

99
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#creating-oauth-access-token[Created an OAuth access token].
10-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1110
1211
.Procedure
1312

modules/adding-managing-labels-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:_content-type: CONCEPT
1+
:_mod-docs-content-type: PROCEDURE
22
[id="adding-managing-labels-api"]
33
= Adding and managing labels by using the API
44

@@ -7,7 +7,6 @@
77
.Prerequisites
88

99
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#creating-oauth-access-token[Created an OAuth access token].
10-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1110
1211
.Procedure
1312

modules/adjust-access-user-repo-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// * use_quay/master.adoc
55
// * quay_io/master.adoc
66

7-
:_content-type: CONCEPT
7+
:_mod-docs-content-type: PROCEDURE
88
[id="adjust-access-user-repo-api"]
99
= Adjusting access settings for a repository by using the API
1010

@@ -14,7 +14,6 @@ Use the following procedure to adjust access settings for a user or robot accoun
1414

1515
* You have created a user account or robot account.
1616
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#creating-oauth-access-token[Created an OAuth access token].
17-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1817
1918
.Procedure
2019

modules/adjusting-repository-access-via-the-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// * use_quay/master.adoc
55

6-
:_content-type: CONCEPT
6+
:_mod-docs-content-type: PROCEDURE
77
[id="adjusting-image-repository-visibility-the-api"]
88
= Adjusting repository visibility by using the API
99

@@ -12,7 +12,6 @@ The visibility of your repository can be set to `private` or `public` by using t
1212
.Prerequisites
1313

1414
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#creating-oauth-access-token[Created an OAuth access token].
15-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1615
* You have created a repository.
1716
1817
.Procedure

modules/automating-quay-using-the-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:_content-type: REFERENCE
1+
:_mod-docs-content-type: PROCEDURE
22
[id="automating-quay-using-the-api"]
33
= Automating {productname} processes by using the API
44

@@ -9,7 +9,6 @@ The following example shows you how you might use a Python script and a cron job
99
.Prerequisites
1010

1111
* You have access to the {productname} API, which entails having already created an OAuth 2 access token.
12-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1312
* You have installed the Python `requests` library using.
1413
* You have enabled cron jobs on your machine.
1514
* You have created several organization applications, including one that will not be deleted.

modules/configuring-api-calls.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1+
:_mod-docs-content-type: PROCEDURE
12
[id="configuring-api-calls"]
2-
= Configuring {productname} to accept API calls
3+
= Enabling browser-based API calls in {productname}
34

4-
Prior to using the {productname} API, you must disable `BROWSER_API_CALLS_XHR_ONLY` in your `config.yaml` file. This allows you to avoid such errors as `API calls must be invoked with an X-Requested-With header if called from a browser`.
5+
By default, {productname} accepts CURL requests from the command line. However, if you want to enable API access from a browser extension such as Postman, or a browser interface such as Swagger, you must disable `BROWSER_API_CALLS_XHR_ONLY` in your `config.yaml` file.
56

67
.Procedure
78

modules/creating-a-team-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
// * use_quay/master.adoc
44

5-
:_content-type: PROCEDURE
5+
:_mod-docs-content-type: PROCEDURE
66
[id="creating-a-team-api"]
77
= Creating a team by using the API
88

@@ -16,7 +16,6 @@ Use the following procedure to create a team for your organization repository.
1616

1717
* You have created an organization.
1818
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#creating-oauth-access-token[Created an OAuth access token].
19-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
2019
2120
.Procedure
2221

modules/creating-an-image-repository-via-the-api.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// * use_quay/master.adoc
55

6-
:_content-type: CONCEPT
6+
:_mod-docs-content-type: PROCEDURE
77
[id="creating-an-image-repository-via-the-api"]
88
= Creating a repository by using the API
99

@@ -16,7 +16,6 @@ Use the following procedure to create an image repository using the {productname
1616
.Prerequisites
1717

1818
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#creating-oauth-access-token[Created an OAuth access token].
19-
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
2019
2120
.Procedure
2221

0 commit comments

Comments
 (0)