mirror of https://github.com/Budibase/budibase.git
Dean
4 years ago
104 changed files with 5274 additions and 7630 deletions
File diff suppressed because it is too large
@ -0,0 +1,54 @@ |
|||
<script> |
|||
export let width = "100" |
|||
export let height = "100" |
|||
</script> |
|||
|
|||
<svg |
|||
xmlns="http://www.w3.org/2000/svg" |
|||
xmlns:xlink="http://www.w3.org/1999/xlink" |
|||
viewBox="23 6 469 132" |
|||
{width} |
|||
{height} |
|||
> |
|||
<defs id="defs202"> |
|||
<linearGradient id="a" x1="-3.49%" x2="100.83%" y1="17.02%" y2="92.9%"> |
|||
<stop offset="0%" stop-color="#fff" stop-opacity=".1" id="stop192" /> |
|||
<stop offset="14%" stop-color="#fff" stop-opacity=".08" id="stop194" /> |
|||
<stop offset="61%" stop-color="#fff" stop-opacity=".02" id="stop196" /> |
|||
<stop offset="100%" stop-color="#fff" stop-opacity="0" id="stop198" /> |
|||
</linearGradient> |
|||
<path |
|||
id="b" |
|||
d="M106.687 35.2742c-.186-1.0977-.967-2-2.0244-2.338s-2.2148-.057-3.0002.73L86.2473 49.166l-12.12-23.1455c-.5133-.9786-1.525-1.5914-2.6273-1.5914s-2.114.6128-2.6273 1.5914l-6.6277 12.656L45.62 7.5726c-.603-1.1297-1.8588-1.746-3.118-1.5297s-2.2394 1.216-2.4335 2.4827L24 111.701l42.9727 24.1654c2.6985 1.5113 5.985 1.5113 8.6836 0L119 111.701l-12.313-76.427z" |
|||
/> |
|||
</defs> |
|||
<g id="g305" transform="matrix(2.9011579,0,0,2.9011579,43.533284,-135.93685)"> |
|||
<path |
|||
fill="#ffa000" |
|||
d="M 23.8266,111.7182 39.9588,8.4901 c 0.1972,-1.266 1.1818,-2.264 2.445,-2.4786 1.2632,-0.2146 2.522,0.4028 3.126,1.5327 L 62.2133,38.6615 68.8633,26 c 0.515,-0.979 1.5303,-1.592 2.6366,-1.592 1.1063,0 2.1215,0.613 2.6366,1.592 l 45.0227,85.718 H 23.8266 Z" |
|||
id="path204" |
|||
/> |
|||
<path |
|||
fill="#f57c00" |
|||
d="M 79.566,71.5074 62.2124,38.6472 23.8334,111.7187 Z" |
|||
id="path206" |
|||
/> |
|||
<path |
|||
fill="#ffca28" |
|||
d="m 119.1666,111.7187 -12.356,-76.4603 c -0.1867,-1.098 -0.9703,-2 -2.0315,-2.34 -1.0612,-0.34 -2.2226,-0.057 -3.0107,0.7302 l -77.935,78.069 43.1234,24.1834 c 2.708,1.512 6.006,1.512 8.714,0 l 43.4958,-24.1834 z" |
|||
id="path208" |
|||
/> |
|||
<path |
|||
fill="#ffffff" |
|||
fill-opacity="0.2" |
|||
d="m 106.8105,35.2584 c -0.1867,-1.098 -0.9703,-2 -2.0315,-2.34 -1.0612,-0.34 -2.2226,-0.057 -3.0107,0.7302 L 86.3,49.1562 74.1365,26 c -0.515,-0.979 -1.5303,-1.592 -2.6366,-1.592 -1.1063,0 -2.1215,0.613 -2.6366,1.592 L 62.2133,38.6615 45.529,7.5447 C 44.924,6.4145 43.6637,5.7981 42.399,6.0143 41.1343,6.2305 40.153,7.231 39.958,8.498 L 23.8333,111.7187 h -0.052 l 0.052,0.0596 0.4245,0.2085 77.488,-77.5775 c 0.7877,-0.7915 1.952,-1.076 3.016,-0.737 1.064,0.339 1.849,1.2445 2.0338,2.3457 l 12.2518,75.775 0.1192,-0.0745 -12.356,-76.4603 z M 23.9748,111.5772 39.9655,9.228 c 0.1948,-1.267 1.1784,-2.2675 2.442,-2.4837 1.2636,-0.2162 2.524,0.4 3.13,1.5304 L 62.22,39.392 68.87,26.7305 c 0.515,-0.979 1.5303,-1.592 2.6366,-1.592 1.1063,0 2.1215,0.613 2.6366,1.592 l 11.9167,22.664 -62.0858,62.1827 z" |
|||
id="path210" |
|||
/> |
|||
<path |
|||
fill="#a52714" |
|||
opacity="0.2" |
|||
d="m 75.6708,135.1722 c -2.708,1.512 -6.006,1.512 -8.714,0 l -43.0192,-24.1162 -0.1043,0.663 43.1234,24.176 c 2.708,1.512 6.006,1.512 8.714,0 l 43.4958,-24.176 -0.1117,-0.6852 -43.384,24.1387 z" |
|||
id="path212" |
|||
/> |
|||
</g> |
|||
</svg> |
|||
|
After Width: | Height: | Size: 3.1 KiB |
@ -0,0 +1,82 @@ |
|||
<script> |
|||
import { goto } from "@roxi/routify" |
|||
import { store } from "builderStore" |
|||
import ConfirmDialog from "components/common/ConfirmDialog.svelte" |
|||
import { |
|||
ActionMenu, |
|||
MenuItem, |
|||
Icon, |
|||
Layout, |
|||
notifications, |
|||
} from "@budibase/bbui" |
|||
import { get } from "svelte/store" |
|||
|
|||
export let path |
|||
export let screens |
|||
|
|||
let confirmDeleteDialog |
|||
|
|||
const deleteScreens = async () => { |
|||
if (!screens?.length) { |
|||
return |
|||
} |
|||
try { |
|||
for (let { id } of screens) { |
|||
// We have to fetch the screen to be deleted immediately before deleting |
|||
// as otherwise we're very likely to 409 |
|||
const screen = get(store).screens.find(screen => screen._id === id) |
|||
if (!screen) { |
|||
continue |
|||
} |
|||
await store.actions.screens.delete(screen) |
|||
} |
|||
notifications.success("Screens deleted successfully") |
|||
$goto("../") |
|||
} catch (error) { |
|||
notifications.error("Error deleting screens") |
|||
} |
|||
} |
|||
</script> |
|||
|
|||
<ActionMenu> |
|||
<div slot="control" class="icon"> |
|||
<Icon size="S" hoverable name="MoreSmallList" /> |
|||
</div> |
|||
<MenuItem icon="Delete" on:click={confirmDeleteDialog.show}> |
|||
Delete all screens |
|||
</MenuItem> |
|||
</ActionMenu> |
|||
|
|||
<ConfirmDialog |
|||
bind:this={confirmDeleteDialog} |
|||
title="Confirm Deletion" |
|||
okText="Delete screens" |
|||
onOk={deleteScreens} |
|||
> |
|||
<Layout noPadding gap="S"> |
|||
<div> |
|||
Are you sure you want to delete all screens under the <b>{path}</b> route? |
|||
</div> |
|||
<div>The following screens will be deleted:</div> |
|||
<div class="to-delete"> |
|||
{#each screens as screen} |
|||
<div>{screen.route}</div> |
|||
{/each} |
|||
</div> |
|||
</Layout> |
|||
</ConfirmDialog> |
|||
|
|||
<style> |
|||
.to-delete { |
|||
font-weight: bold; |
|||
display: flex; |
|||
flex-direction: column; |
|||
justify-content: flex-start; |
|||
align-items: flex-start; |
|||
padding-left: var(--spacing-xl); |
|||
} |
|||
.icon { |
|||
display: grid; |
|||
place-items: center; |
|||
} |
|||
</style> |
|||
@ -1,171 +0,0 @@ |
|||
<script> |
|||
import analytics from "analytics" |
|||
import { createEventDispatcher } from "svelte" |
|||
import { fade, fly } from "svelte/transition" |
|||
import { |
|||
ActionButton, |
|||
ClearButton, |
|||
RadioGroup, |
|||
TextArea, |
|||
ButtonGroup, |
|||
Button, |
|||
Heading, |
|||
Detail, |
|||
Divider, |
|||
Layout, |
|||
notifications, |
|||
} from "@budibase/bbui" |
|||
import { auth } from "stores/portal" |
|||
|
|||
let step = 0 |
|||
let ratings = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] |
|||
let options = [ |
|||
"Importing / managing data", |
|||
"Designing", |
|||
"Automations", |
|||
"Managing users / groups", |
|||
"Deployment / hosting", |
|||
"Documentation", |
|||
] |
|||
|
|||
const dispatch = createEventDispatcher() |
|||
|
|||
// Data to send off |
|||
let rating |
|||
let improvements = "" |
|||
let comment = "" |
|||
|
|||
function selectNumber(n) { |
|||
rating = n |
|||
step = 1 |
|||
} |
|||
|
|||
function submitFeedback() { |
|||
analytics.submitFeedback({ |
|||
rating, |
|||
improvements, |
|||
comment, |
|||
}) |
|||
try { |
|||
auth.updateSelf({ |
|||
flags: { |
|||
feedbackSubmitted: true, |
|||
}, |
|||
}) |
|||
} catch (error) { |
|||
notifications.error("Error updating user") |
|||
} |
|||
dispatch("complete") |
|||
} |
|||
|
|||
function cancelFeedback() { |
|||
try { |
|||
auth.updateSelf({ |
|||
flags: { |
|||
feedbackSubmitted: true, |
|||
}, |
|||
}) |
|||
} catch (error) { |
|||
notifications.error("Error updating user") |
|||
} |
|||
dispatch("complete") |
|||
} |
|||
</script> |
|||
|
|||
<div |
|||
class="position" |
|||
in:fade={{ duration: 200 }} |
|||
out:fade|local={{ duration: 200 }} |
|||
> |
|||
<div |
|||
class="feedback-frame" |
|||
in:fly={{ y: 30, duration: 200 }} |
|||
out:fly|local={{ y: 30, duration: 200 }} |
|||
> |
|||
<div class="close"> |
|||
<ClearButton on:click={cancelFeedback} /> |
|||
</div> |
|||
<Layout gap="XS"> |
|||
{#if step === 0} |
|||
<Heading size="XS" |
|||
>How likely are you to recommend Budibase to a colleague?</Heading |
|||
> |
|||
<Divider /> |
|||
<div class="ratings"> |
|||
{#each ratings as number} |
|||
<ActionButton |
|||
size="L" |
|||
emphasized |
|||
selected={number === rating} |
|||
on:click={() => selectNumber(number)} |
|||
> |
|||
{number} |
|||
</ActionButton> |
|||
{/each} |
|||
</div> |
|||
<div class="footer"> |
|||
<Detail size="S">NOT LIKELY</Detail> |
|||
<Detail size="S">EXTREMELY LIKELY</Detail> |
|||
</div> |
|||
{:else if step === 1} |
|||
<Heading size="XS">What could be improved most in Budibase?</Heading> |
|||
<Divider /> |
|||
<RadioGroup bind:value={improvements} {options} /> |
|||
<div class="footer"> |
|||
<Detail size="S">STEP 2 OF 3</Detail> |
|||
<ButtonGroup> |
|||
<Button secondary on:click={() => (step -= 1)}>Previous</Button> |
|||
<Button primary on:click={() => (step += 1)}>Next</Button> |
|||
</ButtonGroup> |
|||
</div> |
|||
{:else} |
|||
<Heading size="XS">How can we improve your experience?</Heading> |
|||
<Divider /> |
|||
<TextArea bind:value={comment} placeholder="Add comments" /> |
|||
<div class="footer"> |
|||
<Detail size="S">STEP 3 OF 3</Detail> |
|||
<ButtonGroup> |
|||
<Button secondary on:click={() => (step -= 1)}>Previous</Button> |
|||
<Button cta on:click={submitFeedback}>Complete</Button> |
|||
</ButtonGroup> |
|||
</div> |
|||
{/if} |
|||
</Layout> |
|||
</div> |
|||
</div> |
|||
|
|||
<style> |
|||
.feedback-frame :global(textarea) { |
|||
min-height: 180px !important; |
|||
} |
|||
|
|||
.position { |
|||
position: absolute; |
|||
right: var(--spacing-l); |
|||
bottom: calc(5 * var(--spacing-xl)); |
|||
} |
|||
.feedback-frame { |
|||
position: absolute; |
|||
bottom: 0; |
|||
right: 0; |
|||
min-width: 510px; |
|||
background: var(--background); |
|||
border-radius: var(--spectrum-global-dimension-size-50); |
|||
border: 2px solid var(--spectrum-global-color-blue-400); |
|||
padding: var(--spacing-xl); |
|||
} |
|||
.ratings { |
|||
display: flex; |
|||
justify-content: space-between; |
|||
} |
|||
.close { |
|||
position: absolute; |
|||
top: 0; |
|||
right: 0; |
|||
} |
|||
.footer { |
|||
display: flex; |
|||
justify-content: space-between; |
|||
align-items: center; |
|||
} |
|||
</style> |
|||
File diff suppressed because it is too large
File diff suppressed because it is too large
File diff suppressed because it is too large
@ -0,0 +1,205 @@ |
|||
import { ImportInfo } from "./base" |
|||
import { Query, QueryParameter } from "../../../../../definitions/datasource" |
|||
import { OpenAPIV3 } from "openapi-types" |
|||
import { OpenAPISource } from "./base/openapi" |
|||
import { URL } from "url" |
|||
|
|||
const parameterNotRef = ( |
|||
param: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject |
|||
): param is OpenAPIV3.ParameterObject => { |
|||
// all refs are deferenced by parser library
|
|||
return true |
|||
} |
|||
|
|||
const requestBodyNotRef = ( |
|||
param: OpenAPIV3.RequestBodyObject | OpenAPIV3.ReferenceObject | undefined |
|||
): param is OpenAPIV3.RequestBodyObject => { |
|||
// all refs are deferenced by parser library
|
|||
return param !== undefined |
|||
} |
|||
|
|||
const schemaNotRef = ( |
|||
param: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | undefined |
|||
): param is OpenAPIV3.SchemaObject => { |
|||
// all refs are deferenced by parser library
|
|||
return param !== undefined |
|||
} |
|||
|
|||
const isOpenAPI3 = (document: any): document is OpenAPIV3.Document => { |
|||
return document.openapi.includes("3.0") |
|||
} |
|||
|
|||
const methods: string[] = Object.values(OpenAPIV3.HttpMethods) |
|||
|
|||
const isOperation = ( |
|||
key: string, |
|||
pathItem: any |
|||
): pathItem is OpenAPIV3.OperationObject => { |
|||
return methods.includes(key) |
|||
} |
|||
|
|||
const isParameter = ( |
|||
key: string, |
|||
pathItem: any |
|||
): pathItem is OpenAPIV3.ParameterObject => { |
|||
return !isOperation(key, pathItem) |
|||
} |
|||
|
|||
const getRequestBody = (operation: OpenAPIV3.OperationObject) => { |
|||
if (requestBodyNotRef(operation.requestBody)) { |
|||
const request: OpenAPIV3.RequestBodyObject = operation.requestBody |
|||
const supportedMimeTypes = getMimeTypes(operation) |
|||
if (supportedMimeTypes.length > 0) { |
|||
const mimeType = supportedMimeTypes[0] |
|||
|
|||
// try get example from request
|
|||
const content = request.content[mimeType] |
|||
if (content.example) { |
|||
return content.example |
|||
} |
|||
|
|||
// try get example from schema
|
|||
if (schemaNotRef(content.schema)) { |
|||
const schema = content.schema |
|||
if (schema.example) { |
|||
return schema.example |
|||
} |
|||
} |
|||
} |
|||
} |
|||
return undefined |
|||
} |
|||
|
|||
const getMimeTypes = (operation: OpenAPIV3.OperationObject): string[] => { |
|||
if (requestBodyNotRef(operation.requestBody)) { |
|||
const request: OpenAPIV3.RequestBodyObject = operation.requestBody |
|||
return Object.keys(request.content) |
|||
} |
|||
return [] |
|||
} |
|||
|
|||
/** |
|||
* OpenAPI Version 3.0 |
|||
* https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md
|
|||
*/ |
|||
export class OpenAPI3 extends OpenAPISource { |
|||
document!: OpenAPIV3.Document |
|||
|
|||
isSupported = async (data: string): Promise<boolean> => { |
|||
try { |
|||
const document: any = await this.parseData(data) |
|||
if (isOpenAPI3(document)) { |
|||
this.document = document |
|||
return true |
|||
} else { |
|||
return false |
|||
} |
|||
} catch (err) { |
|||
return false |
|||
} |
|||
} |
|||
|
|||
getInfo = async (): Promise<ImportInfo> => { |
|||
const name = this.document.info.title || "OpenAPI Import" |
|||
return { |
|||
name, |
|||
} |
|||
} |
|||
|
|||
getQueries = async (datasourceId: string): Promise<Query[]> => { |
|||
let url: string | URL | undefined |
|||
if (this.document.servers?.length) { |
|||
url = this.document.servers[0].url |
|||
try { |
|||
url = new URL(url) |
|||
} catch (err) { |
|||
// unable to construct url, e.g. with variables
|
|||
// proceed with string form of url
|
|||
} |
|||
} |
|||
|
|||
const queries: Query[] = [] |
|||
|
|||
for (let [path, pathItemObject] of Object.entries(this.document.paths)) { |
|||
// parameters that apply to every operation in the path
|
|||
let pathParams: OpenAPIV3.ParameterObject[] = [] |
|||
|
|||
// pathItemObject can be undefined
|
|||
if (!pathItemObject) { |
|||
continue |
|||
} |
|||
|
|||
for (let [key, opOrParams] of Object.entries(pathItemObject)) { |
|||
if (isParameter(key, opOrParams)) { |
|||
const pathParameters = opOrParams as OpenAPIV3.ParameterObject[] |
|||
pathParams.push(...pathParameters) |
|||
continue |
|||
} |
|||
// can not be a parameter, must be an operation
|
|||
const operation = opOrParams as OpenAPIV3.OperationObject |
|||
|
|||
const methodName = key |
|||
const name = operation.operationId || path |
|||
let queryString = "" |
|||
const headers: any = {} |
|||
let requestBody = getRequestBody(operation) |
|||
const parameters: QueryParameter[] = [] |
|||
const mimeTypes = getMimeTypes(operation) |
|||
|
|||
if (mimeTypes.length > 0) { |
|||
headers["Content-Type"] = mimeTypes[0] |
|||
} |
|||
|
|||
// combine the path parameters with the operation parameters
|
|||
const operationParams = operation.parameters || [] |
|||
const allParams = [...pathParams, ...operationParams] |
|||
|
|||
for (let param of allParams) { |
|||
if (parameterNotRef(param)) { |
|||
switch (param.in) { |
|||
case "query": |
|||
let prefix = "" |
|||
if (queryString) { |
|||
prefix = "&" |
|||
} |
|||
queryString = `${queryString}${prefix}${param.name}={{${param.name}}}` |
|||
break |
|||
case "header": |
|||
headers[param.name] = `{{${param.name}}}` |
|||
break |
|||
case "path": |
|||
// do nothing: param is already in the path
|
|||
break |
|||
case "formData": |
|||
// future enhancement
|
|||
break |
|||
} |
|||
|
|||
// add the parameter if it can be bound in our config
|
|||
if (["query", "header", "path"].includes(param.in)) { |
|||
parameters.push({ |
|||
name: param.name, |
|||
default: "", |
|||
}) |
|||
} |
|||
} |
|||
} |
|||
|
|||
const query = this.constructQuery( |
|||
datasourceId, |
|||
name, |
|||
methodName, |
|||
path, |
|||
url, |
|||
queryString, |
|||
headers, |
|||
parameters, |
|||
requestBody |
|||
) |
|||
queries.push(query) |
|||
} |
|||
} |
|||
|
|||
return queries |
|||
} |
|||
} |
|||
@ -0,0 +1,253 @@ |
|||
{ |
|||
"openapi": "3.0.2", |
|||
"info": { |
|||
"description": "A basic swagger file", |
|||
"version": "1.0.0", |
|||
"title": "CRUD" |
|||
}, |
|||
"servers": [ |
|||
{ |
|||
"url": "http://example.com" |
|||
} |
|||
], |
|||
"tags": [ |
|||
{ |
|||
"name": "entity" |
|||
} |
|||
], |
|||
"paths": { |
|||
"/entities": { |
|||
"post": { |
|||
"tags": [ |
|||
"entity" |
|||
], |
|||
"operationId": "createEntity", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/CreateEntity" |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "successful operation", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"get": { |
|||
"tags": [ |
|||
"entity" |
|||
], |
|||
"operationId": "getEntities", |
|||
"parameters": [ |
|||
{ |
|||
"$ref": "#/components/parameters/PageParameter" |
|||
}, |
|||
{ |
|||
"$ref": "#/components/parameters/SizeParameter" |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "successful operation", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entities" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"/entities/{entityId}": { |
|||
"parameters": [ |
|||
{ |
|||
"$ref": "#/components/parameters/EntityIdParameter" |
|||
} |
|||
], |
|||
"get": { |
|||
"tags": [ |
|||
"entity" |
|||
], |
|||
"operationId": "getEntity", |
|||
"responses": { |
|||
"200": { |
|||
"description": "successful operation", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"put": { |
|||
"tags": [ |
|||
"entity" |
|||
], |
|||
"operationId": "updateEntity", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "successful operation", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"patch": { |
|||
"tags": [ |
|||
"entity" |
|||
], |
|||
"operationId": "patchEntity", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "successful operation", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"delete": { |
|||
"tags": [ |
|||
"entity" |
|||
], |
|||
"parameters": [ |
|||
{ |
|||
"$ref": "#/components/parameters/APIKeyParameter" |
|||
} |
|||
], |
|||
"operationId": "deleteEntity", |
|||
"responses": { |
|||
"204": { |
|||
"description": "successful operation" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
}, |
|||
"components": { |
|||
"parameters": { |
|||
"EntityIdParameter": { |
|||
"schema": { |
|||
"type": "integer", |
|||
"format": "int64" |
|||
}, |
|||
"name": "entityId", |
|||
"in": "path", |
|||
"required": true |
|||
}, |
|||
"PageParameter": { |
|||
"schema": { |
|||
"type": "integer", |
|||
"format": "int32" |
|||
}, |
|||
"name": "page", |
|||
"in": "query", |
|||
"required": false |
|||
}, |
|||
"SizeParameter": { |
|||
"schema": { |
|||
"type": "integer", |
|||
"format": "int32" |
|||
}, |
|||
"name": "size", |
|||
"in": "query", |
|||
"required": false |
|||
}, |
|||
"APIKeyParameter": { |
|||
"schema": { |
|||
"type": "string" |
|||
}, |
|||
"name": "x-api-key", |
|||
"in": "header", |
|||
"required": false |
|||
} |
|||
}, |
|||
"schemas": { |
|||
"CreateEntity": { |
|||
"type": "object", |
|||
"properties": { |
|||
"name": { |
|||
"type": "string" |
|||
}, |
|||
"type": { |
|||
"type": "string" |
|||
} |
|||
}, |
|||
"example": { |
|||
"name": "name", |
|||
"type": "type" |
|||
} |
|||
}, |
|||
"Entity": { |
|||
"allOf": [ |
|||
{ |
|||
"type": "object", |
|||
"properties": { |
|||
"id": { |
|||
"type": "integer", |
|||
"format": "int64" |
|||
} |
|||
} |
|||
}, |
|||
{ |
|||
"$ref": "#/components/schemas/CreateEntity" |
|||
} |
|||
], |
|||
"example": { |
|||
"id": 1, |
|||
"name": "name", |
|||
"type": "type" |
|||
} |
|||
}, |
|||
"Entities" : { |
|||
"type": "array", |
|||
"items": { |
|||
"$ref": "#/components/schemas/Entity" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,153 @@ |
|||
--- |
|||
openapi: 3.0.2 |
|||
info: |
|||
description: A basic swagger file |
|||
version: 1.0.0 |
|||
title: CRUD |
|||
servers: |
|||
- url: http://example.com |
|||
tags: |
|||
- name: entity |
|||
paths: |
|||
"/entities": |
|||
post: |
|||
tags: |
|||
- entity |
|||
operationId: createEntity |
|||
requestBody: |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/CreateEntity" |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entity" |
|||
get: |
|||
tags: |
|||
- entity |
|||
operationId: getEntities |
|||
parameters: |
|||
- "$ref": "#/components/parameters/PageParameter" |
|||
- "$ref": "#/components/parameters/SizeParameter" |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entities" |
|||
"/entities/{entityId}": |
|||
parameters: |
|||
- "$ref": "#/components/parameters/EntityIdParameter" |
|||
get: |
|||
tags: |
|||
- entity |
|||
operationId: getEntity |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entity" |
|||
put: |
|||
tags: |
|||
- entity |
|||
operationId: updateEntity |
|||
requestBody: |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entity" |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entity" |
|||
patch: |
|||
tags: |
|||
- entity |
|||
operationId: patchEntity |
|||
requestBody: |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entity" |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Entity" |
|||
delete: |
|||
tags: |
|||
- entity |
|||
parameters: |
|||
- "$ref": "#/components/parameters/APIKeyParameter" |
|||
operationId: deleteEntity |
|||
responses: |
|||
'204': |
|||
description: successful operation |
|||
components: |
|||
parameters: |
|||
EntityIdParameter: |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
name: entityId |
|||
in: path |
|||
required: true |
|||
PageParameter: |
|||
schema: |
|||
type: integer |
|||
format: int32 |
|||
name: page |
|||
in: query |
|||
required: false |
|||
SizeParameter: |
|||
schema: |
|||
type: integer |
|||
format: int32 |
|||
name: size |
|||
in: query |
|||
required: false |
|||
APIKeyParameter: |
|||
schema: |
|||
type: string |
|||
name: x-api-key |
|||
in: header |
|||
required: false |
|||
schemas: |
|||
CreateEntity: |
|||
type: object |
|||
properties: |
|||
name: |
|||
type: string |
|||
type: |
|||
type: string |
|||
example: |
|||
name: name |
|||
type: type |
|||
Entity: |
|||
allOf: |
|||
- type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
- "$ref": "#/components/schemas/CreateEntity" |
|||
example: |
|||
id: 1 |
|||
name: name |
|||
type: type |
|||
Entities: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/Entity" |
|||
File diff suppressed because it is too large
@ -0,0 +1,804 @@ |
|||
--- |
|||
openapi: 3.0.2 |
|||
info: |
|||
title: Swagger Petstore - OpenAPI 3.0 |
|||
description: |- |
|||
This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about |
|||
Swagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach! |
|||
You can now help us improve the API whether it's by making changes to the definition itself or to the code. |
|||
That way, with time, we can improve the API in general, and expose some of the new features in OAS3. |
|||
|
|||
Some useful links: |
|||
- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore) |
|||
- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) |
|||
termsOfService: http://swagger.io/terms/ |
|||
contact: |
|||
email: apiteam@swagger.io |
|||
license: |
|||
name: Apache 2.0 |
|||
url: http://www.apache.org/licenses/LICENSE-2.0.html |
|||
version: 1.0.11 |
|||
externalDocs: |
|||
description: Find out more about Swagger |
|||
url: http://swagger.io |
|||
servers: |
|||
- url: "/api/v3" |
|||
tags: |
|||
- name: pet |
|||
description: Everything about your Pets |
|||
externalDocs: |
|||
description: Find out more |
|||
url: http://swagger.io |
|||
- name: store |
|||
description: Access to Petstore orders |
|||
externalDocs: |
|||
description: Find out more about our store |
|||
url: http://swagger.io |
|||
- name: user |
|||
description: Operations about user |
|||
paths: |
|||
"/pet": |
|||
put: |
|||
tags: |
|||
- pet |
|||
summary: Update an existing pet |
|||
description: Update an existing pet by Id |
|||
operationId: updatePet |
|||
requestBody: |
|||
description: Update an existent pet in the store |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/x-www-form-urlencoded: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
required: true |
|||
responses: |
|||
'200': |
|||
description: Successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
'400': |
|||
description: Invalid ID supplied |
|||
'404': |
|||
description: Pet not found |
|||
'405': |
|||
description: Validation exception |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
post: |
|||
tags: |
|||
- pet |
|||
summary: Add a new pet to the store |
|||
description: Add a new pet to the store |
|||
operationId: addPet |
|||
requestBody: |
|||
description: Create a new pet in the store |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/x-www-form-urlencoded: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
required: true |
|||
responses: |
|||
'200': |
|||
description: Successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
'405': |
|||
description: Invalid input |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
"/pet/findByStatus": |
|||
get: |
|||
tags: |
|||
- pet |
|||
summary: Finds Pets by status |
|||
description: Multiple status values can be provided with comma separated strings |
|||
operationId: findPetsByStatus |
|||
parameters: |
|||
- name: status |
|||
in: query |
|||
description: Status values that need to be considered for filter |
|||
required: false |
|||
explode: true |
|||
schema: |
|||
type: string |
|||
default: available |
|||
enum: |
|||
- available |
|||
- pending |
|||
- sold |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/json: |
|||
schema: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/Pet" |
|||
'400': |
|||
description: Invalid status value |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
"/pet/findByTags": |
|||
get: |
|||
tags: |
|||
- pet |
|||
summary: Finds Pets by tags |
|||
description: Multiple tags can be provided with comma separated strings. Use |
|||
tag1, tag2, tag3 for testing. |
|||
operationId: findPetsByTags |
|||
parameters: |
|||
- name: tags |
|||
in: query |
|||
description: Tags to filter by |
|||
required: false |
|||
explode: true |
|||
schema: |
|||
type: array |
|||
items: |
|||
type: string |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/json: |
|||
schema: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/Pet" |
|||
'400': |
|||
description: Invalid tag value |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
"/pet/{petId}": |
|||
get: |
|||
tags: |
|||
- pet |
|||
summary: Find pet by ID |
|||
description: Returns a single pet |
|||
operationId: getPetById |
|||
parameters: |
|||
- name: petId |
|||
in: path |
|||
description: ID of pet to return |
|||
required: true |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
'400': |
|||
description: Invalid ID supplied |
|||
'404': |
|||
description: Pet not found |
|||
security: |
|||
- api_key: [] |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
post: |
|||
tags: |
|||
- pet |
|||
summary: Updates a pet in the store with form data |
|||
description: '' |
|||
operationId: updatePetWithForm |
|||
parameters: |
|||
- name: petId |
|||
in: path |
|||
description: ID of pet that needs to be updated |
|||
required: true |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
- name: name |
|||
in: query |
|||
description: Name of pet that needs to be updated |
|||
schema: |
|||
type: string |
|||
- name: status |
|||
in: query |
|||
description: Status of pet that needs to be updated |
|||
schema: |
|||
type: string |
|||
responses: |
|||
'405': |
|||
description: Invalid input |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
delete: |
|||
tags: |
|||
- pet |
|||
summary: Deletes a pet |
|||
description: '' |
|||
operationId: deletePet |
|||
parameters: |
|||
- name: api_key |
|||
in: header |
|||
description: '' |
|||
required: false |
|||
schema: |
|||
type: string |
|||
- name: petId |
|||
in: path |
|||
description: Pet id to delete |
|||
required: true |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
responses: |
|||
'400': |
|||
description: Invalid pet value |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
"/pet/{petId}/uploadImage": |
|||
post: |
|||
tags: |
|||
- pet |
|||
summary: uploads an image |
|||
description: '' |
|||
operationId: uploadFile |
|||
parameters: |
|||
- name: petId |
|||
in: path |
|||
description: ID of pet to update |
|||
required: true |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
- name: additionalMetadata |
|||
in: query |
|||
description: Additional Metadata |
|||
required: false |
|||
schema: |
|||
type: string |
|||
requestBody: |
|||
content: |
|||
application/octet-stream: |
|||
schema: |
|||
type: string |
|||
format: binary |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/ApiResponse" |
|||
security: |
|||
- petstore_auth: |
|||
- write:pets |
|||
- read:pets |
|||
"/store/inventory": |
|||
get: |
|||
tags: |
|||
- store |
|||
summary: Returns pet inventories by status |
|||
description: Returns a map of status codes to quantities |
|||
operationId: getInventory |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
type: object |
|||
additionalProperties: |
|||
type: integer |
|||
format: int32 |
|||
security: |
|||
- api_key: [] |
|||
"/store/order": |
|||
post: |
|||
tags: |
|||
- store |
|||
summary: Place an order for a pet |
|||
description: Place a new order in the store |
|||
operationId: placeOrder |
|||
requestBody: |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Order" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Order" |
|||
application/x-www-form-urlencoded: |
|||
schema: |
|||
"$ref": "#/components/schemas/Order" |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Order" |
|||
'405': |
|||
description: Invalid input |
|||
"/store/order/{orderId}": |
|||
get: |
|||
tags: |
|||
- store |
|||
summary: Find purchase order by ID |
|||
description: For valid response try integer IDs with value <= 5 or > 10. Other |
|||
values will generate exceptions. |
|||
operationId: getOrderById |
|||
parameters: |
|||
- name: orderId |
|||
in: path |
|||
description: ID of order that needs to be fetched |
|||
required: true |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Order" |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Order" |
|||
'400': |
|||
description: Invalid ID supplied |
|||
'404': |
|||
description: Order not found |
|||
delete: |
|||
tags: |
|||
- store |
|||
summary: Delete purchase order by ID |
|||
description: For valid response try integer IDs with value < 1000. Anything |
|||
above 1000 or nonintegers will generate API errors |
|||
operationId: deleteOrder |
|||
parameters: |
|||
- name: orderId |
|||
in: path |
|||
description: ID of the order that needs to be deleted |
|||
required: true |
|||
schema: |
|||
type: integer |
|||
format: int64 |
|||
responses: |
|||
'400': |
|||
description: Invalid ID supplied |
|||
'404': |
|||
description: Order not found |
|||
"/user": |
|||
post: |
|||
tags: |
|||
- user |
|||
summary: Create user |
|||
description: This can only be done by the logged in user. |
|||
operationId: createUser |
|||
requestBody: |
|||
description: Created user object |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/x-www-form-urlencoded: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
responses: |
|||
default: |
|||
description: successful operation |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
"/user/createWithList": |
|||
post: |
|||
tags: |
|||
- user |
|||
summary: Creates list of users with given input array |
|||
description: Creates list of users with given input array |
|||
operationId: createUsersWithListInput |
|||
requestBody: |
|||
content: |
|||
application/json: |
|||
schema: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/User" |
|||
responses: |
|||
'200': |
|||
description: Successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
default: |
|||
description: successful operation |
|||
"/user/login": |
|||
get: |
|||
tags: |
|||
- user |
|||
summary: Logs user into the system |
|||
description: '' |
|||
operationId: loginUser |
|||
parameters: |
|||
- name: username |
|||
in: query |
|||
description: The user name for login |
|||
required: false |
|||
schema: |
|||
type: string |
|||
- name: password |
|||
in: query |
|||
description: The password for login in clear text |
|||
required: false |
|||
schema: |
|||
type: string |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
headers: |
|||
X-Rate-Limit: |
|||
description: calls per hour allowed by the user |
|||
schema: |
|||
type: integer |
|||
format: int32 |
|||
X-Expires-After: |
|||
description: date in UTC when token expires |
|||
schema: |
|||
type: string |
|||
format: date-time |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
type: string |
|||
application/json: |
|||
schema: |
|||
type: string |
|||
'400': |
|||
description: Invalid username/password supplied |
|||
"/user/logout": |
|||
get: |
|||
tags: |
|||
- user |
|||
summary: Logs out current logged in user session |
|||
description: '' |
|||
operationId: logoutUser |
|||
parameters: [] |
|||
responses: |
|||
default: |
|||
description: successful operation |
|||
"/user/{username}": |
|||
get: |
|||
tags: |
|||
- user |
|||
summary: Get user by user name |
|||
description: '' |
|||
operationId: getUserByName |
|||
parameters: |
|||
- name: username |
|||
in: path |
|||
description: 'The name that needs to be fetched. Use user1 for testing. ' |
|||
required: true |
|||
schema: |
|||
type: string |
|||
responses: |
|||
'200': |
|||
description: successful operation |
|||
content: |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
'400': |
|||
description: Invalid username supplied |
|||
'404': |
|||
description: User not found |
|||
put: |
|||
tags: |
|||
- user |
|||
summary: Update user |
|||
description: This can only be done by the logged in user. |
|||
operationId: updateUser |
|||
parameters: |
|||
- name: username |
|||
in: path |
|||
description: name that need to be deleted |
|||
required: true |
|||
schema: |
|||
type: string |
|||
requestBody: |
|||
description: Update an existent user in the store |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
application/x-www-form-urlencoded: |
|||
schema: |
|||
"$ref": "#/components/schemas/User" |
|||
responses: |
|||
default: |
|||
description: successful operation |
|||
delete: |
|||
tags: |
|||
- user |
|||
summary: Delete user |
|||
description: This can only be done by the logged in user. |
|||
operationId: deleteUser |
|||
parameters: |
|||
- name: username |
|||
in: path |
|||
description: The name that needs to be deleted |
|||
required: true |
|||
schema: |
|||
type: string |
|||
responses: |
|||
'400': |
|||
description: Invalid username supplied |
|||
'404': |
|||
description: User not found |
|||
components: |
|||
schemas: |
|||
Order: |
|||
type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
example: 10 |
|||
petId: |
|||
type: integer |
|||
format: int64 |
|||
example: 198772 |
|||
quantity: |
|||
type: integer |
|||
format: int32 |
|||
example: 7 |
|||
shipDate: |
|||
type: string |
|||
format: date-time |
|||
status: |
|||
type: string |
|||
description: Order Status |
|||
example: approved |
|||
enum: |
|||
- placed |
|||
- approved |
|||
- delivered |
|||
complete: |
|||
type: boolean |
|||
xml: |
|||
name: order |
|||
Customer: |
|||
type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
example: 100000 |
|||
username: |
|||
type: string |
|||
example: fehguy |
|||
address: |
|||
type: array |
|||
xml: |
|||
name: addresses |
|||
wrapped: true |
|||
items: |
|||
"$ref": "#/components/schemas/Address" |
|||
xml: |
|||
name: customer |
|||
Address: |
|||
type: object |
|||
properties: |
|||
street: |
|||
type: string |
|||
example: 437 Lytton |
|||
city: |
|||
type: string |
|||
example: Palo Alto |
|||
state: |
|||
type: string |
|||
example: CA |
|||
zip: |
|||
type: string |
|||
example: '94301' |
|||
xml: |
|||
name: address |
|||
Category: |
|||
type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
example: 1 |
|||
name: |
|||
type: string |
|||
example: Dogs |
|||
xml: |
|||
name: category |
|||
User: |
|||
type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
example: 10 |
|||
username: |
|||
type: string |
|||
example: theUser |
|||
firstName: |
|||
type: string |
|||
example: John |
|||
lastName: |
|||
type: string |
|||
example: James |
|||
email: |
|||
type: string |
|||
example: john@email.com |
|||
password: |
|||
type: string |
|||
example: '12345' |
|||
phone: |
|||
type: string |
|||
example: '12345' |
|||
userStatus: |
|||
type: integer |
|||
description: User Status |
|||
format: int32 |
|||
example: 1 |
|||
xml: |
|||
name: user |
|||
Tag: |
|||
type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
name: |
|||
type: string |
|||
xml: |
|||
name: tag |
|||
Pet: |
|||
required: |
|||
- name |
|||
- photoUrls |
|||
type: object |
|||
properties: |
|||
id: |
|||
type: integer |
|||
format: int64 |
|||
example: 10 |
|||
name: |
|||
type: string |
|||
example: doggie |
|||
category: |
|||
"$ref": "#/components/schemas/Category" |
|||
photoUrls: |
|||
type: array |
|||
xml: |
|||
wrapped: true |
|||
items: |
|||
type: string |
|||
xml: |
|||
name: photoUrl |
|||
tags: |
|||
type: array |
|||
xml: |
|||
wrapped: true |
|||
items: |
|||
"$ref": "#/components/schemas/Tag" |
|||
status: |
|||
type: string |
|||
description: pet status in the store |
|||
enum: |
|||
- available |
|||
- pending |
|||
- sold |
|||
xml: |
|||
name: pet |
|||
ApiResponse: |
|||
type: object |
|||
properties: |
|||
code: |
|||
type: integer |
|||
format: int32 |
|||
type: |
|||
type: string |
|||
message: |
|||
type: string |
|||
xml: |
|||
name: "##default" |
|||
requestBodies: |
|||
Pet: |
|||
description: Pet object that needs to be added to the store |
|||
content: |
|||
application/json: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
application/xml: |
|||
schema: |
|||
"$ref": "#/components/schemas/Pet" |
|||
UserArray: |
|||
description: List of user object |
|||
content: |
|||
application/json: |
|||
schema: |
|||
type: array |
|||
items: |
|||
"$ref": "#/components/schemas/User" |
|||
securitySchemes: |
|||
petstore_auth: |
|||
type: oauth2 |
|||
flows: |
|||
implicit: |
|||
authorizationUrl: https://petstore3.swagger.io/oauth/authorize |
|||
scopes: |
|||
write:pets: modify pets in your account |
|||
read:pets: read your pets |
|||
api_key: |
|||
type: apiKey |
|||
name: api_key |
|||
in: header |
|||
@ -0,0 +1,240 @@ |
|||
const fs = require("fs") |
|||
const path = require("path") |
|||
|
|||
const { OpenAPI3 } = require("../../openapi3") |
|||
|
|||
const getData = (file, extension) => { |
|||
return fs.readFileSync( |
|||
path.join(__dirname, `./data/${file}/${file}.${extension}`), |
|||
"utf8" |
|||
) |
|||
} |
|||
|
|||
describe("OpenAPI3 Import", () => { |
|||
let openapi3 |
|||
|
|||
beforeEach(() => { |
|||
openapi3 = new OpenAPI3() |
|||
}) |
|||
|
|||
it("validates unsupported data", async () => { |
|||
let data |
|||
let supported |
|||
|
|||
// non json / yaml
|
|||
data = "curl http://example.com" |
|||
supported = await openapi3.isSupported(data) |
|||
expect(supported).toBe(false) |
|||
|
|||
// Empty
|
|||
data = "" |
|||
supported = await openapi3.isSupported(data) |
|||
expect(supported).toBe(false) |
|||
}) |
|||
|
|||
const runTests = async (filename, test, assertions) => { |
|||
for (let extension of ["json", "yaml"]) { |
|||
await test(filename, extension, assertions) |
|||
} |
|||
} |
|||
|
|||
const testImportInfo = async (file, extension) => { |
|||
await openapi3.isSupported(getData(file, extension)) |
|||
const info = await openapi3.getInfo() |
|||
expect(info.name).toBe("Swagger Petstore - OpenAPI 3.0") |
|||
} |
|||
|
|||
it("returns import info", async () => { |
|||
await runTests("petstore", testImportInfo) |
|||
}) |
|||
|
|||
describe("Returns queries", () => { |
|||
const indexQueries = queries => { |
|||
return queries.reduce((acc, query) => { |
|||
acc[query.name] = query |
|||
return acc |
|||
}, {}) |
|||
} |
|||
|
|||
const getQueries = async (file, extension) => { |
|||
await openapi3.isSupported(getData(file, extension)) |
|||
const queries = await openapi3.getQueries() |
|||
expect(queries.length).toBe(6) |
|||
return indexQueries(queries) |
|||
} |
|||
|
|||
const testVerb = async (file, extension, assertions) => { |
|||
const queries = await getQueries(file, extension) |
|||
for (let [operationId, method] of Object.entries(assertions)) { |
|||
expect(queries[operationId].queryVerb).toBe(method) |
|||
} |
|||
} |
|||
|
|||
it("populates verb", async () => { |
|||
const assertions = { |
|||
createEntity: "create", |
|||
getEntities: "read", |
|||
getEntity: "read", |
|||
updateEntity: "update", |
|||
patchEntity: "patch", |
|||
deleteEntity: "delete", |
|||
} |
|||
await runTests("crud", testVerb, assertions) |
|||
}) |
|||
|
|||
const testPath = async (file, extension, assertions) => { |
|||
const queries = await getQueries(file, extension) |
|||
for (let [operationId, urlPath] of Object.entries(assertions)) { |
|||
expect(queries[operationId].fields.path).toBe(urlPath) |
|||
} |
|||
} |
|||
|
|||
it("populates path", async () => { |
|||
const assertions = { |
|||
createEntity: "http://example.com/entities", |
|||
getEntities: "http://example.com/entities", |
|||
getEntity: "http://example.com/entities/{{entityId}}", |
|||
updateEntity: "http://example.com/entities/{{entityId}}", |
|||
patchEntity: "http://example.com/entities/{{entityId}}", |
|||
deleteEntity: "http://example.com/entities/{{entityId}}", |
|||
} |
|||
await runTests("crud", testPath, assertions) |
|||
}) |
|||
|
|||
const testHeaders = async (file, extension, assertions) => { |
|||
const queries = await getQueries(file, extension) |
|||
for (let [operationId, headers] of Object.entries(assertions)) { |
|||
expect(queries[operationId].fields.headers).toStrictEqual(headers) |
|||
} |
|||
} |
|||
|
|||
const contentTypeHeader = { |
|||
"Content-Type": "application/json", |
|||
} |
|||
|
|||
it("populates headers", async () => { |
|||
const assertions = { |
|||
createEntity: { |
|||
...contentTypeHeader, |
|||
}, |
|||
getEntities: {}, |
|||
getEntity: {}, |
|||
updateEntity: { |
|||
...contentTypeHeader, |
|||
}, |
|||
patchEntity: { |
|||
...contentTypeHeader, |
|||
}, |
|||
deleteEntity: { |
|||
"x-api-key": "{{x-api-key}}", |
|||
}, |
|||
} |
|||
|
|||
await runTests("crud", testHeaders, assertions) |
|||
}) |
|||
|
|||
const testQuery = async (file, extension, assertions) => { |
|||
const queries = await getQueries(file, extension) |
|||
for (let [operationId, queryString] of Object.entries(assertions)) { |
|||
expect(queries[operationId].fields.queryString).toStrictEqual( |
|||
queryString |
|||
) |
|||
} |
|||
} |
|||
|
|||
it("populates query", async () => { |
|||
const assertions = { |
|||
createEntity: "", |
|||
getEntities: "page={{page}}&size={{size}}", |
|||
getEntity: "", |
|||
updateEntity: "", |
|||
patchEntity: "", |
|||
deleteEntity: "", |
|||
} |
|||
await runTests("crud", testQuery, assertions) |
|||
}) |
|||
|
|||
const testParameters = async (file, extension, assertions) => { |
|||
const queries = await getQueries(file, extension) |
|||
for (let [operationId, parameters] of Object.entries(assertions)) { |
|||
expect(queries[operationId].parameters).toStrictEqual(parameters) |
|||
} |
|||
} |
|||
|
|||
it("populates parameters", async () => { |
|||
const assertions = { |
|||
createEntity: [], |
|||
getEntities: [ |
|||
{ |
|||
name: "page", |
|||
default: "", |
|||
}, |
|||
{ |
|||
name: "size", |
|||
default: "", |
|||
}, |
|||
], |
|||
getEntity: [ |
|||
{ |
|||
name: "entityId", |
|||
default: "", |
|||
}, |
|||
], |
|||
updateEntity: [ |
|||
{ |
|||
name: "entityId", |
|||
default: "", |
|||
}, |
|||
], |
|||
patchEntity: [ |
|||
{ |
|||
name: "entityId", |
|||
default: "", |
|||
}, |
|||
], |
|||
deleteEntity: [ |
|||
{ |
|||
name: "entityId", |
|||
default: "", |
|||
}, |
|||
{ |
|||
name: "x-api-key", |
|||
default: "", |
|||
}, |
|||
], |
|||
} |
|||
await runTests("crud", testParameters, assertions) |
|||
}) |
|||
|
|||
const testBody = async (file, extension, assertions) => { |
|||
const queries = await getQueries(file, extension) |
|||
for (let [operationId, body] of Object.entries(assertions)) { |
|||
expect(queries[operationId].fields.requestBody).toStrictEqual( |
|||
JSON.stringify(body, null, 2) |
|||
) |
|||
} |
|||
} |
|||
it("populates body", async () => { |
|||
const assertions = { |
|||
createEntity: { |
|||
name: "name", |
|||
type: "type", |
|||
}, |
|||
getEntities: undefined, |
|||
getEntity: undefined, |
|||
updateEntity: { |
|||
id: 1, |
|||
name: "name", |
|||
type: "type", |
|||
}, |
|||
patchEntity: { |
|||
id: 1, |
|||
name: "name", |
|||
type: "type", |
|||
}, |
|||
deleteEntity: undefined, |
|||
} |
|||
await runTests("crud", testBody, assertions) |
|||
}) |
|||
}) |
|||
}) |
|||
File diff suppressed because it is too large
@ -0,0 +1,205 @@ |
|||
import { |
|||
DatasourceFieldTypes, |
|||
Integration, |
|||
QueryTypes, |
|||
} from "../definitions/datasource" |
|||
import { IntegrationBase } from "./base/IntegrationBase" |
|||
import { Firestore, WhereFilterOp } from "@google-cloud/firestore" |
|||
|
|||
module Firebase { |
|||
interface FirebaseConfig { |
|||
email: string |
|||
privateKey: string |
|||
projectId: string |
|||
serviceAccount?: string |
|||
} |
|||
|
|||
const SCHEMA: Integration = { |
|||
docs: "https://firebase.google.com/docs/firestore/quickstart", |
|||
friendlyName: "Firestore", |
|||
description: |
|||
"Cloud Firestore is a flexible, scalable database for mobile, web, and server development from Firebase and Google Cloud.", |
|||
datasource: { |
|||
email: { |
|||
type: DatasourceFieldTypes.STRING, |
|||
required: true, |
|||
}, |
|||
privateKey: { |
|||
type: DatasourceFieldTypes.STRING, |
|||
required: true, |
|||
}, |
|||
projectId: { |
|||
type: DatasourceFieldTypes.STRING, |
|||
required: true, |
|||
}, |
|||
serviceAccount: { |
|||
type: DatasourceFieldTypes.JSON, |
|||
required: false, |
|||
}, |
|||
}, |
|||
query: { |
|||
create: { |
|||
type: QueryTypes.JSON, |
|||
}, |
|||
read: { |
|||
type: QueryTypes.JSON, |
|||
}, |
|||
update: { |
|||
type: QueryTypes.JSON, |
|||
}, |
|||
delete: { |
|||
type: QueryTypes.JSON, |
|||
}, |
|||
}, |
|||
extra: { |
|||
collection: { |
|||
displayName: "Collection", |
|||
type: DatasourceFieldTypes.STRING, |
|||
required: true, |
|||
}, |
|||
filterField: { |
|||
displayName: "Filter field", |
|||
type: DatasourceFieldTypes.STRING, |
|||
required: false, |
|||
}, |
|||
filter: { |
|||
displayName: "Filter comparison", |
|||
type: DatasourceFieldTypes.LIST, |
|||
required: false, |
|||
data: { |
|||
read: [ |
|||
"==", |
|||
"<", |
|||
"<=", |
|||
"==", |
|||
"!=", |
|||
">=", |
|||
">", |
|||
"array-contains", |
|||
"in", |
|||
"not-in", |
|||
"array-contains-any", |
|||
], |
|||
}, |
|||
}, |
|||
filterValue: { |
|||
displayName: "Filter value", |
|||
type: DatasourceFieldTypes.STRING, |
|||
required: false, |
|||
}, |
|||
}, |
|||
} |
|||
|
|||
class FirebaseIntegration implements IntegrationBase { |
|||
private config: FirebaseConfig |
|||
private db: Firestore |
|||
|
|||
constructor(config: FirebaseConfig) { |
|||
this.config = config |
|||
if (config.serviceAccount) { |
|||
const serviceAccount = JSON.parse(config.serviceAccount) |
|||
this.db = new Firestore({ |
|||
projectId: serviceAccount.project_id, |
|||
credentials: { |
|||
client_email: serviceAccount.client_email, |
|||
private_key: serviceAccount.private_key, |
|||
}, |
|||
}) |
|||
} else { |
|||
this.db = new Firestore({ |
|||
projectId: config.projectId, |
|||
credentials: { |
|||
client_email: config.email, |
|||
private_key: config.privateKey, |
|||
}, |
|||
}) |
|||
} |
|||
} |
|||
|
|||
async create(query: { json: object; extra: { [key: string]: string } }) { |
|||
try { |
|||
const documentReference = this.db |
|||
.collection(query.extra.collection) |
|||
.doc() |
|||
await documentReference.set({ ...query.json, id: documentReference.id }) |
|||
const snapshot = await documentReference.get() |
|||
return snapshot.data() |
|||
} catch (err) { |
|||
console.error("Error writing to Firestore", err) |
|||
throw err |
|||
} |
|||
} |
|||
|
|||
async read(query: { json: object; extra: { [key: string]: string } }) { |
|||
try { |
|||
let snapshot |
|||
const collectionRef = this.db.collection(query.extra.collection) |
|||
if ( |
|||
query.extra.filterField && |
|||
query.extra.filter && |
|||
query.extra.filterValue |
|||
) { |
|||
snapshot = await collectionRef |
|||
.where( |
|||
query.extra.filterField, |
|||
query.extra.filter as WhereFilterOp, |
|||
query.extra.filterValue |
|||
) |
|||
.get() |
|||
} else { |
|||
snapshot = await collectionRef.get() |
|||
} |
|||
const result: any[] = [] |
|||
snapshot.forEach(doc => result.push(doc.data())) |
|||
|
|||
return result |
|||
} catch (err) { |
|||
console.error("Error querying Firestore", err) |
|||
throw err |
|||
} |
|||
} |
|||
|
|||
async update(query: { |
|||
json: Record<string, any> |
|||
extra: { [key: string]: string } |
|||
}) { |
|||
try { |
|||
await this.db |
|||
.collection(query.extra.collection) |
|||
.doc(query.json.id) |
|||
.update(query.json) |
|||
|
|||
return ( |
|||
await this.db |
|||
.collection(query.extra.collection) |
|||
.doc(query.json.id) |
|||
.get() |
|||
).data() |
|||
} catch (err) { |
|||
console.error("Error writing to firebase", err) |
|||
throw err |
|||
} |
|||
} |
|||
|
|||
async delete(query: { |
|||
json: { id: string } |
|||
extra: { [key: string]: string } |
|||
}) { |
|||
try { |
|||
await this.db |
|||
.collection(query.extra.collection) |
|||
.doc(query.json.id) |
|||
.delete() |
|||
return true |
|||
} catch (err) { |
|||
console.error("Error writing to mongodb", err) |
|||
throw err |
|||
} |
|||
} |
|||
} |
|||
|
|||
module.exports = { |
|||
schema: SCHEMA, |
|||
integration: FirebaseIntegration, |
|||
} |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue