imdsclient: update readme to reflect new helper functions #1610
Conversation
sources/imdsclient/README.md
Outdated
| For custom IMDS end targets, you can use `fetch_bytes` and `fetch_string`. | ||
|
|
||
| To query IMDS without high-level wrappers, there is also a `fetch_imds` method. |
There was a problem hiding this comment.
Nit: Just from reading this, I'm not sure when I would use fetch_bytes/string vs. fetch_imds. Can we clarify a bit?
jpculp
force-pushed
the
update-imdsclient-readme
branch
from
3c4a933 to
52f270d
Compare
|
Updated for further clarity. |
jpculp
changed the title
There was a problem hiding this comment.
I actually think it would be better to remove the enumeration of high level function names since it will always be in danger of being incorrect.
Also the blurbs about fetch_imds, fetch_bytes and fetch_string are incorrect. These are private functions and as-such are implementation details that shouldn't go in the readme.
|
Hm. I forgot that we switched the last 3 to private, but now that I think about it I wonder if that was really the right thing to do. |
jpculp
force-pushed
the
update-imdsclient-readme
branch
from
52f270d to
17f1254
Compare
|
Took a different approach to the documentation. |
This is an update to documentation as `fetch_dynamic` and `fetch_metadata` were previously replaced with more targeted functions.
jpculp
force-pushed
the
update-imdsclient-readme
branch
from
17f1254 to
8834d31
Compare
|
Changed ``` to ` so cargo doesn't try to test the example uri. |
Issue number:
N/A
Description of changes:
This is an update to documentation as
fetch_dynamicandfetch_metadatawere previously replaced with more targeted functions.Testing done:
Built
imdsclientcrate.Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.