canonical / canonical/charmlibs

Add interface schemata and docs for service-mesh interfaces

Open
#534 0 comments 0 reactions 1 assignee Claimed by @adhityaravi View on GitHub
docs interface-metadata team-service-mesh
Dominant language
Python
Stars
5
Forks
28
Avg merge
1d 5h
Merged PRs (30d)
24

Description

When we landed the service-mesh interface libraries, we didn't add interface docs and metadata at that time. #533 highlights the need for accurate interface metadata -- in particular, we need to be sure we have the canonical interface name exactly right.

---

The libraries touched by #533 should all have the following files added at minimum:
- `interface/v0/README.md`
- `interface/v0/interface.yaml`

These should follow the format of the files found in https://github.com/canonical/charmlibs/tree/main/interfaces/istio_metadata/interface/v0

---

Ideally we'd also add Pydantic schemas at the same time. These should follow the lightweight format of https://github.com/canonical/charmlibs/blob/main/interfaces/istio_metadata/src/charmlibs/interfaces/istio_metadata/_schema.py

They don't need to be symlinks into the libraries (though they could be) -- copies of any schema classes from the libraries are perfectly acceptable.

---

While these files can all technically be added with only review from the service-mesh team as codeowners of the libraries, I'd appreciate being pinged for review on them too.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.