Documentation: Publish OpenAPI Spec openly

[timothytavarez]

Contact Details

[email protected]

Overview of Change

I'm trying to implement and test Carbon Aware SDK. It has been a year since I last picked it up.

Correct me if I'm wrong, but in order to get a copy of the OpenAPI specification, I must:

1. Clone the Git repository.
2. Install .NET runtime. If using the latest supported .NET runtime, update the global.json with the correct version.
3. Install required Swagger tooling.
4. Execute build instructions.

See https://carbon-aware-sdk.greensoftware.foundation/docs/tutorial-basics/carbon-aware-webapi#autogenerate-webapi for current details.

Does this strike anyone else as a little silly in order to just get a OpenAPI spec? This could all be avoided by just publishing the file ... anywhere.

I want to use this project, and encourage its adoption, but I've just lost an hour of my time dealing with this due to local runtime issues and I'm no closer to a spec.

Code of Conduct

• I agree to follow this project's Code of Conduct

[danuw]

Hi @timothytavarez,

For testing you can use this https://carbon-aware-api.azurewebsites.net/swagger/v1/swagger.yaml

We provide you with the steps so it can be done with whatever version you are going to deploy/interact with. (the above is just for quick testing and is not guaranteed to always be up).

Hope that unlocks you.