Update the URL for Service Registry core REST API Reference and Kafka…#341
Merged
ajaypratap003 merged 1 commit intoredhat-developer:mainfrom Oct 13, 2021
Merged
Conversation
… Service Fleet Manager API Reference
Contributor
Author
|
cc @jgiardino |
wtrocki
reviewed
Oct 12, 2021
| description: Learn how to use the Apicurio Registry core REST API to manage the contents of a Service Registry instance. | ||
| link: | ||
| href: https://www.apicur.io/registry/docs/apicurio-registry/2.0.1.Final/assets-attachments/registry-rest-api.htm | ||
| href: https://www.apicur.io/registry/docs/apicurio-registry/2.1.0.Final/assets-attachments/registry-rest-api.htm |
Collaborator
There was a problem hiding this comment.
@jsenko @carlesarnal Do we have cloud.redhat.com hosted openapi doc same like for srs control plane?
There was a problem hiding this comment.
@wtrocki I don't understand if your comment requires any updates in this PR. Can you clarify your comment?
Collaborator
There was a problem hiding this comment.
No need for updates in this PR. This was more question to SRS team if they have plans to push their API. All our backend APIs should be available thru: https://api.openshift.com webpage etc.
Contributor
There was a problem hiding this comment.
@wtrocki When I asked about publishing the SR data plane API on https://api.openshift.com, the decision was that it was not suitable (only control plane APIs published there). Possible future solutions would be to publish this REST API doc in the SR UI itself or on https://console.redhat.com/beta/docs/api.
Collaborator
There was a problem hiding this comment.
@wtrocki @smccarthy-ie is right. We decided to not publish that API there since is not hosted under https://api.openshift.com. We need to find a good place for that OpenApi and maybe that place is the documentation itself.
Contributor
There was a problem hiding this comment.
@carlesarnal The Pantheon v2 system used to publish the RHOSR docs does not support publishing REST APIs, so our current options are publishing in the RHOSR UI, https://console.redhat.com/beta/docs/api, or keep linking to the upstream docs like we do now.
jgiardino
approved these changes
Oct 12, 2021
jgiardino
left a comment
jgiardino
left a comment
There was a problem hiding this comment.
The URLs match what @smccarthy-ie provided! Thanks for making the updates.
wtrocki
approved these changes
Oct 12, 2021
smccarthy-ie
approved these changes
Oct 13, 2021
Contributor
|
@hemahg @jgiardino LGTM, thanks! |
carlesarnal
approved these changes
Oct 13, 2021
smccarthy-ie
pushed a commit
to smccarthy-ie/app-services-guides
that referenced
this pull request
Oct 15, 2021
… Service Fleet Manager API Reference (redhat-developer#341)
smccarthy-ie
added a commit
that referenced
this pull request
Oct 15, 2021
* clean up draft of service registry quarkus quick start from bilgin * update section IDs to fix quick start build errors, minor edits * add changes to simplify code example in PR 327 * add final step to view generated schemas * clarify separate consumer and producer processes * pick up new attributes * adding technical review feedback from carles and wojciech * adding technical review feedback from carles and wojciech * add OAUTH_SERVER_URL and OAUTH_REALM env vars required for now until quarkus is updated * add correct SR icon, QE and peer review feedback * regen attributes for new guides * regen attributes for new cli guides * Simplify registry quickstart (#327) * Service registry RHOAS CLI (#324) * docs: initial version of the guide * fix: restructure tutorial content for better alignment for RHOAS CLI * docs: service registry cli guide Signed-off-by: prmellor <pmellor@redhat.com> * docs: service registry cli guide Signed-off-by: prmellor <pmellor@redhat.com> * fix: remove confusing sentence Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * docs: add abstract to procedures Signed-off-by: prmellor <pmellor@redhat.com> * fix: build issue * docs: service registry instance without defaults Signed-off-by: prmellor <pmellor@redhat.com> * fix: add mixxing version from consumer config * docs: remove angle brackets from example Signed-off-by: prmellor <pmellor@redhat.com> * docs: change keys Signed-off-by: prmellor <pmellor@redhat.com> * fix: another duplicated key * Update rhoas-cli-kafka/README.adoc * Update rhoas-cli-service-registry/README.adoc Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * fix: build issue * docs: review edits BI Signed-off-by: prmellor <pmellor@redhat.com> * docs: review edits WT for name command Signed-off-by: prmellor <pmellor@redhat.com> Co-authored-by: Wojciech Trocki <wtrocki@redhat.com> * docs: updated readme with new CLI doc (#329) Signed-off-by: prmellor <pmellor@redhat.com> * docs: cli guide mod doc fix (#330) Signed-off-by: prmellor <pmellor@redhat.com> * Add basic metrics section in getting started QS. (#332) * Add basic metrics section in getting started QS. * SME review from Duncan * Peer tweaks * docs: fix links in CLI guides (#334) * docs: fix links in CLI guides Signed-off-by: prmellor <pmellor@redhat.com> * cli command updates Signed-off-by: prmellor <pmellor@redhat.com> * review edits RK Signed-off-by: prmellor <pmellor@redhat.com> * return wget to step Signed-off-by: prmellor <pmellor@redhat.com> * Add access mgmt content. (#325) * fix: ./kafka-console-consumer.sh cmd line (#337) Tested with Kafka 2.8.1 and the correct option is: ``` --consumer.config <String: config file> Consumer config properties file. Note that [consumer-property] takes precedence over this config. ``` * Remove name from service account commands (#336) * Rethinking metrics approach (#339) * Rethinking metrics approach * Tweak metrics section * John feedback * Added missing dash to kafka-console-consumer command. (#335) * Fix the pom.xml files for quarkus-service-registry-quickstart (#343) * Update the url for Service Registry core REST API Reference and Kafka Service Fleet Manager API Reference (#341) * Add placeholder values registry quickstart (#333) * Check installation and version of rhoas CLI on Windows (#338) * fix: add kafka access management for rhoas cli (#342) * fix: add kafka acl commands * fix: add note about cli reference doc * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * Update rhoas-cli-kafka/README.adoc Co-authored-by: Ramakrishna Pattnaik <rkpattnaik780@gmail.com> * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * Update README.adoc * fix: add acl bullet * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> * Update rhoas-cli-kafka/README.adoc * Update rhoas-cli-kafka/README.adoc Co-authored-by: Ramakrishna Pattnaik <rkpattnaik780@gmail.com> * Update rhoas-cli-kafka/README.adoc * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Co-authored-by: Ramakrishna Pattnaik <rkpattnaik780@gmail.com> * Add missing links to getting started (#347) * rebase for recently added new guides Co-authored-by: Carles Arnal <carlesarnal92@gmail.com> Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Co-authored-by: Wojciech Trocki <wtrocki@redhat.com> Co-authored-by: Stetson Robinson <sterobin@redhat.com> Co-authored-by: Davide Bizzarri <david3bizzarri@gmail.com> Co-authored-by: Enda <ephelan@redhat.com> Co-authored-by: Duncan Doyle <Duncan.Doyle@gmail.com> Co-authored-by: Eric Wittmann <eric.wittmann@gmail.com> Co-authored-by: HemaHG <53568062+HemaHG@users.noreply.github.com> Co-authored-by: Carles Arnal <carnalca@redhat.com> Co-authored-by: rkubis <rkubis@redhat.com> Co-authored-by: Ramakrishna Pattnaik <rkpattnaik780@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
Update the URL for Service Registry core REST API Reference and Kafka Service Fleet Manager API Reference