Skip to content

Commit 68cd399

Browse files
stevsmitSteven Smith
andauthored
Fix producty attr in rn (quay#1158)
* Fix producty attr in rn * Updates Quay api guide preface --------- Co-authored-by: Steven Smith <[email protected]>
1 parent a0739fd commit 68cd399

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

api/master.adoc

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
:_content-type: ASSEMBLY
2-
3-
42
include::modules/attributes.adoc[]
5-
63
[id="api"]
4+
= {productname} API guide
75

8-
= {productname} API Guide
6+
The {productname} application programming interface (API) provides a comprehensive, RESTful interface for managing and automating tasks within {productname}. Designed around the link:https://oauth.net/2/[_OAuth 2.0 protocol_], this API enables secure, fine-grained access to {productname} resources, and allows administrators and users to perform such actions as creating repositories, managing images, setting permissions, and more.
97

10-
The {productname} application programming interface (API) is an OAuth 2 RESTful API that consists of a set of endpoints for adding, displaying, changing and deleting features for {productname}.
8+
{productname} follows Semantic Versioning (SemVer) principles, ensuring predictable API stability across releases, such as:
119

12-
{productname} abides by the link:https://semver.org/#summary[Semantic Versioning (SemVer) specifications]. The following conditions are met with each major, minor, and patch release:
10+
* *Major releases*: Introduce new capabilities. Might include breaking changes to API compatibility. For example, the API of {productname} _2.0_ differs from {productname} _3.0_.
1311
14-
* Major versions of {productname} might include incompatible API changes. For example, the API of {productname} 2.0 differs from {productname} 3.0.
15-
* Minor versions of {productname}, for example, 3.y, adds functionality in a backwards compatible manner.
16-
* Patch versions of {productname}, for example, 3.y.z, introduces backwards compatible bug fixes.
12+
* *Minor releases*: Add new functionality in a backward-compatible manner. For example, a _3.y_ release adds functionality to the version _3._ release.
1713
18-
Currently, {productname} uses the `api/v1` endpoint for 3.y.z releases.
14+
* *Patch releases*: Deliver bug fixes and improvements while preserving backward compatibility with minor releases, such as _3.y.z_.
1915
20-
This guide describes the `api/v1` endpoints and the browser-based examples for accessing those endpoints.
16+
The following guide describes the {productname} API in more detail, and provides details on the following topics:
2117

22-
include::modules/proc_use-api.adoc[leveloffset=+1]
18+
* OAuth 2 access tokens and how they compare to traditional API tokens and {productname}'s robot tokens
19+
* Generating an OAuth 2 access token
20+
* Best practices for token management
21+
* OAuth 2 access token capabilities
22+
* Using the {productname} API
23+
* {productname} API configuration examples
2324
25+
This guide is accompanied with a second guide, . . ., that provides information about all `api/v1` endpoints and how to access those endpoints with example commands.
2426
27+
include::modules/proc_use-api.adoc[leveloffset=+1]
2528
2629
== {productname} Application Programming Interface (API)
2730
[id="ref-api-quay"]

modules/rn_3_13_0.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ spec:
5050
volumeSize: <volume_size>
5151
----
5252

53-
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html/upgrade_red_hat_quay/index[Upgrade {productname}].
53+
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html/upgrade_red_hat_quay/index[Upgrade {productname}].
5454

5555
[id="new-features-and-enhancements-313"]
5656
== {productname} new features and enhancements

0 commit comments

Comments
 (0)