docs: Add description to README #8
Conversation
| - Endpoint: a path that accepts an HTTP request and returns a response. | ||
| - Route: the direct parent path of a collection of one or more endpoints. | ||
| - Subroute: A route that is nested under another route. | ||
| - Namespace: the direct parent path of a collection routes only: there are no endpoints under this path. |
There was a problem hiding this comment.
| - Namespace: the direct parent path of a collection routes only: there are no endpoints under this path. | |
| - Namespace: the direct parent path of a collection of routes only; there are no endpoints under this path. |
There was a problem hiding this comment.
there are no endpoints under this path.
Does it mean that noise_sensors is also a namespace, besides acs? Although, /noise_sensors could potentially have /get and /list endpoints since we have those for /locks.
There was a problem hiding this comment.
/noise_sensors/list should exist if it doesn't, it is not intended to be a namespace.
There was a problem hiding this comment.
There are no endpoints under /nosie_sensors. What about /noise_sensors/get, should we add it as well?
There was a problem hiding this comment.
Actually, only /nosie_sensors/list
There was a problem hiding this comment.
Created an issue https://github.com/seamapi/seam-connect/issues/7520
| The scope of the [OpenAPI Specification](https://swagger.io/specification/) covers arbitrarily complicated APIs, | ||
| while the Seam API follows very predictable and simplified API design patterns. |
There was a problem hiding this comment.
Is the line break intentional here?
| The scope of the [OpenAPI Specification](https://swagger.io/specification/) covers arbitrarily complicated APIs, | |
| while the Seam API follows very predictable and simplified API design patterns. | |
| The scope of the [OpenAPI Specification](https://swagger.io/specification/) covers arbitrarily complicated APIs, while the Seam API follows very predictable and simplified API design patterns. |
There was a problem hiding this comment.
I break long lines in markdown intentionally. It doesn't change the format and it makes diffs / comments easier to target.
Note that linebreaks in github comments / issues do change the format (no idea why their parser is different 🤷🏻 ).
| - Extending the OpenAPI Specification with non-standard properties to support Seam's SDK and documentation requirements | ||
| is not directly compatible with existing tools. |
There was a problem hiding this comment.
Same here with the line break
| - Extending the OpenAPI Specification with non-standard properties to support Seam's SDK and documentation requirements | |
| is not directly compatible with existing tools. | |
| - Extending the OpenAPI Specification with non-standard properties to support Seam's SDK and documentation requirements is not directly compatible with existing tools. |
| - The blueprint is not limited by the OpenAPI Specification or constrained by the wide scope of supporting any API. | ||
| It is optimized for Seam's requirements and can evolve faster to meet Seam's specific concerns and integrate directly with other Seam integrated tooling. |
There was a problem hiding this comment.
Same here
| - The blueprint is not limited by the OpenAPI Specification or constrained by the wide scope of supporting any API. | |
| It is optimized for Seam's requirements and can evolve faster to meet Seam's specific concerns and integrate directly with other Seam integrated tooling. | |
| - The blueprint is not limited by the OpenAPI Specification or constrained by the wide scope of supporting any API. It is optimized for Seam's requirements and can evolve faster to meet Seam's specific concerns and integrate directly with other Seam integrated tooling. |
Co-authored-by: Andrii Balitskyi <[email protected]>
Co-authored-by: Andrii Balitskyi <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
No description provided.