-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[readme] Add api documentation link #203
Conversation
Generated by 🚫 Danger |
README.md
Outdated
@@ -159,6 +159,10 @@ RMT is replacing some functionality of [SMT](https://github.com/SUSE/smt). Follo | |||
<a name="staging">1</a>: Functionality is offered by [SUSE Manager](https://www.suse.com/documentation/suse-best-practices/susemanager/data/susemanager.html) | |||
<a name="res">2</a>: RES support is planned for SLES15 SP1 | |||
|
|||
## API documentation | |||
|
|||
The documentation about the implemented SCC API can be found [here](https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could it say something like RMT partially implements [SUSE Customer Center API](link)
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure
83b0f41
to
2ed36f7
Compare
README.md
Outdated
@@ -159,6 +159,10 @@ RMT is replacing some functionality of [SMT](https://github.com/SUSE/smt). Follo | |||
<a name="staging">1</a>: Functionality is offered by [SUSE Manager](https://www.suse.com/documentation/suse-best-practices/susemanager/data/susemanager.html) | |||
<a name="res">2</a>: RES support is planned for SLES15 SP1 | |||
|
|||
## API documentation | |||
|
|||
RMT partially implements the [SUSE Customer API](https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md). Make sure to checkout the `Differences in RMT, SMT and SCC API` to check which API endpoints are not supported by RMT. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SUSE Customer API
-> SUSE Customer Center API
😬
2ed36f7
to
c4cd232
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
README.md
Outdated
@@ -159,6 +159,10 @@ RMT is replacing some functionality of [SMT](https://github.com/SUSE/smt). Follo | |||
<a name="staging">1</a>: Functionality is offered by [SUSE Manager](https://www.suse.com/documentation/suse-best-practices/susemanager/data/susemanager.html) | |||
<a name="res">2</a>: RES support is planned for SLES15 SP1 | |||
|
|||
## API documentation | |||
|
|||
RMT partially implements the [SUSE Customer Center API](https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md). Make sure to checkout the `Differences in RMT, SMT and SCC API` to check which API endpoints are not supported by RMT. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could just link Differences in RMT, SMT and SCC API
right to the paragraph with https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md#differences-in-rmt-smt-and-scc-api
.
c4cd232
to
914d60e
Compare
No description provided.