-
Notifications
You must be signed in to change notification settings - Fork 77
create openapi.yml for developer api #525
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
Conversation
alitariksahin
commented
Aug 28, 2025
- Create openapi specs for developer api
- remove mdx files, since docs.json will directly read its content from openapi
- specify x-mint attribute to provide the urls so that the urls will stay the same, and if there is any reference to these urls they will keep working.
devops/developer-api/openapi.yml
Outdated
enum: | ||
- Free | ||
- Pay as You Go | ||
- Enterprise |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am guessing this isn't true
I remember that you mentioned the API being out of date (it probably is).
Can you go over the types once again? While going over them, it would be great if you can verify against the API or check the types in console
devops/developer-api/openapi.yml
Outdated
consistent: | ||
type: boolean | ||
description: Strong consistency mode is enabled | ||
reserved_per_region_price: | ||
type: integer | ||
description: Reserved price per region for enterprise plans | ||
format: int64 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
consistent isn't returned. reserved_per_region_price is returned but I don't know what it is. Asked here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"eviction": false,
"auto_upgrade": false,
"consistent": false,
"reserved_type": "",
"daily_backup_enabled": false,
in my console consistent was also returned
description: Region of the database. Only valid option is 'global'. | ||
enum: | ||
- global |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not true for gcp global
devops/developer-api/openapi.yml
Outdated
- us-east-1 | ||
- us-west-1 | ||
- us-west-2 | ||
- eu-west-1 | ||
- eu-central-1 | ||
- ap-southeast-1 | ||
- ap-southeast-2 | ||
- sa-east-1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not the whole list
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nicely done!