From 409e647646fb1782a4e9ea9ce3ddb48c69b794bd Mon Sep 17 00:00:00 2001 From: Leo <95978312+yaefdb@users.noreply.github.com> Date: Mon, 22 Jan 2024 16:35:06 +0800 Subject: [PATCH] update --- consumerWebsite/public/css/api.css | 25 +++++- consumerWebsite/public/js/learnmore.js | 74 +++++++++++----- consumerWebsite/views/api.ejs | 114 ++++++++++++++++--------- consumerWebsite/views/contact.ejs | 1 + consumerWebsite/views/learnmore.ejs | 2 +- consumerWebsite/views/profile.ejs | 5 +- consumerWebsite/views/top.ejs | 3 - 7 files changed, 152 insertions(+), 72 deletions(-) diff --git a/consumerWebsite/public/css/api.css b/consumerWebsite/public/css/api.css index d3d44b1..f5d527e 100644 --- a/consumerWebsite/public/css/api.css +++ b/consumerWebsite/public/css/api.css @@ -523,4 +523,27 @@ body.one-content-column-version .content thead { .cf:before, .cf:after { content: ""; display: block; } .cf:after { clear: both; } -.ie6 .cf { zoom: 1 } \ No newline at end of file +.ie6 .cf { zoom: 1 } + + + +.generate-key-button { + float: right; /* Align the button to the right */ + margin-right: 85%; + margin-top: -40px; /* Adjust the margin-top value based on your layout */ + /* Add any additional styling you want for the button */ +} + +#content-get-api .generate-key-button { + background-color: #4caf50; /* Green background color */ + color: white; /* White text color */ + padding: 5px 11px; /* Padding for the button */ + border: none; /* Remove button border */ + border-radius: 5px; /* Add border-radius for rounded corners */ + cursor: pointer; /* Add pointer cursor on hover */ + font-size: 14px; /* Font size */ +} + +#content-get-api .generate-key-button:hover { + background-color: #45a049; /* Darker green on hover */ +} \ No newline at end of file diff --git a/consumerWebsite/public/js/learnmore.js b/consumerWebsite/public/js/learnmore.js index c965824..2e4a440 100644 --- a/consumerWebsite/public/js/learnmore.js +++ b/consumerWebsite/public/js/learnmore.js @@ -1,28 +1,60 @@ document.addEventListener("DOMContentLoaded", function () { function updateAdditionalInfo(region) { const infoContainer = document.getElementById("additional-info"); - // Replace the following with actual data retrieval based on the region - const aqi = "15"; - const temperature = "25°C"; - const humidity = "60%"; +// Replace the following with actual data retrieval based on the region +const aqi = "15"; +const temperature = "25°C"; +const humidity = "60%"; +const pm25 = "10"; +const pm10 = "20"; +const so2 = "5"; +const o3 = "35"; +const co = "0.5"; +const no2 = "15"; + +infoContainer.innerHTML = ` +
+

Additional Information - ${region}

+ +
+ Air Quality Index: + ${aqi} +
+
+ Temperature: + ${temperature} +
+
+ Humidity: + ${humidity} +
+
+ PM2.5: + ${pm25} +
+
+ PM10: + ${pm10} +
+
+ SO2: + ${so2} +
+
+ O3: + ${o3} +
+
+ CO: + ${co} +
+
+ NO2: + ${no2} +
+
+`; - infoContainer.innerHTML = ` -
-

Additional Information - ${region}

-
- Air Quality Index: - ${aqi} -
-
- Temperature: - ${temperature} -
-
- Humidity: - ${humidity} -
-
- `; // Remove the 'active' class from all info-box elements const infoBoxes = document.querySelectorAll('.info-box'); diff --git a/consumerWebsite/views/api.ejs b/consumerWebsite/views/api.ejs index aa5ade5..fd19cb7 100644 --- a/consumerWebsite/views/api.ejs +++ b/consumerWebsite/views/api.ejs @@ -5,8 +5,8 @@ https://github.com/ticlekiwi/API-Documentation-HTML-Template !--> - <%- include('top') %> - +<%- include('top') %> +
@@ -39,8 +39,8 @@
  • GET STARTED
    • -
  • - Get Data From API +
  • + Generate API
  • Errors @@ -87,7 +87,8 @@ Authorization JSON Your API key. - (Required) Example: curl https://api.teeseng.uk/api/v0/location -H "Authorization: {provide your + (Required) Example: curl https://api.teeseng.uk/api/v0/location -H "Authorization: + {provide your API key here}" @@ -119,7 +120,8 @@ Authorization JSON (Required) Your API key. - Example: curl https://api.teeseng.uk/api/v0/location -H "Authorization: {provide your + Example: curl https://api.teeseng.uk/api/v0/location -H "Authorization: {provide + your API key here}" @@ -130,11 +132,12 @@

    Add Location (Only for system or admin API key)

    To add an Location you need to make a POST call to the following url :
    - https://api.teeseng.uk/api/v0/location/new + https://api.teeseng.uk/api/v0/location/new

    Example :
    - curl https://api.teeseng.uk/api/v0/location/new -H "Content-Type: application/json" -X POST -d '{"name": "SAMPLE", "added_by": "system" , "description": "test"}' + curl https://api.teeseng.uk/api/v0/location/new -H "Content-Type: application/json" -X POST -d '{"name": "SAMPLE", "added_by": "system" , "description": "test"}'

    Return Response :
    @@ -155,7 +158,8 @@ Authorization JSON Your API key. - (Required) Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: {provide your + (Required) Example: curl https://api.teeseng.uk/api/v0/location/new -H + "Authorization: {provide your API key here}" @@ -163,7 +167,8 @@ Location name JSON Location name. - (Required) Location name. Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: provide + (Required) Location name. Example: curl https://api.teeseng.uk/api/v0/location/new + -H "Authorization: provide your API key here" -d '{"name":"Location name"}' @@ -171,7 +176,8 @@ Added by JSON System or Admin - (Required) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: provide + (Required) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new + -H "Authorization: provide your API key here" -d '{"added_by":"system"}' @@ -179,7 +185,8 @@ Description JSON Description of Location - (Required) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: provide + (Required) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new + -H "Authorization: provide your API key here" -d '{"description":"test"}' @@ -191,13 +198,14 @@

    Update Location (Only for system or admin API key)

    To update an Location you need to make a PUT call to the following url :
    - https://api.teeseng.uk/api/v0/location/update + https://api.teeseng.uk/api/v0/location/update

    Example :
    - curl https://api.teeseng.uk/api/v0/location/update -H "Content-Type: application/json" -X POST -d '{"id": "7" , "name": "SAMPLE", "added_by": "system" , "description": "test"}' + curl https://api.teeseng.uk/api/v0/location/update -H "Content-Type: application/json" -X POST -d '{"id": "7" , "name": "SAMPLE", "added_by": "system" , "description": "test"}' +

    -
    Return Response :
    {"status":"200","message":"Location 7 updated"}

    @@ -216,7 +224,8 @@ Authorization JSON Your API key. - (Required) example: curl https://api.teeseng.uk/api/v0/location/update -H "Authorization: {provide your + (Required) example: curl https://api.teeseng.uk/api/v0/location/update -H + "Authorization: {provide your API key here}" @@ -224,7 +233,8 @@ ID JSON Location ID - (Required) Location ID Example: curl https://api.teeseng.uk/api/v0/location/update -H "Authorization: provide + (Required) Location ID Example: curl https://api.teeseng.uk/api/v0/location/update + -H "Authorization: provide your API key here" -d '{"id": "7"}' @@ -232,7 +242,8 @@ Location name JSON Location name. - (Optional) Location name. Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: provide + (Optional) Location name. Example: curl https://api.teeseng.uk/api/v0/location/new + -H "Authorization: provide your API key here" -d '{"name":"Location name"}' @@ -240,7 +251,8 @@ Added by JSON System or Admin - (Optional) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: provide + (Optional) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new + -H "Authorization: provide your API key here" -d '{"added_by":"system"}' @@ -248,7 +260,8 @@ Description JSON Description of Location - (Optional) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new -H "Authorization: provide + (Optional) System or Admin Example: curl https://api.teeseng.uk/api/v0/location/new + -H "Authorization: provide your API key here" -d '{"description":"test"}' @@ -260,11 +273,12 @@

    Delete Location (Only for system or admin API key)

    To delete an Location you need to make a DELETE call to the following url :
    - https://api.teeseng.uk/api/v0/location/delete + https://api.teeseng.uk/api/v0/location/delete

    Example :
    - curl https://api.teeseng.uk/api/v0/location/delete -H "Content-Type: application/json" -X POST -d '{"id": "7"}' + curl https://api.teeseng.uk/api/v0/location/delete -H "Content-Type: application/json" -X POST -d '{"id": "7"}'


    QUERY PARAMETERS

    @@ -281,7 +295,8 @@ Authorization JSON Your API key. - (Required) example: curl https://api.teeseng.uk/api/v0/location/delete -H "Authorization: {provide your + (Required) example: curl https://api.teeseng.uk/api/v0/location/delete -H + "Authorization: {provide your API key here}" @@ -289,7 +304,8 @@ ID JSON Location ID - (Required) Location ID Example: curl https://api.teeseng.uk/api/v0/location/delete -H "Authorization: provide + (Required) Location ID Example: curl https://api.teeseng.uk/api/v0/location/delete + -H "Authorization: provide your API key here" -d '{"id": "7"}' @@ -297,24 +313,6 @@
    • - - - - - - - - - - - - - - - - - -

    Errors

    @@ -360,6 +358,38 @@

    +
    +
    +

    API Keys

    + +

    + You can generate API Keys here: +

    + + + + + + + + + + + + + + + + + + + +
    NamePublic KeyPrivate KeyKey TypeCreated
    API KeyGR234-We34greR-234-fEGType2024-01-22
    +
    +
    + + + diff --git a/consumerWebsite/views/contact.ejs b/consumerWebsite/views/contact.ejs index f93c0f2..edc98f5 100644 --- a/consumerWebsite/views/contact.ejs +++ b/consumerWebsite/views/contact.ejs @@ -1,4 +1,5 @@ <%- include('top') %> +
    diff --git a/consumerWebsite/views/learnmore.ejs b/consumerWebsite/views/learnmore.ejs index 9be0da4..f5e89e8 100644 --- a/consumerWebsite/views/learnmore.ejs +++ b/consumerWebsite/views/learnmore.ejs @@ -1,4 +1,5 @@ <%- include('top') %> +

    @@ -38,5 +39,4 @@

    - <%- include('bot') %> diff --git a/consumerWebsite/views/profile.ejs b/consumerWebsite/views/profile.ejs index c779825..4163961 100644 --- a/consumerWebsite/views/profile.ejs +++ b/consumerWebsite/views/profile.ejs @@ -1,8 +1,5 @@ <%- include('top') %> - +
    diff --git a/consumerWebsite/views/top.ejs b/consumerWebsite/views/top.ejs index 59cc921..74ab3e8 100644 --- a/consumerWebsite/views/top.ejs +++ b/consumerWebsite/views/top.ejs @@ -21,9 +21,6 @@ - - -