Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Three different names for a Sensor ID #81

Open
KiithNabaal opened this issue Jul 23, 2019 · 1 comment
Open

Three different names for a Sensor ID #81

KiithNabaal opened this issue Jul 23, 2019 · 1 comment
Labels
documentation Use for the documentation

Comments

@KiithNabaal
Copy link
Contributor

In the Sensor API docs, we refer to the UUID with three different names:

  • name
  • uuid
  • id

Should have just one name/reference for this property.

To create a sensor, the name field is set to "Test_Sensor", but then in get sensor details, name is the uuid and "Test_Sensor" was bumped to source_name. Then in the search request, we refer to a sensor "ID" to mean UUID, and there is no mention of a "name" field (except in the response, which bumps ID to "name" again).

@KiithNabaal KiithNabaal added the documentation Use for the documentation label Jul 23, 2019
@KiithNabaal
Copy link
Contributor Author

https://bd-performance.andrew.cmu.edu/api/CentralService/sensor.html#search-sensors
Refers to both sensor ID and UUID in the same line (for search input), but that same value is referred to as "name" in the response.

https://bd-performance.andrew.cmu.edu/api/CentralService/sensor.html#create-a-sensor
To create a sensor, you have to input "name" and "identifier" (not source_name or source_identifier), but the response field is "uuid".

sud335 added a commit that referenced this issue Jun 2, 2022
Upgrades Building Depot Python version to Python3:

- Closes #8, #38, #39, #51, #58, #61, #81, #102
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Use for the documentation
Projects
None yet
Development

No branches or pull requests

1 participant