OpenAPI CRD user guide doc #664
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eguzki
force-pushed
the
doc-openapi-crd
branch
from
be30cb2 to
a85fe4e
Compare
Member
Author
|
/retest |
doc/openapi-user-guide.md
Outdated
| ## OpenAPI document sources | ||
|
|
||
| The OpenAPI document <OAS> can be read from different sources: | ||
| * Openshit secret |
Contributor
There was a problem hiding this comment.
Typo(:eyes:) and it should be Kubernetes Secret
doc/openapi-user-guide.md
Outdated
| fields are provided in the [OpenAPI custom resource](openapi-reference.md), | ||
| the product's deployment mode will be `APIcast self-managed`. | ||
|
|
||
| Example of a [OpenAPI custom resource](openapi-reference.md) with custom public base URL |
Contributor
There was a problem hiding this comment.
Missing : at the end
miguelsorianod
suggested changes
Sep 17, 2021
Contributor
miguelsorianod
left a comment
miguelsorianod
left a comment
There was a problem hiding this comment.
👍 , just a couple minor comments
Member
Author
|
requested changes applied. |
|
Code Climate has analyzed commit f334e44 and detected 0 issues on this pull request. View more on Code Climate. |
miguelsorianod
approved these changes
Sep 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explained how 3scale is configured from the OpenAPI document. Which parts of the OpenAPI document are used, and how, to configure 3scale.
Also added documentation about the minimum OpenAPI Document requried to configure a working 3scale product.
https://issues.redhat.com/browse/THREESCALE-4712