Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.