https://github.com/indicio-tech/acapy-openapi
Cleaned up OpenAPI spec files for ACA-Py of various versions
https://github.com/indicio-tech/acapy-openapi
Last synced: 2 months ago
JSON representation
Cleaned up OpenAPI spec files for ACA-Py of various versions
- Host: GitHub
- URL: https://github.com/indicio-tech/acapy-openapi
- Owner: Indicio-tech
- Created: 2021-09-16T16:53:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T20:00:04.000Z (almost 2 years ago)
- Last Synced: 2025-04-01T15:06:24.117Z (3 months ago)
- Language: Shell
- Size: 688 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Updating the OpenAPI
The process of updating the OpenAPI is mostly automated, you only need to run a
few scripts. First determine the version you want for OpenAPI spec from the
BCGov agent docker images
(https://hub.docker.com/r/bcgovimages/aries-cloudagent/). Currently the default
for the `retrieve-openapi.sh` script is "py3.9-0.10.1".
After that you can run the following commands to update the `openapi.yml`
file.
```sh
cd acapy-openapi
# Retrieve the open api file, change py3.9-0.10.1 if you want another version
./scripts/retrieve-openapi.sh py3.9-0.10.1
# transform to OpenAPI V3
./scripts/convert-to-openapi3.sh
# Fix the openapi file (add missing operation ids from data/operation-id-map.yml)
./scripts/process-openapi.sh
# Apply manual patches to the openapi file
./scripts/apply-patch.sh
```