-
Notifications
You must be signed in to change notification settings - Fork 67
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
Update README and OpenAPI to include prerelease parameter #794
Conversation
README.md
Outdated
* `all`: This can be set to true to list all package versions. This is set to `false` by default. | ||
* `experimental`: This can be set to true to list packages considered to be experimental. This is set to `false` by default. | ||
* `all`: This can be set to `true` to list all package versions. This is set to `false` by default. | ||
* `prerelease`: This can be set to `true` to list prerelease versions of packages. This is set to `false` by default. |
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 you define what "prerelease versions" means. Like say that it means versions <1.0 and packages using the deprecated beta
and experimental
release tags (IIRC).
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.
Added description. The registry fully relies on semantic versioning to decide if the version of a package is a prerelease, release tags are not considered. This is why it is important to have consistency between release tags and versions till we fully sunset versions that rely on release tags.
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.
nit: we may consider introducing any logic to validate the openapi.yml
. I'm not sure if there is any project using it now.
Yep, we have this issue about validating the definition #761 |
Update README and OpenAPI definition accordingly to the changes in #785.
OpenAPI definition is still most likely outdated in any case, there is another open issue about this (#761).