Skip to content

Instantly share code, notes, and snippets.

@kevinkirkup
Last active January 25, 2022 14:42
Show Gist options
  • Save kevinkirkup/5820d8db926f07b6eaa833394a21504c to your computer and use it in GitHub Desktop.
Save kevinkirkup/5820d8db926f07b6eaa833394a21504c to your computer and use it in GitHub Desktop.
OpenAPI Generator Error
{
"components": {
"responses": {},
"schemas": {
"Location": {
"description": "",
"example": {
"city": "Raleigh",
"country": "USA",
"id": "iFC8QdVzBmC7hC3NhZfwTG",
"name": "Location Name"
},
"properties": {
"name": {
"description": "The location name.\n",
"nullable": false,
"title": "Location",
"type": "string"
},
"city": {
"description": "The city of the location.\n",
"nullable": true,
"title": "Address - City",
"type": "string"
},
"country": {
"description": "The country of the location.\n",
"nullable": true,
"title": "Address - Country Code",
"type": "string"
},
"id": {
"description": "",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "ID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
}
},
"required": [
"id",
"name",
"city",
"country"
],
"title": "Location",
"type": "object",
"x-struct": "SomeProject.Schemas.Location.Location"
},
"AuditLogResponse": {
"description": "Response schema for single Audit Log Entry",
"example": {
"data": {
"id": "iFC8QdVzBmC7hC3NhZfwTG",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"metadata": {},
"primary_event": "TPDkWRU2aXdY6x2HQvAZZL",
"resource_id": "mnKg7j3xxWCvuvmjbDMQKa",
"resource_type": "port",
"user_id": "4UtWPkuLNoeJcQJNJGYbY5"
}
},
"properties": {
"data": {
"$ref": "#/components/schemas/AuditEntry"
}
},
"required": [
"data"
],
"title": "AuditLogResponse",
"type": "object",
"x-struct": "SomeProject.Schemas.AuditLog.AuditLogResponse"
},
"AuditLogIndex": {
"description": "Response schema for multiple Audit Log entries",
"example": {
"data": [
{
"id": "iFC8QdVzBmC7hC3NhZfwTG",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"metadata": {},
"primary_event": "TPDkWRU2aXdY6x2HQvAZZL",
"resource_id": "mnKg7j3xxWCvuvmjbDMQKa",
"resource_type": "port",
"user_id": "4UtWPkuLNoeJcQJNJGYbY5"
}
],
"page_number": 1,
"page_size": 10,
"total_entries": 1,
"total_pages": 1
},
"properties": {
"data": {
"description": "Audit Log Entries",
"items": {
"$ref": "#/components/schemas/AuditEntry"
},
"type": "array"
},
"page_number": {
"description": "Page Number",
"type": "integer"
},
"page_size": {
"description": "Page Size",
"type": "integer"
},
"total_entries": {
"description": "Total Entries",
"type": "integer"
},
"total_pages": {
"description": "Total Pages",
"type": "integer"
}
},
"required": [
"data"
],
"title": "AuditLogIndex",
"type": "object",
"x-struct": "SomeProject.Schemas.AuditLog.AuditLogIndex"
},
"LocationResponse": {
"description": "Response schema for single Location",
"example": {
"data": {
"city": "Raleigh",
"country": "USA",
"id": "iFC8QdVzBmC7hC3NhZfwTG",
"name": "Location Name"
}
},
"properties": {
"data": {
"$ref": "#/components/schemas/Location"
}
},
"required": [
"data"
],
"title": "LocationResponse",
"type": "object",
"x-struct": "SomeProject.Schemas.Location.LocationResponse"
},
"LocationIndex": {
"description": "Response schema for multiple Locations",
"example": {
"data": [
{
"city": "Raleigh",
"country": "USA",
"id": "iFC8QdVzBmC7hC3NhZfwTG",
"name": "Location Name"
}
],
"page_number": 1,
"page_size": 10,
"total_entries": 1,
"total_pages": 1
},
"properties": {
"data": {
"description": "Locations Details",
"items": {
"$ref": "#/components/schemas/Location"
},
"type": "array"
},
"page_number": {
"description": "Page Number",
"type": "integer"
},
"page_size": {
"description": "Page Size",
"type": "integer"
},
"total_entries": {
"description": "Total Entries",
"type": "integer"
},
"total_pages": {
"description": "Total Pages",
"type": "integer"
}
},
"required": [
"data"
],
"title": "LocationIndex",
"type": "object",
"x-struct": "SomeProject.Schemas.Location.LocationIndex"
},
"AuditEntry": {
"description": "",
"example": {
"id": "iFC8QdVzBmC7hC3NhZfwTG",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"primary_event": "TPDkWRU2aXdY6x2HQvAZZL",
"resource_id": "mnKg7j3xxWCvuvmjbDMQKa",
"resource_type": "port",
"user_id": "4UtWPkuLNoeJcQJNJGYbY5"
},
"properties": {
"id": {
"description": "",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"readOnly": true,
"title": "ID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
},
"inserted_at": {
"description": "The timestamp of this audit entry.\n",
"example": "1970-01-01T00:00:00.000000Z",
"format": "date-time",
"title": "Inserted At",
"type": "string"
},
"primary_event": {
"description": "",
"nullable": true,
"title": "Primary Event",
"type": "string"
},
"resource_id": {
"description": "",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "Resource ID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
},
"resource_type": {
"description": "",
"title": "Resource Type",
"type": "string"
},
"user_id": {
"description": "",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "User",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
}
},
"required": [
"id",
"user_id",
"inserted_at",
"resource_type",
"resource_id"
],
"title": "AuditEntry",
"type": "object",
"x-struct": "SomeProject.Schemas.AuditLog.AuditEntry"
}
},
"securitySchemes": {
"bearerAuth": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"description": "",
"termsOfService": "",
"title": "Atlantis",
"version": "0.0.1"
},
"openapi": "3.0.0",
"paths": {
"/api/orgs/1/connect/v1/audit-log": {
"get": {
"callbacks": {},
"operationId": "auditLog",
"parameters": [
{
"description": "Start time",
"in": "query",
"name": "start_time",
"required": true,
"schema": {
"example": "1970-01-01T00:00:00.000000Z",
"format": "date-time",
"type": "string"
}
},
{
"description": "End time",
"in": "query",
"name": "end_time",
"required": true,
"schema": {
"example": "1970-01-01T00:00:00.000000Z",
"format": "date-time",
"type": "string"
}
},
{
"description": "Sort Order",
"in": "query",
"name": "sort_order",
"required": false,
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"description": "Order By",
"in": "query",
"name": "order_by",
"required": false,
"schema": {
"enum": [
"event_name",
"event_type",
"resource_id",
"user_id",
"inserted_at"
],
"example": "inserted_at",
"type": "string"
}
},
{
"description": "Filter By",
"explode": true,
"in": "query",
"name": "filter_by",
"required": false,
"schema": {
"description": "Audit Log filter parameters",
"example": {
"resource_type": "port",
"user_id": "4UtWPkuLNoeJcQJNJGYbY5"
},
"properties": {
"inserted_at": {
"description": "The timestamp of this audit entry.\n",
"example": "1970-01-01T00:00:00.000000Z",
"format": "date-time",
"title": "Inserted At",
"type": "string"
},
"primary_event": {
"description": "The identifier of the audit entry that is the primary entry for a sequence of related entries.\n",
"nullable": true,
"title": "Primary Event",
"type": "string"
},
"resource_id": {
"description": "The identifier of the resource that is the subject of this audit entry.\n",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "Resource ID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
},
"resource_type": {
"description": "The type of resource that is the subject of this audit entry.\n",
"title": "Resource Type",
"type": "string"
},
"user_id": {
"description": "The identifier of the user that triggered this audit entry.\n",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "User",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
}
},
"title": "FilterItems",
"type": "object",
"x-struct": "SomeProject.Schemas.AuditLog.FilterItems"
},
"style": "deepObject"
},
{
"description": "Page Number",
"in": "query",
"name": "page",
"required": false,
"schema": {
"example": 1,
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
}
},
{
"description": "Page Size",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"example": 10,
"maximum": 9223372036854775807,
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogIndex"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Auth required"
},
"404": {
"description": "Parent Resource does not exist"
},
"422": {
"description": "Invalid Request"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "List entries in the audit log.",
"tags": [
"Audit"
]
}
},
"/api/orgs/1/connect/v1/audit-log/{id}": {
"get": {
"callbacks": {},
"description": "Show an Audit Log Entry by ID",
"operationId": "getAuditEntry",
"parameters": [
{
"description": "Organization ID",
"in": "path",
"name": "org_id",
"required": true,
"schema": {
"description": "String with short UUID format",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "ShortUUID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
}
},
{
"description": "Audit Log Entry ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "String with short UUID format",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "ShortUUID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogResponse"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Auth required"
},
"404": {
"description": "Audit Log Entry or Parent Resource does not exist"
},
"422": {
"description": "Invalid Request"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Retrieve a single Audit Log Entry",
"tags": [
"Audit"
]
}
},
"/api/public/locations": {
"get": {
"callbacks": {},
"description": "",
"operationId": "listLocations",
"parameters": [
{
"description": "Sort Order",
"in": "query",
"name": "sort_order",
"required": false,
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"description": "Order By",
"in": "query",
"name": "order_by",
"required": false,
"schema": {
"enum": [
"name",
"city",
"country"
],
"type": "string"
}
},
{
"description": "Filter By",
"explode": true,
"in": "query",
"name": "filter_by",
"required": false,
"schema": {
"description": "Schema for the Filter Items for locations\n",
"example": {
"city": "Raleigh",
"country": "USA",
"name": "Location Name"
},
"properties": {
"city": {
"description": "The city of the location.\n",
"title": "Address - City",
"type": "string"
},
"country": {
"description": "The country of the location.\n",
"title": "Address - Country Code",
"type": "string"
},
"name": {
"description": "The name of the resource.",
"maxLength": 512,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"title": "FilterItems",
"type": "object",
"x-struct": "SomeProject.Schemas.Location.FilterItems"
},
"style": "deepObject"
},
{
"description": "Page Number",
"in": "query",
"name": "page",
"required": false,
"schema": {
"example": 1,
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
}
},
{
"description": "Page Size",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"example": 10,
"maximum": 9223372036854775807,
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationIndex"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Auth required"
},
"422": {
"description": "Invalid Request"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "List all provider locations",
"tags": [
"Location"
]
}
},
"/api/public/locations/{id}": {
"get": {
"callbacks": {},
"description": "",
"operationId": "getLocation",
"parameters": [
{
"description": "Location ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "String with short UUID format",
"example": "iFC8QdVzBmC7hC3NhZfwTG",
"format": "short_uuid",
"title": "ShortUUID",
"type": "string",
"x-struct": "SomeProject.Schemas.ShortUUID",
"x-validate": "SomeProject.Schemas.ShortUUID"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationResponse"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Auth required"
},
"404": {
"description": "Location not found"
},
"422": {
"description": "Invalid Request"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get a location",
"tags": [
"Location"
]
}
}
},
"security": [
{
"bearerAuth": []
}
],
"servers": [],
"tags": [
{
"description": "Operations about Locations",
"name": "Location"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment