What is our public API?

[everettraven]

As part of preparing for the v1.0.0 release we should re-visit what is considered our public API and ensure we are fully aware of what can and can't be changed without it being considered a breaking change.

Anything that would be a breaking change we should evaluate if there needs to be any changes before v1.0.0

Some areas to think about:

• CRDs
• CLI
• Manifests
• Go libraries

[LalatenduMohanty]

Expected outcome of this issue

• Documentation on what we consider as our public API

[LalatenduMohanty]

From the meeting we had on this topic here are the points we built a consensus

What is our public API?

• Kubernetes API
• The catalogd content URL
  • We can change the URL path, service name, and/or port
  • We cannot remove:
  • Content-Type support (e.g. application/jsonl)
  • Compression support (gzip,compress?)
  • Cache header support (lastModified)
  • Support to specific http methods (HEAD/GET)