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

Add API endpoints for asset versioning #289

Open
ckadner opened this issue Jan 19, 2022 · 1 comment
Open

Add API endpoints for asset versioning #289

ckadner opened this issue Jan 19, 2022 · 1 comment
Assignees
Labels
API Swagger API enhancement New feature or request
Milestone

Comments

@ckadner
Copy link
Member

ckadner commented Jan 19, 2022

In order to enable versioning of the assets in the MLX catalog, we need to add additional API endpoints. This follows closely the approach taken, and API endpoints available for pipeline versions in KFP.

Existing API Endpoints (i.e. for components)

https://ml-exchange.org/apis/v1alpha1/ui/#/ComponentService

/components
  GET
  POST
/components/{id}
  GET
  DELETE
/components/{id}/download
  GET
/components/{id}/generate_code
  GET
/components/{id}/run
  POST
/components/{id}/templates
  GET
/components/upload
  POST
/components/upload_from_url
  POST
/components/{id}/upload:  ## update existing, currently overrides previous version, will be removed
  POST
/components/featured
  POST
/components/publish_approved
  POST

New API Endpoints (i.e. component_versions)

/component_versions
  GET
  POST
/component_versions/{version_id}
  GET
  DELETE
/component_versions/{version_id}/templates
  GET
/components/{component_id}/default_version/{version_id}
  POST
/components/upload_version
  POST

The properties of the new "version" Swagger object (i.e. apiComponentVersion)

- id
- name
- description
- created_at
- tag              # semantic tag, like Docker image tags 
- code_source_url  # GitHub URL including the commit hash corresponding to version in MLX
- ...              # remaining asset-specific properties

Additional properties added to existing Swagger objects (i.e. apiComponent)

- default_version
- code_source_url  # GitHub URL including the commit hash corresponding to version in MLX
@ckadner ckadner added enhancement New feature or request API Swagger API labels Jan 19, 2022
@ckadner ckadner self-assigned this Jan 19, 2022
@ckadner
Copy link
Member Author

ckadner commented Jan 19, 2022

@Tomcli @animeshsingh

@ckadner ckadner added this to the v0.2.0 milestone Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Swagger API enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant