{ "components": { "schemas": { "account": { "description": "This is the top level in the system. It represents a specific client.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The Universally Unique Identifier. See RFC 4122." }, "awsAccount": { "type": "string", "description": "Test param for a pattern restricted string.", "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "description": "A unique human readable string name.", "example": "Universal Remonster Ltd", "minLength": 1, "maxLength": 255 }, "enabled": { "type": "boolean", "description": "Adds the ability to enable / disable this resource." } }, "required": [ "id", "awsAccount", "name", "enabled" ], "type": "object" }, "account_form": { "description": "A form used for creating an Account resource.", "properties": { "name": { "type": "string", "description": "A unique human readable string name.", "example": "Universal Remonster Ltd.", "minLength": 1, "maxLength": 255 }, "enabled": { "type": "boolean", "description": "Adds the ability to enable / disable this resource." } }, "required": [ "name", "enabled" ], "type": "object" }, "client": { "description": "A model client for testing generation.", "properties": { "accounts": { "items": { "$ref": "#/components/schemas/account" }, "type": "array", "description": "test field to make sure non empty lists are non empty in generated mock factories.", "maxItems": 3 } }, "required": [ "accounts" ], "type": "object" }, "healthcheck": { "description": "A response model for the standard health check resource.", "properties": { "status": { "type": "string", "description": "A general status string.", "example": "healthy", "minLength": 1, "maxLength": 1024 } }, "required": [ "status" ], "type": "object" }, "test_enumeration": { "description": "Test Enumeration provides a useful test for enumeration based code generation. Possible values: foo,bar.", "enum": [ "foo", "bar" ], "type": "string" } } }, "info": { "contact": {}, "license": {}, "termsOfService": "", "title": "bml-gen-test-application", "version": "0.0.2" }, "openapi": "3.0.2", "paths": { "/accounts": { "post": { "operationId": "post--accounts", "parameters": [ { "deprecated": false, "in": "header", "required": true, "schema": { "type": "string" }, "description": "Standard Auth header pass a JWT token.", "name": "Authorization" }, { "deprecated": false, "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "is this call a test", "name": "test" }, { "deprecated": false, "example": "false", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "is this call a test", "name": "testDefault" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_form" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "headers": {} }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": {} } }, "headers": {} }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} }, "409": { "description": "Conflict Already Exists.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} } }, "tags": [ "account" ] }, "get": { "description": "A mock to test returning a raw array. This is not a practical method to implement in a production environment. In production you would return a page object but here we want to test to ensure generators are handling raw array return value.", "operationId": "get--accounts", "parameters": [ { "deprecated": false, "in": "header", "required": true, "schema": { "type": "string" }, "description": "Standard Auth header pass a JWT token.", "name": "Authorization" }, { "deprecated": false, "in": "query", "required": false, "schema": { "type": "string" }, "description": "An optional test query parameter.", "name": "name" }, { "deprecated": false, "example": "0", "in": "query", "required": true, "schema": { "type": "integer" }, "description": "An optional test query parameter.", "name": "page" }, { "deprecated": false, "example": "100", "in": "query", "required": true, "schema": { "type": "integer" }, "description": "An optional test query parameter.", "name": "count" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/account" }, "type": "array" } } }, "headers": {} }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": {} } }, "headers": {} }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} } }, "tags": [ "account" ] } }, "/accounts/:id": { "get": { "operationId": "get--accounts-id", "parameters": [ { "deprecated": false, "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The Universally Unique Identifier for an existing account resource. See RFC 4122", "name": "id" }, { "deprecated": false, "in": "header", "required": true, "schema": { "type": "string" }, "description": "Standard Auth header pass a JWT token.", "name": "Authorization" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "headers": {} }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": {} } }, "headers": {} }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} } }, "tags": [ "account" ] }, "delete": { "description": "Delete an Account resource by id.", "operationId": "delete--accounts-id", "parameters": [ { "deprecated": false, "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The Universally Unique Identifier for an existing account resource. See RFC 4122", "name": "id" }, { "deprecated": false, "in": "header", "required": true, "schema": { "type": "string" }, "description": "Standard Auth header pass a JWT token.", "name": "Authorization" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "headers": {} }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": {} } }, "headers": {} }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} } }, "tags": [ "account" ] } }, "/accounts/:id/foo": { "get": { "description": "A mock to test returning a raw array. This is not a practical method to implement in a production environment. In production you would return a page object but here we want to test to ensure generators are handling raw array return value.", "operationId": "get--accounts-id-foo", "parameters": [ { "deprecated": false, "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The Universally Unique Identifier for an existing account resource. See RFC 4122", "name": "id" }, { "deprecated": false, "in": "header", "required": true, "schema": { "type": "string" }, "description": "Standard Auth header pass a JWT token.", "name": "Authorization" }, { "deprecated": false, "in": "query", "required": false, "schema": { "type": "string" }, "description": "An optional test query parameter.", "name": "name" }, { "deprecated": false, "example": "0", "in": "query", "required": true, "schema": { "type": "integer" }, "description": "An optional test query parameter.", "name": "page" }, { "deprecated": false, "example": "100", "in": "query", "required": true, "schema": { "type": "integer" }, "description": "An optional test query parameter.", "name": "count" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/account" }, "type": "array" } } }, "headers": {} }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": {} } }, "headers": {} }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "type": "integer", "nullable": true } } }, "headers": {} } }, "tags": [ "account" ] } } }, "servers": [ {} ] }