Add Swagger Spec for Model Registry UI (issue #1207)

[uday-codes69]

Summary

This PR adds the Swagger/OpenAPI specification for the Model Registry UI to the Kubeflow website under:

content/en/docs/components/model-registry/reference/ui-rest-api.md

It provides users with a dedicated documentation page for the UI-facing endpoints defined in mod-arch.yaml from the model-registry repo.

Details

• Adds a new Markdown file (ui-rest-api.md) under model-registry/reference
• Links to the raw Swagger YAML file:
  https://raw.githubusercontent.com/kubeflow/model-registry/main/clients/ui/api/openapi/mod-arch.yaml
• Structured to match the style of the existing main REST API doc
• Resolves part of kubeflow/model-registry#1207

Next Steps

Once this is published to the website, the README in model-registry will link to this page to replace the broken Swagger link.

Once this page is published to the website, the temporary link in the model-registry README pointing to the raw YAML will be removed and replaced with a proper internal doc reference.

[google-oss-prow]

Hi @uday-codes69. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[github-actions]

🚫 This command cannot be processed. Only organization members or owners can use the commands.

[uday-codes69]

Hi @lucferbux, this PR publishes the UI REST API spec.
I’ve also temporarily added the raw YAML link in the model-registry README and will replace it with a proper doc link once this gets merged.
Let me know if anything needs to be updated. Thanks!

[Arhell]

/ok-to-test

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[tarilabs]

@ederign @lucferbux can you kindly take a look, please?

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[lucferbux]

/approve
/lgtm

Apologies, didn't get the ping, that's exactly the swagger spec needed.

[google-oss-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lucferbux
Once this PR has been reviewed and has the lgtm label, please assign al-pragliola for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• content/en/docs/components/model-registry/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment