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

[REST API v3] Change how create-artifact and create-version APIs work! #4671

Merged
merged 17 commits into from
May 16, 2024

Conversation

EricWittmann
Copy link
Member

Overview

The following changes are included in this PR:

  1. Create Artifact REST API changes
  2. Create Version REST API changes
  3. Content-Type now required for content operations
  4. Content-Type is now preserved (if you add YAML content it will be stored as YAML, not JSON)
  5. Removed stale CNCF compat API
  6. Removed old Event Sourcing support (will be replaced with outbox pattern later)
  7. Simplified Storage interface for creating artifacts and versions

Create Artifact REST API changes

  • Empty artifacts can now be created (no versions).
  • Removed the "create with version content" variant
  • All calls now only accept application/json content (of CreateArtifact type)
  • If an initial version is created, content-type is required
  • All metadata formerly included in HTTP headers is now passed in the JSON body

Create Version REST API changes

  • All calls now only accept application/json content (of CreateVersion type)
  • All metadata is passed as part of the CreateVersion body
  • Content-Type is required

@apicurio-bot
Copy link

apicurio-bot bot commented May 13, 2024

Thank you for creating a pull request!

Pinging @jsenko to respond or triage.

@EricWittmann EricWittmann marked this pull request as ready for review May 15, 2024 11:11
@EricWittmann EricWittmann merged commit 855860c into main May 16, 2024
20 checks passed
@EricWittmann EricWittmann deleted the rest-api/create-artifact-v3 branch May 16, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant