Clean up API #4005
Clean up API #4005
Conversation
sarataha
force-pushed
the
api-cleanup
branch
3 times, most recently
from
db9882e
to
3801850
Compare
* Change field names to use snake-case
- They need to be treated as a single value
- add all docs - Adds intro and reference
- Make sure they each have a single title line - Followed by description - Remove unimplemented methods - buf lint fixes around camelCasing - Updated swagger files from EE
- Featureflags must be declared as a public route
- Adds objects tag to group all "objects" routes together
- For listing events and things
- Remove unused endpoints GetReconciledObjects and GetChildObjects
- Mark some soon to be removed endpoints as internal
Start adding documentation to fields.
- Also expand out the model in each endpoint detail block when selected.
- Move to requests.Session to simplify code
- Some more styling tweaks to remove the expansion options. Really get in the way for usability
Weave GitOps Core APIWhat version should we declare? Maybe the same as the Weave GitOps version? Can we automate updating this? GET /v1/flux/deployments
Maybe mention “Flux controllers” ? GET /v1/namespaces/{namespace}/objects/{kind}/{name}What happens if you don’t provide a cluster? GET /v1/namespaces/{namespace}/objects/{kind}/{name}/eventsWhat happens if you don’t provide a cluster? GET /v1/namespaces/{namespace}/objects/{kind}/{name}/inventoryReplace kubernetes with Kubernetes Weird linespacing here?
What happens if you don’t provide a clusterName? GET /v1/objects/{kind}It says “List objects of kind across all clusters” but there’s a clusterName parameter? Does it only list across all clusters if you don't provide a clusterName? Can we add an example of a labelSelector? What happens if you don’t provide a namespace? PATCH /v1/suspendDoesn’t say what it does? Maybe something like “This will set the PATCH /v1/syncDoesn’t say what it does? Maybe something like “This will trigger a reconciliation of the referenced objects.”? GET /v1/policy-validationsDoesn’t say what it does? And I don’t quite get what it does, it looks like it’s querying for events based on What happens if you don’t provide clusterName? GET /v1/policy-validations/{validationId}What happens if you don’t provide clusterName? Can we include an example validationId? What are valid validationTypes? |
Part of: weaveworks/weave-gitops-enterprise#3220
What changed?
Protobuf changes
/v1/namespace/flux/v1/namespacesINTERNAL/v1/crds/{name}/is-available-- not really designed to be used by users/v1/reconciled_objects-- unused, remove in a follow up PR/v1/child_objects-- unused, remove in a follow up PR/v1/session-logs-- discussions to removeUser-guide changes