Mockup generation taskforce consensus of architecture and development patterns #191

Closed
opened 2026-04-08 13:47:40 +00:00 by b24johka · 12 comments
Collaborator

We'll have a meeting with all of the developers that is working on the mockup generation to make sure that we have a uniform standard in the pattern.
This might be a base to form the guidelines regarding mockup generation.
Related to issue: #126 #52 #127 #142

We'll have a meeting with all of the developers that is working on the mockup generation to make sure that we have a uniform standard in the pattern. This might be a base to form the guidelines regarding mockup generation. Related to issue: #126 #52 #127 #142
Collaborator

The result from this meeting can you find here: https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Mock-Api-Documentation
closing this issue.

The result from this meeting can you find here: https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Mock-Api-Documentation closing this issue.
Author
Collaborator

This has been approved without review, i will reopen the issue.

This has been approved without review, i will reopen the issue.
b24johka 2026-04-09 09:29:26 +00:00
Collaborator

This seems to be more of a guide to how we create our mock API's then documentation about how to use them for future developers. This is not an actual issue as it is the intended purpose of this wiki section AND the project plans on swapping over to intended API's in the future. But i would suggest changing the name of the wiki page away from "mock API documentation" to something more similar to "rules of creating mock API" or "mock API creation guidelines" as documentation is a key word for finding information about how to use a tool in the future.

The emphasis on the existence of unique functionalities between sensors and the need to create README files is good and will make it easier for future developers to understand and use the mockup API's. But the guidelines seem vague for new developers in case they want to or need to create their own mockup API in the future. Include some examples of code and structure for future developers.

Additionally, i don't know if this is necessary, but we might want to include some form of guidelines or documentation about how the mockup's store information so it can be either uniform between mockup API's or match the JSON file structure of the intended API the mockup is currently representing, and thus make it easier to fetch data for different data handlers and swapping over to intended API's in the future.

This seems to be more of a guide to how we create our mock API's then documentation about how to use them for future developers. This is not an actual issue as it is the intended purpose of this wiki section AND the project plans on swapping over to intended API's in the future. But i would suggest changing the name of the wiki page away from "mock API documentation" to something more similar to "rules of creating mock API" or "mock API creation guidelines" as documentation is a key word for finding information about how to use a tool in the future. The emphasis on the existence of unique functionalities between sensors and the need to create README files is good and will make it easier for future developers to understand and use the mockup API's. But the guidelines seem vague for new developers in case they want to or need to create their own mockup API in the future. Include some examples of code and structure for future developers. Additionally, i don't know if this is necessary, but we might want to include some form of guidelines or documentation about how the mockup's store information so it can be either uniform between mockup API's or match the JSON file structure of the intended API the mockup is currently representing, and thus make it easier to fetch data for different data handlers and swapping over to intended API's in the future.
Collaborator

Having some stadards for how to create mockup data might be sound but each mockup will still need documentation about how to use that API and what is returned.

The rules:

  • Every micro service shall have a database. At the moment we use sensor database until the investigation about the database structure is done.
    This might need some talk with teamleaders, personally i dont think a database for each is nessasary as we would just create manny dbs with one table each, insted we can just add a table to the postgreSQL that exist. This fuctionality is implimented in the middleware as functions witch gets called with MQTT using this would also make the data uniform as it gets saved the same way

  • Map Structure shall follow Object oriented (use of classes) check out the parking service structure.
    This seem good to me, and makes it easy to use.

  • Every micro service has unique functionalities such as electricity and sensor then some parts may not be similar.

  • Having a README: What to include:- How it integrates from frontend and back

  1. How we reach the data and having proper comments
  2. In the pr having a label about testing
  3. How to build the project and make it run
  4. The decision and why
    This is in my oppinion the only really important part documentation as wiki and readme, Other classmates will use the data so how we create the data isnt that important as its just a mockup the important part is that others know how to use this API and know what gets returened for the views that will be created and that the data created is "realistic".
Having some stadards for how to create mockup data might be sound but each mockup will still need documentation about how to use that API and what is returned. The rules: - Every micro service shall have a database. At the moment we use sensor database until the investigation about the database structure is done. **This might need some talk with teamleaders, personally i dont think a database for each is nessasary as we would just create manny dbs with one table each, insted we can just add a table to the postgreSQL that exist. This fuctionality is implimented in the middleware as functions witch gets called with MQTT using this would also make the data uniform as it gets saved the same way** - Map Structure shall follow Object oriented (use of classes) check out the parking service structure. **This seem good to me, and makes it easy to use.** - Every micro service has unique functionalities such as electricity and sensor then some parts may not be similar. - Having a README: What to include:- How it integrates from frontend and back 1. How we reach the data and having proper comments 2. In the pr having a label about testing 3. How to build the project and make it run 4. The decision and why **This is in my oppinion the only really important part documentation as wiki and readme, Other classmates will use the data so how we create the data isnt that important as its just a mockup the important part is that others know how to use this API and know what gets returened for the views that will be created and that the data created is "realistic".**
Collaborator

@a24hirsa wrote in #191 (comment):

This seems to be more of a guide to how we create our mock API's then documentation about how to use them for future developers. This is not an actual issue as it is the intended purpose of this wiki section AND the project plans on swapping over to intended API's in the future. But i would suggest changing the name of the wiki page away from "mock API documentation" to something more similar to "rules of creating mock API" or "mock API creation guidelines" as documentation is a key word for finding information about how to use a tool in the future.

I agree 100%, and this was briefly discussed with the leaders as well. We'll have to discuss this during the meeting to make the overall task a bit less fuzzy.

@c24danli wrote in #191 (comment):

  • Every micro service shall have a database. At the moment we use sensor database until the investigation about the database structure is done.
    This might need some talk with teamleaders, personally i dont think a database for each is nessasary as we would just create manny dbs with one table each, insted we can just add a table to the postgreSQL that exist. This fuctionality is implimented in the middleware as functions witch gets called with MQTT using this would also make the data uniform as it gets saved the same way

This was discussed with team leaders as well, and it also makes sense for each service to have its own database as we're working with the microservice architecture and therefore want to emphasize on loose coupling as much as possible so different people/teams can work on the different services without stepping on each other's toes. Furthermore, should there be issues with one database it won't affect the other services.
One could argue that having a single shared database is fine for a very quick prototype(especially when our database is as sparse as it is now), but the question is how much technical debt we want to leave for future developers.

@a24hirsa wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/191#issuecomment-1558: > This seems to be more of a guide to how we create our mock API's then documentation about how to use them for future developers. This is not an actual issue as it is the intended purpose of this wiki section AND the project plans on swapping over to intended API's in the future. But i would suggest changing the name of the wiki page away from "mock API documentation" to something more similar to "rules of creating mock API" or "mock API creation guidelines" as documentation is a key word for finding information about how to use a tool in the future. I agree 100%, and this was briefly discussed with the leaders as well. We'll have to discuss this during the meeting to make the overall task a bit less fuzzy. @c24danli wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/191#issuecomment-1981: > * Every micro service shall have a database. At the moment we use sensor database until the investigation about the database structure is done. > **This might need some talk with teamleaders, personally i dont think a database for each is nessasary as we would just create manny dbs with one table each, insted we can just add a table to the postgreSQL that exist. This fuctionality is implimented in the middleware as functions witch gets called with MQTT using this would also make the data uniform as it gets saved the same way** This was discussed with team leaders as well, and it also makes sense for each service to have its own database as we're working with the microservice architecture and therefore want to emphasize on loose coupling as much as possible so different people/teams can work on the different services without stepping on each other's toes. Furthermore, should there be issues with one database it won't affect the other services. One could argue that having a single shared database is fine for a very quick prototype(especially when our database is as sparse as it is now), but the question is how much technical debt we want to leave for future developers.
Collaborator

We had a pair review with @c24danli and clarified some of the points.

  • Database is another team that work on and we can give input to the team that they do the research but for now we wait for the final research
  • The other points as we are still in the beginning of deciding how the communication architecture works. We will adjust the wiki and add more information in the readme when we are done with the final architecture.
  • We will make a re review request when this is done .
  • Await for the updates.
We had a pair review with @c24danli and clarified some of the points. - Database is another team that work on and we can give input to the team that they do the research but for now we wait for the final research - The other points as we are still in the beginning of deciding how the communication architecture works. We will adjust the wiki and add more information in the readme when we are done with the final architecture. - We will make a re review request when this is done . - Await for the updates.
Collaborator

Is this being documented/worked with? Just asking for an update

Is this being documented/worked with? Just asking for an update
Collaborator

Yeah, we said will update thie wiki when we are done with overall structure of the mockups. This can be kept open for not forgetting

Yeah, we said will update thie wiki when we are done with overall structure of the mockups. This can be kept open for not forgetting
Author
Collaborator

Meeting held 30/04 about architecture, these are the decisions:

  1. Refactoring of directories in services
  2. Convert roombooking to not use MQTT
  3. Refactor parking service to be sensor structure
  4. Disable update/delete in middleware (Only for censors)
  5. Wiki page on all of the decisions of the mockup architecture
  6. Every service needs to be updated to the new structure
  7. Create diagrams of the new architecture before implementation
### Meeting held 30/04 about architecture, these are the decisions: 1. Refactoring of directories in services 2. Convert roombooking to not use MQTT 3. Refactor parking service to be sensor structure 4. Disable update/delete in middleware (Only for censors) 5. Wiki page on all of the decisions of the mockup architecture 6. Every service needs to be updated to the new structure 7. Create diagrams of the new architecture before implementation
Collaborator

@b24johka wrote in #191 (comment):

Meeting held 30/04 about architecture, these are the decisions:

  1. Refactoring of directories in services
  2. Convert roombooking to not use MQTT
  3. Refactor parking service to be sensor structure
  4. Disable update/delete in middleware (Only for censors)
  5. Wiki page on all of the decisions of the mockup architecture
  6. Every service needs to be updated to the new structure
  7. Create diagrams of the new architecture before implementation

We'll need new issues for the following points here:
-1: one new issue for roombooking,
one for parking,
one for energy.
-2: one new issue.
-3: one new issue.
-4: one new issue.
-5: Probably one new issue that the people in the mockup group will have to cooperate on?
-6: This probably goes hand-in-hand with 1. Doesn't seem like they need to be separate issues as they will both happen at the same time in the same task.
-7:
one for room booking
one for power
one for parking.

@b24johka wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/191#issuecomment-6873: > ### [](#meeting-held-30-04-about-architecture-these-are-the-decisions)Meeting held 30/04 about architecture, these are the decisions: > 1. Refactoring of directories in services > 2. Convert roombooking to not use MQTT > 3. Refactor parking service to be sensor structure > 4. Disable update/delete in middleware (Only for censors) > 5. Wiki page on all of the decisions of the mockup architecture > 6. Every service needs to be updated to the new structure > 7. Create diagrams of the new architecture before implementation We'll need new issues for the following points here: -1: **one** new issue for roombooking, **one** for parking, **one** for energy. -2: **one** new issue. -3: **one** new issue. -4: **one** new issue. -5: Probably **one** new issue that the people in the mockup group will have to cooperate on? -6: This probably goes hand-in-hand with 1. Doesn't seem like they need to be separate issues as they will both happen at the same time in the same task. -7: **one** for room booking **one** for power **one** for parking.
Collaborator

The issues to the diagrams are created. Don't create any new issues on those.

The issues to the diagrams are created. Don't create any new issues on those.
Collaborator

we have left the documentation which will be done in this issue. #910. I close this issue now

Good job everyone.!

we have left the documentation which will be done in this issue. https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/910. I close this issue now Good job everyone.!
Sign in to join this conversation.
No milestone
No project
6 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#191
No description provided.