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

OpenAPI Generator - Missing resources #1964

Closed
philbuettner opened this issue Sep 19, 2019 · 0 comments
Closed

OpenAPI Generator - Missing resources #1964

philbuettner opened this issue Sep 19, 2019 · 0 comments

Comments

@philbuettner
Copy link
Contributor

philbuettner commented Sep 19, 2019

The resources "/things", "/things/{thingId}", "/things/{thingId}/features/{featureId}/properties" and "/things/{thingId}/features/{featureId}/properties/{propertyPath}" are missing from the generated openAPI specifications. However they are available in the original IoT Things REST API. See https://apidocs.bosch-iot-suite.com/?urls.primaryName=Bosch%20IoT%20Things%20-%20API%20v2#/.

For the purpose of completion, these resources should also be available in the generated documentation.

Details:

  • /things resource should be added to the generated openAPI specifications. The return type should use the generic "Things" schema defined by IoT Things REST API.

  • /things/{thingId} resource should be added. The return type should use the specific schema defined by the corresponding vorto definition. For example, for smart home controller openAPI specification, the schema should be the JSON structure of SHC thing.

  • /things/{thingId}/features/{featureId}/properties resource should be added. The return type should use the specific schema for the properties. For example, for feature DeviceInfo, the DeviceInfoProperties should be used.

  • /things/{thingId}/features/{featureId}/properties/{propertyPath} should be added. The definition for the IoT Things REST API can be used completely.

@aedelmann aedelmann added this to the 0.12 milestone Sep 24, 2019
@aedelmann aedelmann added the bug label Sep 27, 2019
@aedelmann aedelmann removed this from the 0.12 milestone Sep 30, 2019
@aedelmann aedelmann added this to the 0.12.2 milestone Oct 10, 2019
philbuettner pushed a commit to philbuettner/vorto that referenced this issue Oct 10, 2019
philbuettner pushed a commit to philbuettner/vorto that referenced this issue Oct 29, 2019
aedelmann pushed a commit that referenced this issue Oct 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants