N
Neon•2y ago
adverse-sapphire

OpenAPI Specification for the Neon API

Is there an OpenAPI schema available for the API at https://console.neon.tech/api/v2 ? We seem to have found one over a year ago, but I'm looking to have it updated.
5 Replies
probable-pink
probable-pink•2y ago
Hi, yes, you can find it here: https://neon.tech/api_spec/release/v2.json For future reference, if you go to our API docs, there is an OpenAPI Spec link in the navigation bar: https://api-docs.neon.tech/reference/getting-started-with-neon-api
Neon
Get started with the Neon API
This page will help you get started with the Neon API
adverse-sapphire
adverse-sapphireOP•2y ago
Wow. I googled and searched everywhere for that. Thank you!
probable-pink
probable-pink•2y ago
Thanks for that feedback. We'll need to make it easier to find.
adverse-sapphire
adverse-sapphireOP•2y ago
There is an issue in the schema. Refer to the created_at field on Organization below. 
  "Organization": {
      "type": "object",
      "required": [
          "id",
          "name"
      ],
      "properties": {
          "id": {
              "type": "string",
              "format": "uuid"
          },
          "name": {
              "type": "string"
          },
          "created_by": {
              "description": "The user id of the user that created the organization\n",
              "type": "string"
          },
          "created_at": {
              "description": "A timestamp indicting when the organization was created\ntype: string\nformat: date-time\n"
          },
          "updated_at": {
              "description": "A timestamp indicating when the organization was updated\n",
              "type": "string",
              "format": "date-time"
          },
          "invitations": {
              "description": "List of all the invitations extended in this organization\n",
              "type": "array",
              "items": {
                  "$ref": "#/components/schemas/Invitation"
              }
          },
          "members": {
              "description": "List of all active members in the organization\n",
              "type": "array",
              "items": {
                  "$ref": "#/components/schemas/Member"
              }
          }
      }
  },
  "Organization": {
      "type": "object",
      "required": [
          "id",
          "name"
      ],
      "properties": {
          "id": {
              "type": "string",
              "format": "uuid"
          },
          "name": {
              "type": "string"
          },
          "created_by": {
              "description": "The user id of the user that created the organization\n",
              "type": "string"
          },
          "created_at": {
              "description": "A timestamp indicting when the organization was created\ntype: string\nformat: date-time\n"
          },
          "updated_at": {
              "description": "A timestamp indicating when the organization was updated\n",
              "type": "string",
              "format": "date-time"
          },
          "invitations": {
              "description": "List of all the invitations extended in this organization\n",
              "type": "array",
              "items": {
                  "$ref": "#/components/schemas/Invitation"
              }
          },
          "members": {
              "description": "List of all active members in the organization\n",
              "type": "array",
              "items": {
                  "$ref": "#/components/schemas/Member"
              }
          }
      }
  },
It should look like this: 
          "created_at": {
              "description": "A timestamp indicting when the organization was created\n",
              "type": "string",
              "format": "date-time"
          },
          "created_at": {
              "description": "A timestamp indicting when the organization was created\n",
              "type": "string",
              "format": "date-time"
          },
If this is open source, then please point me to where I can fix it
probable-pink
probable-pink•2y ago
The spec source is in our control plane repo, which is private. I'll pass this on to the team to get a fix. Thanks for pointing this out.

Did you find this page helpful?