a22erigr commented

Collaborator

We need to write a wiki page to centralized and document all available endpoints that the services provide.

Following things should be documented
- Path to endpoint
- Values that the endpoint requires
- Return values
  - When error occurs
  - When no error occurs

We need to write a wiki page to centralized and document all available endpoints that the services provide. + Following things should be documented + Path to endpoint + Values that the endpoint requires + Return values + When error occurs + When no error occurs

a22erigr added the

help wanted

project documentation

labels

2026-05-04 07:18:35 +00:00

a24danwe was assigned by a22erigr

2026-05-04 10:41:19 +00:00

a22erigr removed the

help wanted

label

2026-05-04 10:41:24 +00:00

a24sakma commented

2026-05-04 11:46:42 +00:00

Collaborator

we will create diagrams for each services. Isn't that enough?

a22erigr commented

2026-05-04 12:26:09 +00:00

Author

Collaborator

@a24sakma The diagrams does not show.

Expected input.
Expected output
The wiki page should show how you make calls to the endpoint.
How the parameters are passed
What datatyp the expected parameters should have
Is it post or get?
Example
We also need to be clear on what data is returned.
Example

{
  "sensorId": "G-Building",
  "timestamp": "2026-05-04T08:12:08.838596",
  "temperature": 20.610000610351562
}

@a24sakma The diagrams does not show. + Expected input. + Expected output The wiki page should show how you make calls to the endpoint. + How the parameters are passed + What datatyp the expected parameters should have + Is it post or get? + Example ![image](/attachments/f7ad7933-ae40-4eef-82d2-3f78236e1981) + We also need to be clear on what data is returned. + Example ``` json { "sensorId": "G-Building", "timestamp": "2026-05-04T08:12:08.838596", "temperature": 20.610000610351562 } ```

image.png

20 KiB

👍 1

a22erigr commented

2026-05-05 09:56:32 +00:00

Author

Collaborator

https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Documentation-for-service-endpoints

👍 1

a24danwe commented

2026-05-06 12:56:45 +00:00

Collaborator

I have noticed the naming convention is not always consistent, since not all files follow the same standard. So therefore, the wiki documentation is based of the existing files and may also be little inconsistent.

👍 1

a24danwe commented

2026-05-06 12:57:47 +00:00

Collaborator

Example some cases where there are UserID and userId.

a24danwe commented

2026-05-06 13:38:16 +00:00

Collaborator

The wiki is finished but for me really messy. There is a template that is followed but it hurts my eyes to go through the wiki. I would appreciate if someone would be so kind to structure it better. I also need a review on it so it is actually accurate in case I have totally misunderstood something about this issue.

The [wiki](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Documentation-for-service-endpoints) is finished but for me really messy. There is a template that is followed but it hurts my eyes to go through the wiki. I would appreciate if someone would be so kind to structure it better. I also need a review on it so it is actually accurate in case I have totally misunderstood something about this issue.

a24danwe added the

help wanted

needs review

labels

2026-05-06 13:38:35 +00:00

a24danwe commented

2026-05-06 13:41:57 +00:00

Collaborator

Also wondering If it is supposed to be like this. Currently all services has a file called Endpoints except energyService and roombookingApiMockup, is it supposed to be like this?

a22erigr commented

2026-05-06 14:51:36 +00:00

Author

Collaborator

@a24danwe wrote in #692 (comment):

Also wondering If it is supposed to be like this. Currently all services has a file called Endpoints except energyService and roombookingApiMockup, is it supposed to be like this?

This is not suppose to be the case. Those two services are about to be refactored to better follow the structure of the other services.
Good work with the wiki, I am sorry if i was a bit wage.

@a24danwe wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/692#issuecomment-8359: > Also wondering If it is supposed to be like this. Currently all services has a file called Endpoints except energyService and roombookingApiMockup, is it supposed to be like this? This is not suppose to be the case. Those two services are about to be refactored to better follow the structure of the other services. Good work with the wiki, I am sorry if i was a bit wage.

a24danwe commented

2026-05-06 15:17:29 +00:00

Collaborator

@a22erigr wrote in #692 (comment):

@a24danwe wrote in #692 (comment):

Also wondering If it is supposed to be like this. Currently all services has a file called Endpoints except energyService and roombookingApiMockup, is it supposed to be like this?

This is not suppose to be the case. Those two services are about to be refactored to better follow the structure of the other services. Good work with the wiki, I am sorry if i was a bit wage.

Sounds good! And you were perfectly fine with your issue description, it is just me that did not know how to structure this well.

@a22erigr wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/692#issuecomment-8379: > @a24danwe wrote in #692 (comment): > > > Also wondering If it is supposed to be like this. Currently all services has a file called Endpoints except energyService and roombookingApiMockup, is it supposed to be like this? > > This is not suppose to be the case. Those two services are about to be refactored to better follow the structure of the other services. Good work with the wiki, I am sorry if i was a bit wage. Sounds good! And you were perfectly fine with your issue description, it is just me that did not know how to structure this well.

c24carso was assigned by a22erigr

2026-05-07 08:40:08 +00:00

c24carso commented

2026-05-07 10:20:04 +00:00

Collaborator

Reviewed the wiki against the actual endpoint definitions in the code. All documented endpoints match what's in the code.
a22erigr showed an example for JSON response. The wiki has return value descriptions but no actual JSON examples.
Adding these examples would make the wiki more useful.
Overall though, the wiki does covers what was asked for and is accurate.

Reviewed the wiki against the actual endpoint definitions in the code. All documented endpoints match what's in the code. a22erigr showed an example for JSON response. The wiki has return value descriptions but no actual JSON examples. Adding these examples would make the wiki more useful. Overall though, the wiki does covers what was asked for and is accurate.

c24carso added

reviewed

and removed

needs review

labels

2026-05-07 10:20:15 +00:00

a22erigr commented

2026-05-07 10:23:51 +00:00

Author

Collaborator

@a24danwe can you update the wiki to contain actual JSON examples. After that the issue can be closed

a24danwe commented

2026-05-07 10:30:02 +00:00

Collaborator

I will do that.

👍 1

a22erigr commented

2026-05-07 10:30:44 +00:00

Author

Collaborator

@a24danwe wrote in #692 (comment):

I will do that.

Write here when you are done so that i can close the issue

@a24danwe wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/692#issuecomment-8650: > I will do that. Write here when you are done so that i can close the issue

a22erigr commented

2026-05-07 10:34:08 +00:00

Author

Collaborator

Can you clarify which service the endpoints exists for.
EX

energyService

GET /energy/all

Path to endpoint

GET /energy/all

Required values

None

Return values

Returns a JSON array:

sql_datatypes: database type info
id: sensor id
esensorid: sensor name
timestamp: time of reading
kilowatt: energy usage

When no error occurs

Returns all energy sensor data
Status: 200 OK

When error occurs

Server failure or database issue
Status: 500

tempService

Can you clarify which service the endpoints exists for. EX # energyService ## GET /energy/all ### Path to endpoint `GET /energy/all` ### Required values None ### Return values Returns a JSON array: - sql_datatypes: database type info - id: sensor id - esensorid: sensor name - timestamp: time of reading - kilowatt: energy usage ### When no error occurs - Returns all energy sensor data - Status: 200 OK ### When error occurs - Server failure or database issue - Status: 500 # tempService

a24danwe commented

2026-05-07 10:56:21 +00:00

Collaborator

Yes, I will do that aswell

a24danwe commented

2026-05-07 11:45:49 +00:00

Collaborator

@a22erigr Can you be so kind and explain how you use this so I will be able to replicate the output. I have tried something called postman but it seems to not work for me.

@a22erigr Can you be so kind and explain how you use this![image](/attachments/afea1501-6723-4266-b751-0d4ac917bd81) so I will be able to replicate the output. I have tried something called postman but it seems to not work for me.

image.png

136 KiB

a24danwe commented

2026-05-20 12:37:08 +00:00

Collaborator

This issue can be closed.

👍 1

a24danwe added the

close

label

2026-05-20 12:37:16 +00:00

a22erigr commented