Skip to content

Commit

Permalink
Fix producty attr in rn (#1158)
Browse files Browse the repository at this point in the history
* Fix producty attr in rn

* Updates Quay api guide preface

---------

Co-authored-by: Steven Smith <stevsmit@stevsmit-thinkpadt14gen4.remote.csb>
  • Loading branch information
stevsmit and Steven Smith authored Nov 12, 2024
1 parent a0739fd commit 68cd399
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
27 changes: 15 additions & 12 deletions api/master.adoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
:_content-type: ASSEMBLY


include::modules/attributes.adoc[]

[id="api"]
= {productname} API guide

= {productname} API Guide
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.

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}.
{productname} follows Semantic Versioning (SemVer) principles, ensuring predictable API stability across releases, such as:

{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:
* *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_.
* Major versions of {productname} might include incompatible API changes. For example, the API of {productname} 2.0 differs from {productname} 3.0.
* Minor versions of {productname}, for example, 3.y, adds functionality in a backwards compatible manner.
* Patch versions of {productname}, for example, 3.y.z, introduces backwards compatible bug fixes.
* *Minor releases*: Add new functionality in a backward-compatible manner. For example, a _3.y_ release adds functionality to the version _3._ release.
Currently, {productname} uses the `api/v1` endpoint for 3.y.z releases.
* *Patch releases*: Deliver bug fixes and improvements while preserving backward compatibility with minor releases, such as _3.y.z_.
This guide describes the `api/v1` endpoints and the browser-based examples for accessing those endpoints.
The following guide describes the {productname} API in more detail, and provides details on the following topics:

include::modules/proc_use-api.adoc[leveloffset=+1]
* OAuth 2 access tokens and how they compare to traditional API tokens and {productname}'s robot tokens
* Generating an OAuth 2 access token
* Best practices for token management
* OAuth 2 access token capabilities
* Using the {productname} API
* {productname} API configuration examples
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.
include::modules/proc_use-api.adoc[leveloffset=+1]
== {productname} Application Programming Interface (API)
[id="ref-api-quay"]
Expand Down
2 changes: 1 addition & 1 deletion modules/rn_3_13_0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ spec:
volumeSize: <volume_size>
----

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

[id="new-features-and-enhancements-313"]
== {productname} new features and enhancements
Expand Down

0 comments on commit 68cd399

Please sign in to comment.