Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/workloads/pathfinder-openapi-specs
OpenAPI Specs for Pathfinder
https://github.com/workloads/pathfinder-openapi-specs
arduino esp32 openapi
Last synced: 26 days ago
JSON representation
OpenAPI Specs for Pathfinder
- Host: GitHub
- URL: https://github.com/workloads/pathfinder-openapi-specs
- Owner: workloads
- License: apache-2.0
- Created: 2024-08-22T21:10:42.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-06T12:22:18.000Z (4 months ago)
- Last Synced: 2024-11-03T20:42:06.255Z (2 months ago)
- Topics: arduino, esp32, openapi
- Language: Makefile
- Homepage: https://github.com/workloads/pathfinder-openapi-specs
- Size: 108 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pathfinder OpenAPI Specifications
> OpenAPI Specifications for the Pathfinder platform
## Table of Contents
* [Pathfinder OpenAPI Specifications](#pathfinder-openapi-specifications)
* [Table of Contents](#table-of-contents)
* [Specifications](#specifications)
* [Requirements](#requirements)
* [Development](#development)
* [Usage](#usage)
* [Contributors](#contributors)
* [License](#license)
## Specifications
Pathfinder consists of distinct hardware components, each with their own API specification.
- Mobility Platform: [mobility-platform/openapi.yml](./mobility-platform/openapi.yml)
- Vision Platform: `pending`
For more information on the underlying hardware, see [workloads/pathfinder](https://github.com/workloads/pathfinder?tab=readme-ov-file#hardware).
## Requirements
- a copy of [@workloads/tooling](https://github.com/workloads/tooling)
#### Development
For development and testing of this repository:
* `prism` `5.9.0` or [newer](https://www.npmjs.com/package/@stoplight/prism-cli)
* `redocly` `1.19.0` or [newer](https://www.npmjs.com/package/@redocly/cli)
* `spectral` `6.1.0` or [newer](https://www.npmjs.com/package/@stoplight/spectral-cli)
These tools provide linting, validation, and documentation generation for OpenAPI specifications.
## Usage
This repository provides a [Makefile](./Makefile)-based workflow.
Running `make` without commands prints the following help information:
```text
🧠PATHFINDER OPENAPI SPECS
Target Description Usage
lint-yaml lint YAML files using yamllint `make lint-yaml`
lint-redocly lint OAS files using redocly `make lint-redocly`
lint-redocly-config lint Redocly config file using redocly `make lint-redocly-config`
lint-spectral lint OAS files using spectral `make lint-spectral`
redocly-preview preview docs using redocly `make redocly-preview`
redocly-build build docs using redocly `make redocly-build`
redocly-bundle bundle output without decorators using redocly `make redocly-bundle`
redocly-bundle-terraform bundle output for Terraform using redocly `make redocly-bundle-terraform`
redocly-bundle-arduino bundle output for Arduino using redocly `make redocly-bundle-arduino`
redocly-generate-ignore generate (or update) an ignores file using redocly `make redocly-generate-ignore`
prism-mock-mobility start mock server using prism `make prism-mock-mobility`
provider-config generate plugin generator config using tfplugingen-openapi `make provider-config`
provider-framework generate plugin framework config using tfplugingen-framework `make provider-framework`
help display a list of Make Targets `make help`
_listincludes list all included Makefiles and *.mk files `make _listincludes`
_selfcheck lint Makefile `make _selfcheck`
lint-vale lint prose using vale `make lint-vale`
vale-sync sync Vale dependencies `make vale-sync`
```
## Contributors
For a list of current (and past) contributors to this repository, see [GitHub](https://github.com/workloads/pathfinder-openapi-specs/graphs/contributors).
## License
Licensed under the Apache License, Version 2.0 (the "License").
You may download a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
See the License for the specific language governing permissions and limitations under the License.