Add in images

This commit is contained in:
Warren Buckley
2023-01-26 14:05:15 +01:00
parent 00d345468a
commit a90b5f20e5

View File

@@ -53,7 +53,7 @@ The frontend has an API formatter that takes the OpenAPI schema file and convert
### Example: Published Cache Status Dashboard
![alt_text](images/image1.png "image_tooltip")
![Published Status Dashboard](.github/images/contributing/published-cache-status-dashboard.png)
### Boilerplate (example using Lit)
@@ -158,7 +158,7 @@ Lets go through each of these properties…
Running the app with `npm run dev`, you will quickly notice the API requests turn into 404 errors. In order to hit the API, we need to add a mock handler to define the endpoints which our dashboard will call. In the case of the Published Cache Status section, we have a number of calls to work through. Lets start by looking at the call to retrieve the current status of the cache:
![alt_text](images/image2.png "image_tooltip")
![Published Status Dashboard](.github/images/contributing/status-of-cache.png)
From the existing functionality, we can see that this is a string message that is received as part of a `GET` request from the server.
@@ -187,7 +187,7 @@ It returns a `200 OK` response and a string value with the current “status”
An example `POST` is similar. Lets take the “Refresh status” button as an example:
![alt_text](images/image3.png "image_tooltip")
![Published Status Dashboard](.github/images/contributing/refresh-status.png)
From our existing functionality we can see that this makes a `POST`call to the server to prompt a reload of the published cache. So we would add a new endpoint to the mock handler that would look like: