Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add openapi.yml file with autopilot routes #1724

Merged
merged 8 commits into from
Dec 9, 2024

Conversation

ChrisSchinnerl
Copy link
Member

@ChrisSchinnerl ChrisSchinnerl commented Dec 6, 2024

Added an openapi.yml spec with the specifications for the autopilot routes and a CI step to validate it. The goal is to eventually have a complete spec for the V2 API that we can use to generate API docs as well as making sure that there is always a valid spec for every given commit in the repo.

@ChrisSchinnerl ChrisSchinnerl changed the title Add barebone openapi spec Add openapi.yml file with autopilot routes Dec 6, 2024
@ChrisSchinnerl ChrisSchinnerl self-assigned this Dec 6, 2024
@ChrisSchinnerl ChrisSchinnerl marked this pull request as ready for review December 6, 2024 14:16
@@ -104,11 +104,11 @@ type (

// MinPriceTableValidity is the minimum accepted value for `Validity` in the
// host's price settings.
MinPriceTableValidity time.Duration `json:"minPriceTableValidity"`
MinPriceTableValidity DurationMS `json:"minPriceTableValidity"`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice side effect of the tedious work of writing this specification is that you really don't miss any type. Found 2 fields that we still haven't changed to our MS type.

openapi.yml Outdated Show resolved Hide resolved
Copy link
Member

@peterjan peterjan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, going to be such a pain though but definitely cool we'll have docs inside of the repo.

Co-authored-by: Peter-Jan Brone <peterjan.brone@gmail.com>
@ChrisSchinnerl ChrisSchinnerl merged commit ee84ee7 into its-happening Dec 9, 2024
11 of 16 checks passed
@ChrisSchinnerl ChrisSchinnerl deleted the chris/openapi branch December 9, 2024 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants