-
Notifications
You must be signed in to change notification settings - Fork 2
Improve READMEs #2
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,17 @@ | ||
| # Library API | ||
|
|
||
| This is a specification for the [Library API](https://cloud.sylabs.io/library) that was originally implemented | ||
| This is a specification for the Library API that was originally implemented | ||
| by Sylabs in the [singularity](https://github.com/sylabs/singularity) project, | ||
| and now is present in the following container registry implementations: | ||
|
|
||
| - [Singularity Registry Server](https://github.com/singularityhub/sregistry) | ||
| - [Hinkskalle Registry](https://github.com/csf-ngs/hinkskalle) | ||
| - [Sylabs Cloud Library](https://cloud.sylabs.io/library) | ||
| - [Singularity Enterprise](https://sylabs.io/singularity-enterprise/) | ||
|
|
||
| The specification here is a community effort to document and maintain this application | ||
| programming interface. | ||
| programming interface. To support this effort, Sylabs has contributed the | ||
| [OpenAPI specification](https://github.com/sylabs/scs-library-client/blob/master/api/server/openapi.yml) | ||
| on which their services are based. | ||
|
|
||
| ⭐️ [Read the Documentation](https://singularityhub.github.io/library-api/) or [Jump to the current specification](https://singularityhub.github.io/library-api/#/spec/main) ⭐️ | ||
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
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.
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.
Question: Is there a way to render this link in a more human-friendly form?
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.
100%! Actually I do this with a bunch of pages for US-RSE - we can basically make a web request that retrieves and renders the spec, so we can keep it in one repository and render in another. Where should we put it - at the top of the current spec page rendered as yaml?
Let me know - I'm going to merge the charter and I can do a follow up PR with this.
Uh oh!
There was an error while loading. Please reload this page.
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.
Note that there are a bunch of online sites that will render a nice view of an OpenAPI spec for you, e.g.
https://mrin9.github.io/OpenAPI-Viewer/
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.
E.g. direct URL to view it - https://mrin9.github.io/OpenAPI-Viewer/#/load/https%3A%2F%2Fraw.githubusercontent.com%2Fsylabs%2Fscs-library-client%2Fmaster%2Fapi%2Fserver%2Fopenapi.yml
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.
Right but isn't the idea to have it rendered in the same place as this repo (and not another site?)
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.
Or are you suggesting to take whatever libraries they use, and use them here?
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.
I think it's fine to just use that hyperlink, it doesn't have to be rendered here.