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

idl/json_backend: generate data for new-style xapi-releases #4815

Merged
merged 4 commits into from
Oct 12, 2022

Conversation

psafont
Copy link
Member

@psafont psafont commented Oct 11, 2022

Staarting from xapi release 1.250.0, xapi has relied more and more in its own version, rather than on xenserver releases and "API version".
This has meant that in the public docs there is no information of the API changes that have happened in the last 2 years.

This adds the information about these changes to the metadata that gets published. There are some tweaks that could be made, like adding the date of the release for each of these, or tweak the release datatype to better accomodate this new style, or even move all that information to the metadata generation side instead of being a fundamental part of xapi.

I've taken the liberty to port the json generation here to yojson. I've manually checked using jq that the json produced is equivalent, although the new one has a lot lets whitespace.

Example output using this branch:
image

Makefile Show resolved Hide resolved
Add shorter synonyms for creating paths and writing files
Add empty mli since it should not export any functions

Signed-off-by: Pau Ruiz Safont <pau.safont@citrix.com>
An ad-hoc solution was used until now. The new code generates compact
json that is equivalent to the previous output. I've verified this using
jq.

Signed-off-by: Pau Ruiz Safont <pau.safont@citrix.com>
Signed-off-by: Pau Ruiz Safont <pau.safont@citrix.com>
Since xapi 1.249, changes have been attached to xapi versions instead of
just a xenserver release. Surface this information to the data that gets
used to populate the public documentation webpage

Currently it uses a locked API, which might not be maintained in the
future, and release dates are not populated which would be good for
users to know

Signed-off-by: Pau Ruiz Safont <pau.safont@citrix.com>
@psafont psafont merged commit d613b5f into xapi-project:master Oct 12, 2022
@psafont psafont deleted the private/paus/docs branch October 12, 2022 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants