OpenAPI: absolute URL for "Upload a release asset" endpoint

[gr2m]

The route for Upload a release asset is POST :upload_url.

The OpenAPI spec works around a base URL -> relative paths -> http method, it throws an error for {upload_url} as it expects paths to start with a /.

I’m not quite sure where to put this route in the OpenAPI spec right now

[gr2m]

ping @bobby-brennan I hope you don’t mind? Thanks for your help at APIs-guru/unofficial_openapi_specs#12 🙏

I wonder if you can think of a way to model and endpoint which URL is entirely variable in OpenAPI? I tried a few things e.g. with the servers property but to no avail ...

[rbren]

This might be impossible. Some resources:
Overriding Servers section here: https://swagger.io/docs/specification/api-host-and-base-path/
OAI/OpenAPI-Specification#892
OAI/OpenAPI-Specification#1459

However, it looks to me like upload_url might always be of the form:

https://uploads.github.com/repos/{user}/{repo}/releases/{release}/assets

If that's the case, you could set the path to /repos/{user}/{repo}/releases/{release}/assets, and set servers on that operation to https://upload.github.com

Otherwise, I would just put these instructions in the documentation for https://developer.github.com/v3/repos/releases/#create-a-release

[gr2m]

However, it looks to me like upload_url might always be of the form:

https://uploads.github.com/repos/{user}/{repo}/releases/{release}/assets

Unfortunately the URL looks different for Enterprise Instances, I think its {enterprise_host}/api/uploads/repos/{user}/{repo}/releases/{release}/assets.

But that could potentially be addressed using servers I think.

Thanks so much for your help!