Skip to content
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

Merged
merged 4 commits into from
Feb 24, 2022

Conversation

jsoriano
Copy link
Member

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).

@jsoriano jsoriano added the Team:Ecosystem Label for the Packages Ecosystem team label Feb 23, 2022
@jsoriano jsoriano requested review from andrewkroh and a team February 23, 2022 15:56
@jsoriano jsoriano self-assigned this Feb 23, 2022
@elasticmachine
Copy link

elasticmachine commented Feb 23, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-02-24T10:22:33.359+0000

  • Duration: 4 min 8 sec

Test stats 🧪

Test Results
Failed 0
Passed 142
Skipped 0
Total 142

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

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.
Copy link
Member

@andrewkroh andrewkroh Feb 23, 2022

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).

Copy link
Member Author

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.

@jsoriano jsoriano requested a review from mtojek February 24, 2022 10:24
Copy link
Contributor

@mtojek mtojek left a 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.

@jsoriano
Copy link
Member Author

jsoriano commented Feb 24, 2022

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

@jsoriano jsoriano merged commit c4fe01f into elastic:main Feb 24, 2022
@jsoriano jsoriano deleted the update-prerelease-readme branch February 24, 2022 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Ecosystem Label for the Packages Ecosystem team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants