Story Request: Introduction to CAPI's REST API

[dsabeti]

Context: A handful of stories in the project (e.g. "Kill an instance of an app") assume familiarity with CAPI's REST API (and REST APIs in general). For example, some stories say something to effect "fetch the app guid" -- What's a guid? What does it identify? Where do I find it? Etc?

We could explain everything in the stories, but it would help to have a dedicated story to exploring and learning about the CC API, so that the vocabulary is established for the subsequent stories.

cc @karensmolermiller

[dsabeti]

Maybe we could add some of these acronyms and vocabulary to this glossary: http://cf-glossary.cfapps.io/

[dsabeti]

We could also write a pretty simple story that asks the participants to cf curl a few endpoints, or run a cf command with CF_TRACE on -- for example, CF_TRACE=true cf start.

[wjjackson7]

In the #158573369 story (Kill a specific instance of an application), we found that this link: https://stackoverflow.com/questions/39233122/killing-a-cloud-foundry-instance, was more helpful than the link provided in the story, since the stack overflow link referred to cf curl usage rather than curl usage.

Maybe more familiarity with cf curl is what was holding us back. Also what is the directory v2/apps/.., is it something that all vm's have?

[dsabeti]

Cool, thanks for that feedback @wjjackson7. We're thinking about including some additional information in these stories, like:

1. Explanation of how cf curl differs from curl -- specifically, that it holds your bearer token as well as your API target.
2. Some high level information about how REST API's are structured.