This adds a new file src/data/paths.yaml for injecting content or information that is not supported by blueprint. Ideally, we do not need this file, however adding some features to blueprint may be more complicated, or out of scope beyond the docs. We can use this file to move faster to meet documentation requirements in those cases.
If we decide some content will never move upstream, we can move it out of src/data/paths.yaml into something more specific to the docs, similar to how code-samples work.
This PR introduces three new properties:
description for routes (and eventually namespaces).
events (unused but needed soon)
resources to add additional resources that should be documented under a route but may not be returned by an endpoint under that route. I'm not sure if we need this one yet, but this is really a starting point to experiment with how to document relevant properties and resources in other contexts, e.g., should EVERY device property be documented under /devices AND /thermostats? Or should some properties by included / excluded on those routes.
This adds a new file
src/data/paths.yamlfor injecting content or information that is not supported by blueprint. Ideally, we do not need this file, however adding some features to blueprint may be more complicated, or out of scope beyond the docs. We can use this file to move faster to meet documentation requirements in those cases.If we decide some content will never move upstream, we can move it out of
src/data/paths.yamlinto something more specific to the docs, similar to how code-samples work.This PR introduces three new properties:
descriptionfor routes (and eventually namespaces).events(unused but needed soon)resourcesto add additional resources that should be documented under a route but may not be returned by an endpoint under that route. I'm not sure if we need this one yet, but this is really a starting point to experiment with how to document relevant properties and resources in other contexts, e.g., should EVERY device property be documented under/devicesAND/thermostats? Or should some properties by included / excluded on those routes.