This repo is used for updating the Autodesk Vault Data API OpenAPI specification since it is not currently included in the aps-sdk-openapi repo. The versioning from the Vault Data API OpenAPI specification endpoint will remain to know if it is synced. A text comparison can be used to know what has been updated.
From the OpenAPI Specification:
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
This repository includes an automated GitHub Actions workflow that generates API clients using Microsoft Kiota whenever the OpenAPI specification (VaultDataApi.yml) is updated via a pull request.
- Trigger: The workflow automatically runs when a pull request modifies
VaultDataApi.yml. - Generation: Uses Microsoft Kiota to generate API clients for specified languages (currently C#).
- Artifact: The generated clients are uploaded as a workflow artifact for comparison & review.
- Comment: A summary comment is added to the PR with details about the generated clients.
- Merge: Once the PR is approved & merged, another workflow will run to generate the API clients & commit the changes.
- Autodesk: aps-sdk-openapi