Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Reorganizing to better handle http endpoints

  • Loading branch information...
commit f754b25b10642decb9808ed8190300544f9bdfa2 1 parent a53a999
@krobertson krobertson authored
Showing with 142 additions and 61 deletions.
  1. +16 −0 _config.yml
  2. +20 −5 _layouts/default.haml
  3. +0 −9 _posts/http-api/0001-01-01-authentication.md
  4. +2 −2 _posts/{http-api → http-apps}/0001-01-01-delete-apps-name.md
  5. +2 −2 _posts/{http-api → http-apps}/0001-01-01-get-apps-name-crashes.md
  6. +2 −2 _posts/{http-api → http-apps}/0001-01-01-get-apps-name-instances.md
  7. +2 −2 _posts/{http-api → http-apps}/0001-01-01-get-apps-name-stats.md
  8. +2 −2 _posts/{http-api → http-apps}/0001-01-01-get-apps-name.md
  9. +1 −1  _posts/{http-api → http-apps}/0001-01-01-get-apps.md
  10. +2 −2 _posts/{http-api → http-apps}/0001-01-01-put-apps-name.md
  11. +1 −1  _posts/{http-api → http-info}/0001-01-01-get-info-runtimes.md
  12. +1 −1  _posts/{http-api → http-info}/0001-01-01-get-info-services.md
  13. +2 −2 _posts/{http-api → http-info}/0001-01-01-get-info.md
  14. +1 −1  _posts/{http-api → http-services}/0001-01-01-delete-services-alias.md
  15. +1 −1  _posts/{http-api → http-services}/0001-01-01-get-services-alias.md
  16. +1 −1  _posts/{http-api → http-services}/0001-01-01-get-services.md
  17. +2 −2 _posts/{http-api → http-services}/0001-01-01-post-services.md
  18. +2 −2 _posts/{http-api → http-users}/0001-01-01-delete-users-email.md
  19. +1 −1  _posts/{http-api → http-users}/0001-01-01-get-users-email.md
  20. +2 −2 _posts/{http-api → http-users}/0001-01-01-get-users.md
  21. +2 −2 _posts/{http-api → http-users}/0001-01-01-post-users-email-tokens.md
  22. +2 −2 _posts/{http-api → http-users}/0001-01-01-post-users.md
  23. +2 −2 _posts/{http-api → http-users}/0001-01-01-put-users-email.md
  24. +0 −14 http-api.md
  25. +16 −0 http-apps.md
  26. +9 −0 http-authentication.md
  27. +16 −0 http-info.md
  28. +16 −0 http-services.md
  29. +16 −0 http-users.md
View
16 _config.yml
@@ -16,6 +16,22 @@ pygments: true
## permalink style: http://wiki.github.com/mojombo/jekyll/permalinks
permalink: /:categories/:title
+# category types
+endpoint_categories:
+ - http-authentication
+ - http-info
+ - http-apps
+ - http-services
+ - http-users
+nats_categories:
+ - cloud-controller
+ - dea
+ - health-manager
+ - router
+ - service-gateway
+ - service-node
+ - stager
+
# use maruku for markdown
markdown: maruku
View
25 _layouts/default.haml
@@ -34,19 +34,34 @@
{% assign current = 'active' %}
{% endif %}
<li class="{{current}}"><a href="/">Home</a>
- {% for category in site.sorted_categories %}
+
+ <li class="nav-header">HTTP Endpoints</li>
+ {% for category in site.endpoint_categories %}
+ {% assign current = nil %}
+ {% assign class = "category" %}
+ {% if category == page.category_home %}
+ {% assign current = 'active' %}
+ {% endif %}
+ {% if category == page.category %}
+ {% assign current = 'active' %}
+ {% endif %}
+ <li class="{{class}} {{current}}"><a href="/{{category}}">{{ category | replace:'http-','' | replace:'-',' ' }}</a></li>
+ {% endfor %}
+
+ <li class="nav-header">NATS Messages</li>
+ {% for category in site.nats_categories %}
{% assign current = nil %}
{% assign class = "category" %}
- {% if category.first == page.category_home %}
+ {% if category == page.category_home %}
{% assign current = 'active' %}
{% endif %}
- {% if category.first == 'dea' %}
+ {% if category == 'dea' %}
{% assign class = 'short_category' %}
{% endif %}
- {% if category.first == page.category %}
+ {% if category == page.category %}
{% assign current = 'active' %}
{% endif %}
- <li class="{{class}} {{current}}"><a href="/{{category.first}}">{{ category.first | replace:'-',' ' }}</a></li>
+ <li class="{{class}} {{current}}"><a href="/{{category}}">{{ category | replace:'-',' ' }}</a></li>
{% endfor %}
</ul>
</div>
View
9 _posts/http-api/0001-01-01-authentication.md
@@ -1,9 +0,0 @@
----
-layout: post
-category: http-api
-title: "Authentication"
----
-
-*TBD*
-
-Documentation on this area has not been commenced.
View
4 ...s/http-api/0001-01-01-delete-apps-name.md → .../http-apps/0001-01-01-delete-apps-name.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "DELETE /apps/{name}"
---
@@ -26,4 +26,4 @@ Deletes a provisioned service on the target cloud.
**Response**
-None
+None
View
4 ...p-api/0001-01-01-get-apps-name-crashes.md → ...-apps/0001-01-01-get-apps-name-crashes.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "GET /apps/{name}/crashes"
---
@@ -30,4 +30,4 @@ Returns information about application crashes on the target cloud.
{% highlight js %}
{% include snippets/http-api-get-apps-name-crashes-response.json %}
{% endhighlight %}
-</div>
+</div>
View
4 ...api/0001-01-01-get-apps-name-instances.md → ...pps/0001-01-01-get-apps-name-instances.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "GET /apps/{name}/instances"
---
@@ -30,4 +30,4 @@ Returns information about application instances on the target cloud.
{% highlight js %}
{% include snippets/http-api-get-apps-name-instances-response.json %}
{% endhighlight %}
-</div>
+</div>
View
4 ...ttp-api/0001-01-01-get-apps-name-stats.md → ...tp-apps/0001-01-01-get-apps-name-stats.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "GET /apps/{name}/stats"
---
@@ -30,4 +30,4 @@ Returns information about application statistics on the target cloud.
{% highlight js %}
{% include snippets/http-api-get-apps-name-stats-response.json %}
{% endhighlight %}
-</div>
+</div>
View
4 _posts/http-api/0001-01-01-get-apps-name.md → _posts/http-apps/0001-01-01-get-apps-name.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "GET /apps/{name}"
---
@@ -30,4 +30,4 @@ Returns basic information about an application deployed on the target cloud.
{% highlight js %}
{% include snippets/http-api-get-apps-name-response.json %}
{% endhighlight %}
-</div>
+</div>
View
2  _posts/http-api/0001-01-01-get-apps.md → _posts/http-apps/0001-01-01-get-apps.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "GET /apps"
---
View
4 _posts/http-api/0001-01-01-put-apps-name.md → _posts/http-apps/0001-01-01-put-apps-name.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-apps
title: "PUT /apps/{name}"
---
@@ -41,4 +41,4 @@ Updates an application at target cloud.
**Response**
-None
+None
View
2  .../http-api/0001-01-01-get-info-runtimes.md → ...http-info/0001-01-01-get-info-runtimes.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-info
title: "GET /info/runtimes"
---
View
2  .../http-api/0001-01-01-get-info-services.md → ...http-info/0001-01-01-get-info-services.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-info
title: "GET /info/services"
---
View
4 _posts/http-api/0001-01-01-get-info.md → _posts/http-info/0001-01-01-get-info.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-info
title: "GET /info"
---
@@ -40,4 +40,4 @@ If the user IS logged in:
{% highlight js %}
{% include snippets/http-api-get-info-logged-response.json %}
{% endhighlight %}
-</div>
+</div>
View
2  ...p-api/0001-01-01-delete-services-alias.md → ...vices/0001-01-01-delete-services-alias.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-services
title: "DELETE /services/{alias}"
---
View
2  ...http-api/0001-01-01-get-services-alias.md → ...services/0001-01-01-get-services-alias.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-services
title: "GET /services/{alias}"
---
View
2  _posts/http-api/0001-01-01-get-services.md → .../http-services/0001-01-01-get-services.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-services
title: "GET /services"
---
View
4 _posts/http-api/0001-01-01-post-services.md → ...http-services/0001-01-01-post-services.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-services
title: "POST /services"
---
@@ -35,4 +35,4 @@ Creates a new provisioned service on the target cloud.
**Response**
-None
+None
View
4 ...http-api/0001-01-01-delete-users-email.md → ...tp-users/0001-01-01-delete-users-email.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-users
title: "DELETE /users/{email}"
---
@@ -26,4 +26,4 @@ Deletes a user on the target cloud.
**Response**
-None
+None
View
2  ...ts/http-api/0001-01-01-get-users-email.md → .../http-users/0001-01-01-get-users-email.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-users
title: "GET /users/{email}"
---
View
4 _posts/http-api/0001-01-01-get-users.md → _posts/http-users/0001-01-01-get-users.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-users
title: "GET /users"
---
@@ -30,4 +30,4 @@ None
{% highlight js %}
{% include snippets/http-api-get-users-response.json %}
{% endhighlight %}
-</div>
+</div>
View
4 ...api/0001-01-01-post-users-email-tokens.md → ...ers/0001-01-01-post-users-email-tokens.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-users
title: "POST /users/{email}/tokens"
---
@@ -37,4 +37,4 @@ No
{% highlight js %}
{% include snippets/http-api-post-users-email-tokens-response.json %}
{% endhighlight %}
-</div>
+</div>
View
4 _posts/http-api/0001-01-01-post-users.md → _posts/http-users/0001-01-01-post-users.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-users
title: "POST /users"
---
@@ -33,4 +33,4 @@ No
**Response**
-None
+None
View
4 ...ts/http-api/0001-01-01-put-users-email.md → .../http-users/0001-01-01-put-users-email.md
@@ -1,6 +1,6 @@
---
layout: post
-category: http-api
+category: http-users
title: "PUT /users/{email}"
---
@@ -33,4 +33,4 @@ Updates the user's password on the target cloud.
**Response**
-None
+None
View
14 http-api.md
@@ -1,14 +0,0 @@
----
-layout: category
-title: HTTP API
-category_home: http-api
----
-
-The HTTP API is the component that allows externals tools to manage the infrastructure. It is implemented by the
-[Cloud Controller](/cloud-controller).
-
-There are several client libraries to interact with the API:
-
-* [Java](https://github.com/cloudfoundry/vcap-java-client)
-* [Node.js](https://github.com/firebaseco/vcap-node-client)
-* [Ruby](https://github.com/frodenas/cloudfoundry-client)
View
16 http-apps.md
@@ -0,0 +1,16 @@
+---
+layout: category
+title: Application APIs
+category_home: http-apps
+---
+
+This API category covers the endpoints that are used to manage applications.
+
+The HTTP APIs are the component that allows externals tools to manage the
+infrastructure. It is implemented by the [Cloud Controller](/cloud-controller).
+
+There are several client libraries to interact with the API:
+
+* [Java](https://github.com/cloudfoundry/vcap-java-client)
+* [Node.js](https://github.com/firebaseco/vcap-node-client)
+* [Ruby](https://github.com/frodenas/cloudfoundry-client)
View
9 http-authentication.md
@@ -0,0 +1,9 @@
+---
+layout: category
+title: Authentication API
+category_home: http-authentication
+---
+
+*TBD*
+
+Documentation on this area has not been commenced.
View
16 http-info.md
@@ -0,0 +1,16 @@
+---
+layout: category
+title: Info APIs
+category_home: http-info
+---
+
+This API category covers the endpoints that are used for basic information.
+
+The HTTP APIs are the component that allows externals tools to manage the
+infrastructure. It is implemented by the [Cloud Controller](/cloud-controller).
+
+There are several client libraries to interact with the API:
+
+* [Java](https://github.com/cloudfoundry/vcap-java-client)
+* [Node.js](https://github.com/firebaseco/vcap-node-client)
+* [Ruby](https://github.com/frodenas/cloudfoundry-client)
View
16 http-services.md
@@ -0,0 +1,16 @@
+---
+layout: category
+title: Service APIs
+category_home: http-services
+---
+
+This API category covers the endpoints that are used to manage services.
+
+The HTTP APIs are the component that allows externals tools to manage the
+infrastructure. It is implemented by the [Cloud Controller](/cloud-controller).
+
+There are several client libraries to interact with the API:
+
+* [Java](https://github.com/cloudfoundry/vcap-java-client)
+* [Node.js](https://github.com/firebaseco/vcap-node-client)
+* [Ruby](https://github.com/frodenas/cloudfoundry-client)
View
16 http-users.md
@@ -0,0 +1,16 @@
+---
+layout: category
+title: User APIs
+category_home: http-users
+---
+
+This API category covers the endpoints that are used to manage users.
+
+The HTTP APIs are the component that allows externals tools to manage the
+infrastructure. It is implemented by the [Cloud Controller](/cloud-controller).
+
+There are several client libraries to interact with the API:
+
+* [Java](https://github.com/cloudfoundry/vcap-java-client)
+* [Node.js](https://github.com/firebaseco/vcap-node-client)
+* [Ruby](https://github.com/frodenas/cloudfoundry-client)
Please sign in to comment.
Something went wrong with that request. Please try again.