Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Links for r1 and API YAMLs
  • Loading branch information
hdamker committed Aug 7, 2024
1 parent e4570a6 commit c549fe2
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,27 @@ Repository to describe, develop, document and test the QualityOnDemand API famil

## Status and released versions

* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.

* **The latest available and released version 0.10.1 is available [here](https://github.com/camaraproject/QualityOnDemand/tree/release-0.10.1)**
- API definition v0.10.1 with inline documentation:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.10.1/code/API_definitions/qod-api.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.10.1/code/API_definitions/qod-api.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/release-0.10.1/code/API_definitions/qod-api.yaml)
* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest public release**.

* The latest public release is available here: https://github.com/camaraproject/DeviceStatus/releases/latest
* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceStatus/blob/main/CHANGELOG.md)

* The current pre-release for the [Fall24 meta-release](https://wiki.camaraproject.org/display/CAM/Meta-release+Fall24) is [r1.1](https://github.com/camaraproject/QualityOnDemand/tree/r1.1)
The release r1.1 contains the following API definitions (with inline documentation):
* **quality-on-demand v0.11.0-rc.1**
[[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.1/code/API_definitions/quality-on-demand.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.1/code/API_definitions/quality-on-demand.yaml&nocors)
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.1/code/API_definitions/quality-on-demand.yaml)

* **qos-profiles v0.11.0-rc.1**
[[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.1/code/API_definitions/qos-profiles.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.1/code/API_definitions/qos-profiles.yaml&nocors)
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.1/code/API_definitions/qos-profiles.yaml)

* qod-provisioning v0.1.0-rc.1 (new, first initial version)
[[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.1/code/API_definitions/qod-provisioning.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.1/code/API_definitions/qod-provisioning.yaml&nocors)
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.1/code/API_definitions/qod-provisioning.yaml)

* Provider implementations (PI) are available within separate repositories (partly for previous releases):

Expand All @@ -41,7 +55,7 @@ Repository to describe, develop, document and test the QualityOnDemand API famil
## Contributing

* Meetings are held virtually
* Schedule: bi-weekly, Friday, 2 PM CET/CEST (13:00 UTC, 12:00 UTC during European DST). For date/time of the next meeting, see previous minutes
* Schedule: bi-weekly, Friday, 2 PM CET/CEST (13:00 UTC, 12:00 UTC during European DST). For date/time of the next meeting, see previous meeting minutes
* [Megistration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94112812156?password=f238d6af-c959-48d7-a862-abdb3c648e40)
* Minutes: Access [meeting minutes](https://wiki.camaraproject.org/x/0AOeAQ)
* Mailing List
Expand Down

0 comments on commit c549fe2

Please sign in to comment.