create openapi.yml for developer api #525
Conversation
alitariksahin
commented
Aug 28, 2025
alitariksahin
commented
- 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.
| enum: | ||
| - Free | ||
| - Pay as You Go | ||
| - Enterprise |
There was a problem hiding this comment.
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
| enum: | ||
| - active | ||
| - deleted |
There was a problem hiding this comment.
this is not correct too. You can check options from console.
| cluster_id: | ||
| type: string | ||
| description: Cluster ID of the database | ||
| pool_id: | ||
| type: string | ||
| description: Pool ID of the database |
There was a problem hiding this comment.
these are removed it seems
| 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.
consistent isn't returned. reserved_per_region_price is returned but I don't know what it is. Asked here
| description: Region of the database. Only valid option is 'global'. | ||
| enum: | ||
| - global |
| - us-east-1 | ||
| - us-west-1 | ||
| - us-west-2 | ||
| - eu-west-1 | ||
| - eu-central-1 | ||
| - ap-southeast-1 | ||
| - ap-southeast-2 | ||
| - sa-east-1 |
| Specifies the fixed plan type for the database. | ||
| If omitted, the database defaults to either the pay-as-you-go or free plan, based on the account type. | ||
| enum: | ||
| - payg |
| type: string | ||
| description: The new plan for the database | ||
| enum: | ||
| - payg |
There was a problem hiding this comment.
also missing free. Is there no way to define these enums in somewhere common and use it everywhere else?
| produce_throughput: | ||
| type: array | ||
| nullable: true | ||
| items: | ||
| $ref: "#/components/schemas/TimeSeriesData" | ||
| description: Write throughput over time | ||
| consume_throughput: | ||
| type: array | ||
| nullable: true | ||
| items: | ||
| $ref: "#/components/schemas/TimeSeriesData" | ||
| description: Read throughput over time |
There was a problem hiding this comment.
let's just remove the ones listed here from the docs
https://upstash.slack.com/archives/C099375LDKM/p1756716293035659
| state: | ||
| type: string | ||
| description: State of the backup | ||
| example: "completed" |
