Document the configuration REST API
See original GitHub issueAccording the readme:
A TCP endpoint exposing a REST API used to obtain deployment and topology configuration.
Is this REST API documented anywhere?
Issue Analytics
- State:
- Created 9 years ago
- Comments:9 (3 by maintainers)
Top Results From Across the Web
REST API configuration files - IBM
The configuration file contains the information for resources for an API, grouped by API version number. There is only one configuration file per...
Read more >REST API for Documents - Configuration REST Endpoints
The REST API for Documents enables you to interact with folders and files stored in Oracle Content Management Cloud and to create sites...
Read more >Example: Configuring the REST API | Junos OS
This example demonstrates how to configure the REST API on a Junos OS device.
Read more >Documenting RESTful APIs - YouTube
Recorded at SpringOne2GX 2015.Track: Web / Javascript TrackSpeaker: Andy WilkinsonSlides: ...
Read more >Azure App Configuration REST API - Microsoft Learn
The documentation on the control plane REST API for Azure App Configuration is available in the Azure REST documentation.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@szarkos That code relies on the
waagent
script to actually interact with the metadata service. This means that if you have a standard guest image (like, say, one of these), it won’t work unless it already has theWALinuxAgent
package installed. If cloud-init were able to talk to the metadata service natively without requiring thewaagent
, then generic “cloud” images like this would Just Work.Besides, if you’re going to say “A TCP endpoint exposing a REST API used to obtain deployment and topology configuration.” it seems you should document that as well.
@larsks it is golden, thanks. since it was an internal API, it did not get much attention. thanks for documenting it, perhaps you can add an appendix section in the
2.1/README
as an unofficial guide. Closing this issue.