overmindtech / sdp

Protobuf based protocol for describing the state of a system
Other
4 stars 1 forks source link

Move docs-data to source heartbeat API #264

Open dylanratcliffe opened 3 days ago

dylanratcliffe commented 3 days ago

Research

We still need a way to extract the nice structured data from the code for docs generation, but we also need this to be able to made available to discovery and therefore as part of the heartbeats

Proposed API

@tphoney Can you please fill this one out?

tphoney commented 3 days ago
➜  workspace git:(full_stack_vscode) ✗ grep -ihor "+overmind:\S*" stdlib-source  | sort | uniq
+overmind:description
+overmind:descriptiveType
+overmind:get
+overmind:link
+overmind:linked-item-query
+overmind:search
+overmind:type
➜  workspace git:(full_stack_vscode) ✗ grep -ihor "+overmind:\S*" aws-source  | sort | uniq
+overmind:descriptiveType
+overmind:get
+overmind:group
+overmind:link
+overmind:list
+overmind:search
+overmind:terraform:method
+overmind:terraform:queryMap
+overmind:type
➜  workspace git:(full_stack_vscode) ✗ grep -ihor "+overmind:\S*" k8s-source  | sort | uniq
+overmind:descriptiveType
+overmind:get
+overmind:group
+overmind:link
+overmind:list
+overmind:search
+overmind:terraform:queryMap
+overmind:terraform:scope
+overmind:type
➜  workspace git:(full_stack_vscode) ✗                                

gives +overmind:description +overmind:descriptiveType +overmind:get +overmind:group +overmind:link +overmind:linked-item-query +overmind:list +overmind:search +overmind:terraform:method +overmind:terraform:queryMap +overmind:terraform:scope +overmind:type

tphoney commented 2 days ago

We could extend the functionality of https://github.com/overmindtech/aws-source/blob/ab5978f87de4d015b4a55758bdae881b507c0967/sources/describe_source.go#L21

adding in the additional fields that were previously tags.