diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml index 2dd2224a989..e18dac9a554 100644 --- a/.github/workflows/lint-pr.yml +++ b/.github/workflows/lint-pr.yml @@ -35,6 +35,7 @@ jobs: go ruby seed + postman requireScope: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/generators/postman/CHANGELOG.md b/generators/postman/CHANGELOG.md index 2793316f499..bc4e2282fcb 100644 --- a/generators/postman/CHANGELOG.md +++ b/generators/postman/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.2.0] - 2024-08-21 + +- Internal: Upgrade the Postman generator to use IR version 53. + ## [0.1.1] - 2024-03-22 - Internal: Shared generator notification and config parsing logic. diff --git a/generators/postman/VERSION b/generators/postman/VERSION index 6da28dde76d..341cf11faf9 100644 --- a/generators/postman/VERSION +++ b/generators/postman/VERSION @@ -1 +1 @@ -0.1.1 \ No newline at end of file +0.2.0 \ No newline at end of file diff --git a/generators/postman/package.json b/generators/postman/package.json index 4f77b70712a..c749b943968 100644 --- a/generators/postman/package.json +++ b/generators/postman/package.json @@ -36,8 +36,9 @@ "dockerTagVersion": "pnpm dist:cli && docker build -f ./Dockerfile -t fernapi/fern-postman:${0} ." }, "dependencies": { + "@fern-api/core-utils": "workspace:*", "@fern-api/generator-commons": "workspace:*", - "@fern-fern/ir-sdk": "0.0.2828", + "@fern-fern/ir-sdk": "^53.7.0", "@fern-fern/postman-sdk": "0.0.46", "@types/lodash": "^4.17.4", "endent": "^2.1.0", diff --git a/generators/postman/src/auth.ts b/generators/postman/src/auth.ts index b80a3e009cc..1b8865f082f 100644 --- a/generators/postman/src/auth.ts +++ b/generators/postman/src/auth.ts @@ -34,6 +34,16 @@ export function convertAuth(schemes: AuthScheme[]): PostmanRequestAuth | undefin } ] }), + oauth: () => ({ + type: "bearer", + bearer: [ + { + key: "token", + value: getReferenceToVariable(BEARER_AUTH_TOKEN_VARIABLE), + type: "string" + } + ] + }), header: (header) => { return { type: "apikey", @@ -71,10 +81,11 @@ export function convertAuth(schemes: AuthScheme[]): PostmanRequestAuth | undefin export function getAuthHeaders(schemes: AuthScheme[]): PostmanHeader[] { return schemes.flatMap((scheme) => - AuthScheme._visit(scheme, { + AuthScheme._visit(scheme, { basic: () => [], bearer: () => [], - header: (header) => [ + oauth: () => [], + header: (header): PostmanHeader[] => [ { key: header.name.wireValue, value: getReferenceToVariable(getVariableForAuthHeader(header)), @@ -110,6 +121,13 @@ export function getVariablesForAuthScheme(scheme: AuthScheme): PostmanVariable[] type: "string" } ], + oauth: () => [ + { + key: BEARER_AUTH_TOKEN_VARIABLE, + value: "", + type: "string" + } + ], header: (header) => [ { key: getVariableForAuthHeader(header), diff --git a/generators/postman/src/convertExampleEndpointCall.ts b/generators/postman/src/convertExampleEndpointCall.ts index ef8b6f8c577..0a0f7ca659f 100644 --- a/generators/postman/src/convertExampleEndpointCall.ts +++ b/generators/postman/src/convertExampleEndpointCall.ts @@ -6,7 +6,7 @@ import { TypeDeclaration } from "@fern-fern/ir-sdk/api"; import { PostmanExampleResponse, PostmanHeader } from "@fern-fern/postman-sdk/api"; -import { isEqual, startCase } from "lodash"; +import { isEqual, startCase, values } from "lodash"; import { GeneratedExampleRequest } from "./request/GeneratedExampleRequest"; export function convertExampleEndpointCall({ @@ -35,15 +35,40 @@ export function convertExampleEndpointCall({ return { ...getNameAndStatus({ example, allErrors }), originalRequest: generatedRequest, - description: httpEndpoint.response?.docs ?? undefined, - body: - example.response.body?.jsonExample != null - ? JSON.stringify(example.response.body.jsonExample, undefined, 4) - : "", + description: + httpEndpoint.response?.body?._visit({ + fileDownload: (value) => value.docs, + json: (value) => value.docs, + streamParameter: (value) => value.streamResponse.docs, + streaming: (value) => value.docs, + text: (value) => value.docs, + _other: () => undefined + }) ?? undefined, + body: example.response._visit({ + ok: (value) => { + return value._visit({ + body: (value) => maybeStringify({ jsonExample: value?.jsonExample }), + sse: (value) => maybeStringify({ jsonExample: value.map((event) => event?.data.jsonExample) }), + stream: (value) => maybeStringify({ jsonExample: value.map((event) => event.jsonExample) }), + _other: () => "" + }); + }, + error: (value) => { + return maybeStringify({ jsonExample: value?.body?.jsonExample }); + }, + _other: () => "" + }), postmanPreviewlanguage: "json" }; } +function maybeStringify({ jsonExample }: { jsonExample?: unknown }): string { + if (jsonExample == null) { + return ""; + } + return JSON.stringify(jsonExample, undefined, 4); +} + function getNameAndStatus({ example, allErrors diff --git a/generators/postman/src/convertToPostmanCollection.ts b/generators/postman/src/convertToPostmanCollection.ts index 63d33a359d7..5be8ecd6a80 100644 --- a/generators/postman/src/convertToPostmanCollection.ts +++ b/generators/postman/src/convertToPostmanCollection.ts @@ -15,9 +15,9 @@ import { PostmanHeader } from "@fern-fern/postman-sdk/api"; import { startCase } from "lodash"; +import { isNonNullish } from "@fern-api/core-utils"; import { convertAuth, getAuthHeaders, getVariablesForAuthScheme } from "./auth"; import { convertExampleEndpointCall } from "./convertExampleEndpointCall"; -import { GeneratedDummyRequest } from "./request/GeneratedDummyRequest"; import { GeneratedExampleRequest } from "./request/GeneratedExampleRequest"; import { ORIGIN_VARIABLE_NAME } from "./utils"; @@ -82,6 +82,12 @@ function filterAuthSchemes(auth: ApiAuth): AuthScheme[] { } return (hasSeenAuthorizationHeader = true); }, + oauth: () => { + if (hasSeenAuthorizationHeader) { + return false; + } + return (hasSeenAuthorizationHeader = true); + }, header: () => true, _other: () => { throw new Error("Unknown auth scheme: " + scheme.type); @@ -129,18 +135,24 @@ function getCollectionItemsForPackage( throw new Error("Service does not exist: " + package_.service); } items.push( - ...service.endpoints.map( - (httpEndpoint): PostmanCollectionItem.Endpoint => ({ - type: "endpoint", - ...convertEndpoint({ + ...service.endpoints + .map((httpEndpoint): PostmanCollectionItem.Endpoint | undefined => { + const convertedEndpoint = convertEndpoint({ authHeaders, httpEndpoint, httpService: service, allTypes: Object.values(ir.types), allErrors: Object.values(ir.errors) - }) + }); + if (convertedEndpoint != null) { + return { + type: "endpoint", + ...convertedEndpoint + }; + } + return undefined; }) - ) + .filter(isNonNullish) ); } @@ -159,18 +171,28 @@ function convertEndpoint({ httpService: HttpService; allTypes: TypeDeclaration[]; allErrors: ErrorDeclaration[]; -}): PostmanCollectionEndpointItem { - const example = httpEndpoint.examples[0]; - const generatedRequest = - example != null - ? new GeneratedExampleRequest({ authHeaders, httpService, httpEndpoint, allTypes, example }) - : new GeneratedDummyRequest({ authHeaders, httpService, httpEndpoint, allTypes }); +}): PostmanCollectionEndpointItem | undefined { + const example = httpEndpoint.userSpecifiedExamples[0]?.example ?? httpEndpoint.autogeneratedExamples[0]?.example; + + if (example == null) { + return undefined; + } return { name: httpEndpoint.displayName ?? startCase(httpEndpoint.name.originalName), - request: generatedRequest.get(), - response: httpEndpoint.examples.map((example) => - convertExampleEndpointCall({ authHeaders, httpService, httpEndpoint, allTypes, allErrors, example }) - ) + request: new GeneratedExampleRequest({ authHeaders, httpService, httpEndpoint, allTypes, example }).get(), + response: [...httpEndpoint.userSpecifiedExamples, ...httpEndpoint.autogeneratedExamples] + .map((example) => example.example) + .filter(isNonNullish) + .map((example) => + convertExampleEndpointCall({ + authHeaders, + httpService, + httpEndpoint, + allTypes, + allErrors, + example + }) + ) }; } diff --git a/generators/postman/src/getMockBody.ts b/generators/postman/src/getMockBody.ts deleted file mode 100644 index 1c7a278e712..00000000000 --- a/generators/postman/src/getMockBody.ts +++ /dev/null @@ -1,253 +0,0 @@ -import { - ContainerType, - DeclaredTypeName, - FileUploadRequestProperty, - HttpRequestBody, - PrimitiveType, - SingleUnionTypeProperties, - SingleUnionTypeProperty, - Type, - TypeDeclaration, - TypeReference -} from "@fern-fern/ir-sdk/api"; -import { noop } from "lodash"; - -const ISO_DATE = "1994-11-05"; -const ISO_DATETIME = "1994-11-05T13:15:30Z"; -const UUID = "3d20db99-b2d9-4643-8f04-13452707b8e8"; -const BASE_64 = "SGVsbG8gV29ybGQ="; - -export function getMockBodyFromTypeReference({ - typeReference, - allTypes, - visitedTypes = new Set() -}: { - typeReference: TypeReference; - allTypes: TypeDeclaration[]; - visitedTypes?: Set; -}): unknown { - if (typeReference.type === "named") { - if (visitedTypes.has(typeReference.typeId)) { - return undefined; - } - visitedTypes.add(typeReference.typeId); - } - return TypeReference._visit(typeReference, { - primitive: (primitive) => - PrimitiveType._visit(primitive, { - integer: () => 0, - double: () => 0.0, - string: () => "example", - boolean: () => true, - long: () => 10000000, - dateTime: () => ISO_DATETIME, - date: () => ISO_DATE, - uuid: () => UUID, - base64: () => BASE_64, - _other: () => { - throw new Error("Encountered unknown primtiveType: " + primitive); - } - }), - container: (container) => - ContainerType._visit(container, { - list: (value) => [getMockBodyFromTypeReference({ typeReference: value, allTypes, visitedTypes })], - map: (value) => { - const result: Record = {}; - const mockKey = getMockBodyFromTypeReference({ - typeReference: value.keyType, - allTypes, - visitedTypes - }) as string | number; - const mockValue = getMockBodyFromTypeReference({ - typeReference: value.valueType, - allTypes, - visitedTypes - }); - result[mockKey] = mockValue; - return result; - }, - set: (value) => [getMockBodyFromTypeReference({ typeReference: value, allTypes, visitedTypes })], - optional: (value) => getMockBodyFromTypeReference({ typeReference: value, allTypes, visitedTypes }), - _other: () => { - throw new Error("Encountered unknown wireMessage: " + typeReference.type); - }, - literal: () => { - throw new Error("Literals are unsupported!"); - } - }), - named: (typeName) => { - return getMockBodyFromType(getType(typeName, allTypes), allTypes, visitedTypes); - }, - unknown: () => "UNKNOWN", - _other: () => { - throw new Error("Encountered unknown type reference: " + typeReference.type); - } - }); -} - -function getMockBodyFromType( - type: TypeDeclaration, - allTypes: TypeDeclaration[], - visitedTypes: Set | undefined -): unknown { - if (type.examples[0] != null) { - return type.examples[0].jsonExample; - } - return Type._visit(type.shape, { - object: (objectDeclaration) => { - return { - ...objectDeclaration.properties.reduce>( - (combined, objectProperty) => ({ - ...combined, - [objectProperty.name.wireValue]: getMockBodyFromTypeReference({ - typeReference: objectProperty.valueType, - allTypes, - visitedTypes - }) - }), - {} - ), - ...objectDeclaration.extends.reduce>((combined, extension) => { - const mockBody = getMockBodyFromType(getType(extension, allTypes), allTypes, visitedTypes); - return { - ...combined, - ...(typeof mockBody === "object" ? mockBody : {}) - }; - }, {}) - }; - }, - alias: ({ aliasOf }) => getMockBodyFromTypeReference({ typeReference: aliasOf, allTypes, visitedTypes }), - enum: ({ values }) => { - const firstValue = values[0]; - if (firstValue == null) { - throw new Error("No values for enum."); - } - return firstValue.name.wireValue; - }, - union: (unionDeclaration) => { - const firstUnionType = unionDeclaration.types[0]; - if (firstUnionType == null) { - throw new Error("No values for union."); - } - - const discriminantProperties: Record = { - [unionDeclaration.discriminant.wireValue]: firstUnionType.discriminantValue.wireValue - }; - - return SingleUnionTypeProperties._visit(firstUnionType.shape, { - samePropertiesAsObject: (value) => { - // TODO this doesn't support named aliases of primitive types - const mockBody = getMockBodyFromTypeReference({ - typeReference: TypeReference.named(value), - allTypes, - visitedTypes - }); - return { - ...discriminantProperties, - ...(typeof mockBody === "object" ? mockBody : {}) - }; - }, - singleProperty: (value: SingleUnionTypeProperty) => { - return { - ...discriminantProperties, - [value.name.wireValue]: getMockBodyFromTypeReference({ - typeReference: value.type, - allTypes, - visitedTypes - }) - }; - }, - noProperties: () => { - return { - ...discriminantProperties - }; - }, - _other: () => { - throw new Error("Encountered unknown typeReference: " + firstUnionType.shape.propertiesType); - } - }); - }, - undiscriminatedUnion: (unionDeclaration) => { - const firstUnionType = unionDeclaration.members[0]; - if (firstUnionType == null) { - throw new Error("No values for union."); - } - - return getMockBodyFromTypeReference({ - typeReference: firstUnionType.type, - allTypes, - visitedTypes - }); - }, - _other: () => { - throw new Error("Unknown type: " + type.shape.type); - } - }); -} - -function getType(declaredTypeName: DeclaredTypeName, allTypes: TypeDeclaration[]): TypeDeclaration { - const namedType = allTypes.find((val) => val.name.typeId === declaredTypeName.typeId); - if (namedType == null) { - throw new Error("Cannot find type: " + declaredTypeName.name.originalName); - } - return namedType; -} - -export function getMockRequestBody({ - requestBody, - allTypes, - visitedTypes = new Set() -}: { - requestBody: HttpRequestBody; - allTypes: TypeDeclaration[]; - visitedTypes?: Set; -}): unknown { - return HttpRequestBody._visit(requestBody, { - inlinedRequestBody: (inlinedRequestBody) => ({ - ...inlinedRequestBody.properties.reduce>( - (combined, objectProperty) => ({ - ...combined, - [objectProperty.name.wireValue]: getMockBodyFromTypeReference({ - typeReference: objectProperty.valueType, - allTypes, - visitedTypes - }) - }), - {} - ), - ...inlinedRequestBody.extends.reduce>((combined, extension) => { - const mockBody = getMockBodyFromType(getType(extension, allTypes), allTypes, visitedTypes); - return { - ...combined, - ...(typeof mockBody === "object" ? mockBody : {}) - }; - }, {}) - }), - reference: ({ requestBodyType }) => - getMockBodyFromTypeReference({ typeReference: requestBodyType, allTypes, visitedTypes }), - fileUpload: ({ properties }) => { - return properties.reduce>((obj, property) => { - FileUploadRequestProperty._visit(property, { - file: noop, - bodyProperty: (bodyProperty) => { - obj[bodyProperty.name.wireValue] = getMockBodyFromTypeReference({ - typeReference: bodyProperty.valueType, - allTypes, - visitedTypes - }); - }, - _other: () => { - throw new Error("Unknown FileUploadRequestProperty: " + property.type); - } - }); - return obj; - }, {}); - }, - bytes: () => { - throw new Error("bytes is not supported"); - }, - _other: () => { - throw new Error("Unknown HttpRequestBody: " + requestBody.type); - } - }); -} diff --git a/generators/postman/src/request/AbstractGeneratedRequest.ts b/generators/postman/src/request/AbstractGeneratedRequest.ts index a0a9f35ce8f..41bd60ab178 100644 --- a/generators/postman/src/request/AbstractGeneratedRequest.ts +++ b/generators/postman/src/request/AbstractGeneratedRequest.ts @@ -7,7 +7,6 @@ import { PostmanRequestBodyMode, PostmanUrlVariable } from "@fern-fern/postman-sdk/api"; -import { getMockBodyFromTypeReference } from "../getMockBody"; import { getReferenceToVariable, ORIGIN_VARIABLE_NAME } from "../utils"; import { GeneratedRequest } from "./GeneratedRequest"; @@ -73,8 +72,7 @@ export abstract class AbstractGeneratedRequest implements GeneratedRequest { } protected convertHeader({ header, value }: { header: HttpHeader; value?: unknown }): PostmanHeader { - const valueOrDefault = - value ?? getMockBodyFromTypeReference({ typeReference: header.valueType, allTypes: this.allTypes }); + const valueOrDefault = value ?? `YOUR_${header.name.name.screamingSnakeCase.unsafeName}`; return { key: header.name.wireValue, description: header.docs ?? undefined, diff --git a/generators/postman/src/request/GeneratedDummyRequest.ts b/generators/postman/src/request/GeneratedDummyRequest.ts deleted file mode 100644 index 641a7bd5d4f..00000000000 --- a/generators/postman/src/request/GeneratedDummyRequest.ts +++ /dev/null @@ -1,37 +0,0 @@ -import { PostmanHeader, PostmanUrlVariable } from "@fern-fern/postman-sdk/api"; -import { getMockRequestBody } from "../getMockBody"; -import { AbstractGeneratedRequest } from "./AbstractGeneratedRequest"; - -export class GeneratedDummyRequest extends AbstractGeneratedRequest { - protected getQueryParams(): PostmanUrlVariable[] { - return this.httpEndpoint.queryParameters.map((queryParam) => ({ - key: queryParam.name.wireValue, - value: "", - description: queryParam.docs ?? undefined - })); - } - - protected getPathParams(): PostmanUrlVariable[] { - return [...this.httpService.pathParameters, ...this.httpEndpoint.pathParameters].map((pathParam) => ({ - key: pathParam.name.originalName, - value: "", - description: pathParam.docs ?? undefined - })); - } - - protected getHeaders(): PostmanHeader[] { - return [...this.httpService.headers, ...this.httpEndpoint.headers].map((header) => - this.convertHeader({ header }) - ); - } - - protected getRequestBody(): unknown { - if (this.httpEndpoint.requestBody == null) { - return undefined; - } - return getMockRequestBody({ - requestBody: this.httpEndpoint.requestBody, - allTypes: this.allTypes - }); - } -} diff --git a/generators/postman/src/request/GeneratedExampleRequest.ts b/generators/postman/src/request/GeneratedExampleRequest.ts index 9320676232d..0a465f2ee04 100644 --- a/generators/postman/src/request/GeneratedExampleRequest.ts +++ b/generators/postman/src/request/GeneratedExampleRequest.ts @@ -25,13 +25,13 @@ export class GeneratedExampleRequest extends AbstractGeneratedRequest { protected getQueryParams(): PostmanUrlVariable[] { return this.example.queryParameters.map((exampleQueryParameter) => { const queryParameterDeclaration = this.httpEndpoint.queryParameters.find( - (param) => param.name.wireValue === exampleQueryParameter.wireKey + (param) => param.name.wireValue === exampleQueryParameter.name.wireValue ); if (queryParameterDeclaration == null) { - throw new Error(`Cannot find query parameter ${exampleQueryParameter.wireKey}`); + throw new Error(`Cannot find query parameter ${exampleQueryParameter.name.wireValue}`); } return { - key: exampleQueryParameter.wireKey, + key: exampleQueryParameter.name.wireValue, description: queryParameterDeclaration.docs ?? undefined, value: typeof exampleQueryParameter.value.jsonExample !== "string" @@ -63,13 +63,13 @@ export class GeneratedExampleRequest extends AbstractGeneratedRequest { }) { return examples.map((examplePathParameter) => { const pathParameterDeclaration = pathParameters.find( - (param) => param.name.originalName === examplePathParameter.key + (param) => param.name.originalName === examplePathParameter.name.originalName ); if (pathParameterDeclaration == null) { - throw new Error(`Cannot find path parameter ${examplePathParameter.key}`); + throw new Error(`Cannot find path parameter ${examplePathParameter.name.originalName}`); } return { - key: examplePathParameter.key, + key: examplePathParameter.name.originalName, description: pathParameterDeclaration.docs ?? undefined, value: typeof examplePathParameter.value.jsonExample !== "string" @@ -107,9 +107,9 @@ export class GeneratedExampleRequest extends AbstractGeneratedRequest { examples: ExampleHeader[]; }): PostmanHeader[] { return examples.map((exampleHeader) => { - const headerDeclaration = headers.find((header) => header.name.wireValue === exampleHeader.wireKey); + const headerDeclaration = headers.find((header) => header.name.wireValue === exampleHeader.name.wireValue); if (headerDeclaration == null) { - throw new Error(`Cannot find header ${exampleHeader.wireKey}`); + throw new Error(`Cannot find header ${exampleHeader.name.wireValue}`); } return this.convertHeader({ header: headerDeclaration, diff --git a/generators/postman/src/writePostmanCollection.ts b/generators/postman/src/writePostmanCollection.ts index 88452d24c90..3940b7c03f3 100644 --- a/generators/postman/src/writePostmanCollection.ts +++ b/generators/postman/src/writePostmanCollection.ts @@ -177,5 +177,9 @@ async function publishCollection({ async function loadIntermediateRepresentation(pathToFile: string): Promise { const irString = (await readFile(pathToFile)).toString(); const irJson = JSON.parse(irString); - return IrSerialization.IntermediateRepresentation.parseOrThrow(irJson); + return IrSerialization.IntermediateRepresentation.parseOrThrow(irJson, { + unrecognizedObjectKeys: "passthrough", + allowUnrecognizedUnionMembers: true, + allowUnrecognizedEnumValues: true + }); } diff --git a/generators/postman/tsconfig.json b/generators/postman/tsconfig.json index 0eb91de6063..460e0cd8234 100644 --- a/generators/postman/tsconfig.json +++ b/generators/postman/tsconfig.json @@ -2,5 +2,8 @@ "extends": "../../shared/tsconfig.shared.json", "compilerOptions": { "composite": true, "outDir": "lib", "rootDir": "src" }, "include": ["./src/**/*"], - "references": [{ "path": "../commons" }] + "references": [ + { "path": "../commons" }, + { "path": "../../packages/core" } + ] } diff --git a/packages/cli/cli/CHANGELOG.md b/packages/cli/cli/CHANGELOG.md index c6abea40c35..df3988a479a 100644 --- a/packages/cli/cli/CHANGELOG.md +++ b/packages/cli/cli/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.39.16] - 2024-08-21 + +- Chore: Support running 0.2.x versions of the Postman Generator with IR V53 or above. + ## [0.39.15] - 2024-08-21 - Internal: Introduce `generator list` and `organization` commands to faciliate actions taken by `fern-bot` diff --git a/packages/cli/cli/VERSION b/packages/cli/cli/VERSION index 6661c5cb337..669d120867a 100644 --- a/packages/cli/cli/VERSION +++ b/packages/cli/cli/VERSION @@ -1 +1 @@ -0.39.15 +0.39.16 diff --git a/packages/cli/generation/ir-migrations/src/migrations/v53-to-v52/migrateFromV53ToV52.ts b/packages/cli/generation/ir-migrations/src/migrations/v53-to-v52/migrateFromV53ToV52.ts index 8adc18529eb..b30664d4ef6 100644 --- a/packages/cli/generation/ir-migrations/src/migrations/v53-to-v52/migrateFromV53ToV52.ts +++ b/packages/cli/generation/ir-migrations/src/migrations/v53-to-v52/migrateFromV53ToV52.ts @@ -30,7 +30,7 @@ export const V53_TO_V52_MIGRATION: IrMigration< [GeneratorName.OPENAPI_PYTHON_CLIENT]: GeneratorWasNeverUpdatedToConsumeNewIR, [GeneratorName.OPENAPI]: GeneratorWasNeverUpdatedToConsumeNewIR, [GeneratorName.STOPLIGHT]: GeneratorWasNeverUpdatedToConsumeNewIR, - [GeneratorName.POSTMAN]: GeneratorWasNeverUpdatedToConsumeNewIR, + [GeneratorName.POSTMAN]: "0.2.0", [GeneratorName.PYTHON_SDK]: "3.3.0-rc0", [GeneratorName.GO_FIBER]: GeneratorWasNeverUpdatedToConsumeNewIR, [GeneratorName.GO_MODEL]: GeneratorWasNeverUpdatedToConsumeNewIR, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index df0ffb8a494..31b8d4bcbbf 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -445,12 +445,15 @@ importers: generators/postman: dependencies: + '@fern-api/core-utils': + specifier: workspace:* + version: link:../../packages/commons/core-utils '@fern-api/generator-commons': specifier: workspace:* version: link:../commons '@fern-fern/ir-sdk': - specifier: 0.0.2828 - version: 0.0.2828 + specifier: ^53.7.0 + version: 53.7.2 '@fern-fern/postman-sdk': specifier: 0.0.46 version: 0.0.46 @@ -3177,6 +3180,10 @@ importers: specifier: 4.6.4 version: 4.6.4 + packages/cli/cli/dist/dev: {} + + packages/cli/cli/dist/prod: {} + packages/cli/configuration: dependencies: '@fern-api/core-utils': @@ -6724,6 +6731,9 @@ packages: '@fern-fern/ir-sdk@53.7.0': resolution: {integrity: sha512-PoCj8yOep3kFeDZYORAzqPwVtCSNmbT2SfR/AoxKCcikeZ5i+4Um4ZXx1e6UaAy7dIYF5kWeRc6lptFBRoj7Gw==} + '@fern-fern/ir-sdk@53.7.2': + resolution: {integrity: sha512-mLw91KwIwzLnY36X2oHLo/2ue3WaOFWQBSKRdVR12/wui0+Q5G7tNyXhxgZxT8UzQPYIt4dcOp+qp5XT9UZh1Q==} + '@fern-fern/ir-v1-model@0.0.2': resolution: {integrity: sha512-Rho6qXYfRoB1sAISFS4V7vttVFN0ypoaztmbfKKNFmSTNVOyLN++e2xNZ+Aw9ckE5ZZmfMXK9v4+dnFReWVzvA==} @@ -13805,6 +13815,8 @@ snapshots: '@fern-fern/ir-sdk@53.7.0': {} + '@fern-fern/ir-sdk@53.7.2': {} + '@fern-fern/ir-v1-model@0.0.2': {} '@fern-fern/ir-v10-model@0.0.1': {} diff --git a/seed/postman/alias-extends/collection.json b/seed/postman/alias-extends/collection.json index b74fd16bc12..23771ff1915 100644 --- a/seed/postman/alias-extends/collection.json +++ b/seed/postman/alias-extends/collection.json @@ -30,12 +30,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"child\": \"example\",\n \"parent\": \"Property from the parent\"\n}", + "raw": "{\n \"child\": \"string\",\n \"parent\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -43,7 +49,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/extends/extended-inline-request-body", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "extends", + "extended-inline-request-body" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"child\": \"string\",\n \"parent\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/alias/collection.json b/seed/postman/alias/collection.json index 3417a63571b..440c4e5f7a8 100644 --- a/seed/postman/alias/collection.json +++ b/seed/postman/alias/collection.json @@ -30,17 +30,62 @@ "variable": [ { "key": "typeId", - "value": "", - "description": null + "description": null, + "value": "type-kaljhv87" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/:typeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":typeId" + ], + "query": [], + "variable": [ + { + "key": "typeId", + "description": null, + "value": "type-kaljhv87" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/any-auth/collection.json b/seed/postman/any-auth/collection.json new file mode 100644 index 00000000000..068399131b5 --- /dev/null +++ b/seed/postman/any-auth/collection.json @@ -0,0 +1,214 @@ +{ + "info": { + "name": "Any Auth", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + }, + { + "key": "token", + "value": "", + "type": "string" + }, + { + "key": "apiKey", + "value": "", + "type": "string" + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{token}}", + "type": "string" + } + ] + }, + "item": [ + { + "_type": "container", + "description": null, + "name": "Auth", + "item": [ + { + "_type": "endpoint", + "name": "Get Token", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-Key", + "value": "{{apiKey}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-Key", + "value": "{{apiKey}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1,\n \"refresh_token\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + }, + { + "_type": "container", + "description": null, + "name": "User", + "item": [ + { + "_type": "endpoint", + "name": "Get", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-Key", + "value": "{{apiKey}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-Key", + "value": "{{apiKey}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/api-wide-base-path/collection.json b/seed/postman/api-wide-base-path/collection.json index 6ce7496ff17..1abd8fd7ab3 100644 --- a/seed/postman/api-wide-base-path/collection.json +++ b/seed/postman/api-wide-base-path/collection.json @@ -37,27 +37,84 @@ "variable": [ { "key": "serviceParam", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "resourceParam", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "endpointParam", - "value": "", - "description": null + "description": null, + "value": "1" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/:serviceParam/:endpointParam/:resourceParam", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":serviceParam", + ":endpointParam", + ":resourceParam" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "string" + }, + { + "key": "resourceParam", + "description": null, + "value": "string" + }, + { + "key": "endpointParam", + "description": null, + "value": "1" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/audiences/collection.json b/seed/postman/audiences/collection.json index b54e76db077..d4cc3cc7623 100644 --- a/seed/postman/audiences/collection.json +++ b/seed/postman/audiences/collection.json @@ -37,12 +37,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"foo\": {\n \"foo\": {\n \"bar_property\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -74,12 +111,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/partner-path", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner-path" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"foo\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -96,7 +172,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}?optionalString=", + "raw": "{{baseUrl}}?optionalString=string", "host": [ "{{baseUrl}}" ], @@ -104,18 +180,24 @@ "query": [ { "key": "optionalString", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"publicProperty\": \"example\",\n \"privateProperty\": 0\n}", + "raw": "{\n \"publicProperty\": \"string\",\n \"privateProperty\": 1\n}", "options": { "raw": { "language": "json" @@ -123,7 +205,52 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}?optionalString=string", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [ + { + "key": "optionalString", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"publicProperty\": \"string\",\n \"privateProperty\": 1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"imported\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/auth-environment-variables/collection.json b/seed/postman/auth-environment-variables/collection.json index c73fb18388b..956cefae5fc 100644 --- a/seed/postman/auth-environment-variables/collection.json +++ b/seed/postman/auth-environment-variables/collection.json @@ -64,13 +64,57 @@ "value": "{{apiKey}}", "type": "string", "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" } ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request with custom api key", + "url": { + "raw": "{{baseUrl}}/apiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "apiKey" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-FERN-API-KEY", + "value": "{{apiKey}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -99,14 +143,64 @@ "key": "X-Endpoint-Header", "description": "Specifies the endpoint key.", "type": "text", - "value": "\"example\"" + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" } ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request with custom api key", + "url": { + "raw": "{{baseUrl}}/apiKeyInHeader", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "apiKeyInHeader" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-FERN-API-KEY", + "value": "{{apiKey}}", + "type": "string", + "description": null + }, + { + "key": "X-Endpoint-Header", + "description": "Specifies the endpoint key.", + "type": "text", + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/basic-auth-environment-variables/collection.json b/seed/postman/basic-auth-environment-variables/collection.json index da47cb35f85..a6f1de9ca39 100644 --- a/seed/postman/basic-auth-environment-variables/collection.json +++ b/seed/postman/basic-auth-environment-variables/collection.json @@ -58,12 +58,83 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Request", + "status": "Unauthorized Request", + "code": 401, + "originalRequest": { + "description": "GET request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -81,12 +152,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"UNKNOWN\"", + "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" @@ -94,7 +171,128 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "POST request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Request", + "status": "Unauthorized Request", + "code": 401, + "originalRequest": { + "description": "POST request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Bad Request", + "status": "Bad Request", + "code": 400, + "originalRequest": { + "description": "POST request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/basic-auth/collection.json b/seed/postman/basic-auth/collection.json index 8fb6a945154..b787dcb00c6 100644 --- a/seed/postman/basic-auth/collection.json +++ b/seed/postman/basic-auth/collection.json @@ -58,12 +58,83 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Request", + "status": "Unauthorized Request", + "code": 401, + "originalRequest": { + "description": "GET request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -81,12 +152,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"UNKNOWN\"", + "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" @@ -94,7 +171,128 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "POST request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Request", + "status": "Unauthorized Request", + "code": 401, + "originalRequest": { + "description": "POST request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Bad Request", + "status": "Bad Request", + "code": 400, + "originalRequest": { + "description": "POST request with basic auth scheme", + "url": { + "raw": "{{baseUrl}}/basic-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "basic-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/bearer-token-environment-variable/collection.json b/seed/postman/bearer-token-environment-variable/collection.json index 756e86a0219..f6d5bffac31 100644 --- a/seed/postman/bearer-token-environment-variable/collection.json +++ b/seed/postman/bearer-token-environment-variable/collection.json @@ -48,12 +48,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request with custom api key", + "url": { + "raw": "{{baseUrl}}/apiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "apiKey" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/bytes/collection.json b/seed/postman/bytes/collection.json index 6ca3a6c7041..1bbece3c24f 100644 --- a/seed/postman/bytes/collection.json +++ b/seed/postman/bytes/collection.json @@ -17,7 +17,70 @@ "_type": "container", "description": null, "name": "Service", - "item": [] + "item": [ + { + "_type": "endpoint", + "name": "Upload", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/upload-content", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "upload-content" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/upload-content", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "upload-content" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/circular-references/.mock/definition/ast.yml b/seed/postman/circular-references/.mock/definition/ast.yml index b6711dc9d68..4d9e43d0c96 100644 --- a/seed/postman/circular-references/.mock/definition/ast.yml +++ b/seed/postman/circular-references/.mock/definition/ast.yml @@ -14,3 +14,11 @@ types: - NUMBER ObjectValue: properties: {} + JsonLike: + discriminated: false + union: + - list + - map + - string + - integer + - boolean diff --git a/seed/postman/cross-package-type-names/collection.json b/seed/postman/cross-package-type-names/collection.json index 806f4a766df..386d40f36e7 100644 --- a/seed/postman/cross-package-type-names/collection.json +++ b/seed/postman/cross-package-type-names/collection.json @@ -37,12 +37,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"foo\": {\n \"foo\": {\n \"bar_property\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -72,12 +109,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"foo\": {\n \"foo\": {\n \"bar_property\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -94,7 +168,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}?optionalString=", + "raw": "{{baseUrl}}?optionalString=string", "host": [ "{{baseUrl}}" ], @@ -102,18 +176,24 @@ "query": [ { "key": "optionalString", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"publicProperty\": \"example\",\n \"privateProperty\": 0\n}", + "raw": "{\n \"publicProperty\": \"string\",\n \"privateProperty\": 1\n}", "options": { "raw": { "language": "json" @@ -121,7 +201,52 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}?optionalString=string", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [ + { + "key": "optionalString", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"publicProperty\": \"string\",\n \"privateProperty\": 1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"imported\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/custom-auth/collection.json b/seed/postman/custom-auth/collection.json index 7c49dc23adb..ce82b077381 100644 --- a/seed/postman/custom-auth/collection.json +++ b/seed/postman/custom-auth/collection.json @@ -64,13 +64,95 @@ "value": "{{customAuthScheme}}", "type": "string", "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" } ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request with custom auth scheme", + "url": { + "raw": "{{baseUrl}}/custom-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "custom-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-KEY", + "value": "{{customAuthScheme}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Request", + "status": "Unauthorized Request", + "code": 401, + "originalRequest": { + "description": "GET request with custom auth scheme", + "url": { + "raw": "{{baseUrl}}/custom-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "custom-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-KEY", + "value": "{{customAuthScheme}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -94,13 +176,18 @@ "value": "{{customAuthScheme}}", "type": "string", "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"UNKNOWN\"", + "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" @@ -108,7 +195,146 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "POST request with custom auth scheme", + "url": { + "raw": "{{baseUrl}}/custom-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "custom-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-KEY", + "value": "{{customAuthScheme}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Request", + "status": "Unauthorized Request", + "code": 401, + "originalRequest": { + "description": "POST request with custom auth scheme", + "url": { + "raw": "{{baseUrl}}/custom-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "custom-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-KEY", + "value": "{{customAuthScheme}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Bad Request", + "status": "Bad Request", + "code": 400, + "originalRequest": { + "description": "POST request with custom auth scheme", + "url": { + "raw": "{{baseUrl}}/custom-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "custom-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-API-KEY", + "value": "{{customAuthScheme}}", + "type": "string", + "description": null + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/enum/collection.json b/seed/postman/enum/collection.json index 1bb3844eb0b..22e25b0aae0 100644 --- a/seed/postman/enum/collection.json +++ b/seed/postman/enum/collection.json @@ -54,6 +54,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/inlined", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "inlined" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"operand\": \">\",\n \"operandOrColor\": \"red\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -132,6 +172,11 @@ "description": null, "value": "less_than" }, + { + "key": "operandOrColor", + "description": null, + "value": "red" + }, { "key": "maybeOperandOrColor", "description": null, @@ -181,6 +226,68 @@ "description": null, "value": "less_than" }, + { + "key": "operandOrColor", + "description": null, + "value": "red" + }, + { + "key": "maybeOperandOrColor", + "description": null, + "value": "red" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/path/:operand/:maybeOperand/:operandOrColor/:maybeOperandOrColor", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "path", + ":operand", + ":maybeOperand", + ":operandOrColor", + ":maybeOperandOrColor" + ], + "query": [], + "variable": [ + { + "key": "operand", + "description": null, + "value": ">" + }, + { + "key": "maybeOperand", + "description": null, + "value": ">" + }, + { + "key": "operandOrColor", + "description": null, + "value": "red" + }, { "key": "maybeOperandOrColor", "description": null, @@ -218,7 +325,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/query?operand=%3E", + "raw": "{{baseUrl}}/query?operand=%3E&operandOrColor=red", "host": [ "{{baseUrl}}" ], @@ -230,6 +337,11 @@ "key": "operand", "description": null, "value": ">" + }, + { + "key": "operandOrColor", + "description": null, + "value": "red" } ], "variable": [] @@ -253,7 +365,50 @@ "originalRequest": { "description": null, "url": { - "raw": "{{baseUrl}}/query?operand=%3E", + "raw": "{{baseUrl}}/query?operand=%3E&operandOrColor=red", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "query" + ], + "query": [ + { + "key": "operand", + "description": null, + "value": ">" + }, + { + "key": "operandOrColor", + "description": null, + "value": "red" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/query?operand=%3E&maybeOperand=%3E&operandOrColor=red&maybeOperandOrColor=red", "host": [ "{{baseUrl}}" ], @@ -265,6 +420,21 @@ "key": "operand", "description": null, "value": ">" + }, + { + "key": "maybeOperand", + "description": null, + "value": ">" + }, + { + "key": "operandOrColor", + "description": null, + "value": "red" + }, + { + "key": "maybeOperandOrColor", + "description": null, + "value": "red" } ], "variable": [] @@ -292,7 +462,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/query-list?operand=&maybeOperand=&operandOrColor=&maybeOperandOrColor=", + "raw": "{{baseUrl}}/query-list?operand=%3E&maybeOperand=%3E&operandOrColor=red&maybeOperandOrColor=red", "host": [ "{{baseUrl}}" ], @@ -302,33 +472,93 @@ "query": [ { "key": "operand", - "value": "", - "description": null + "description": null, + "value": ">" }, { "key": "maybeOperand", - "value": "", - "description": null + "description": null, + "value": ">" }, { "key": "operandOrColor", - "value": "", - "description": null + "description": null, + "value": "red" }, { "key": "maybeOperandOrColor", - "value": "", - "description": null + "description": null, + "value": "red" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/query-list?operand=%3E&maybeOperand=%3E&operandOrColor=red&maybeOperandOrColor=red", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "query-list" + ], + "query": [ + { + "key": "operand", + "description": null, + "value": ">" + }, + { + "key": "maybeOperand", + "description": null, + "value": ">" + }, + { + "key": "operandOrColor", + "description": null, + "value": "red" + }, + { + "key": "maybeOperandOrColor", + "description": null, + "value": "red" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/error-property/collection.json b/seed/postman/error-property/collection.json index a681a02e9da..87da4b97b56 100644 --- a/seed/postman/error-property/collection.json +++ b/seed/postman/error-property/collection.json @@ -34,12 +34,83 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET request that always throws an error", + "url": { + "raw": "{{baseUrl}}/property-based-error", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "property-based-error" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + }, + { + "name": "Property Based Error Test", + "status": "Property Based Error Test", + "code": 400, + "originalRequest": { + "description": "GET request that always throws an error", + "url": { + "raw": "{{baseUrl}}/property-based-error", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "property-based-error" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/examples/collection.json b/seed/postman/examples/collection.json index bca48e7ba5c..e7fb1e81479 100644 --- a/seed/postman/examples/collection.json +++ b/seed/postman/examples/collection.json @@ -117,6 +117,46 @@ "description": null, "body": "{\n \"type\": \"generic\",\n \"exceptionType\": \"Unavailable\",\n \"exceptionMessage\": \"This component is unavailable!\",\n \"exceptionStacktrace\": \"\"\n}", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/file/notification/:notificationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "file", + "notification", + ":notificationId" + ], + "query": [], + "variable": [ + { + "key": "notificationId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"type\": \"generic\",\n \"exceptionType\": \"Unavailable\",\n \"exceptionMessage\": \"This component is unavailable!\",\n \"exceptionStacktrace\": \"\"\n}", + "_postman_previewlanguage": "json" } ] } @@ -214,6 +254,96 @@ "description": null, "body": "\"A file with that name was not found!\"", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "This endpoint returns a file by its name.", + "url": { + "raw": "{{baseUrl}}/file/:filename", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "file", + ":filename" + ], + "query": [], + "variable": [ + { + "key": "filename", + "description": "This is a filename", + "value": "string" + } + ] + }, + "header": [ + { + "key": "X-File-API-Version", + "description": null, + "type": "text", + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"name\": \"file.txt\",\n \"contents\": \"...\"\n}", + "_postman_previewlanguage": "json" + }, + { + "name": "Not Found Error", + "status": "Not Found Error", + "code": 404, + "originalRequest": { + "description": "This endpoint returns a file by its name.", + "url": { + "raw": "{{baseUrl}}/file/:filename", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "file", + ":filename" + ], + "query": [], + "variable": [ + { + "key": "filename", + "description": "This is a filename", + "value": "string" + } + ] + }, + "header": [ + { + "key": "X-File-API-Version", + "description": null, + "type": "text", + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" } ] } @@ -343,6 +473,84 @@ "description": null, "body": "", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "This endpoint checks the health of a resource.", + "url": { + "raw": "{{baseUrl}}/check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "check", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": "The id to check", + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "This endpoint checks the health of a resource.", + "url": { + "raw": "{{baseUrl}}/check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "check", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": "The id to check", + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" } ] }, @@ -374,6 +582,38 @@ "body": null }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "This endpoint checks the health of the service.", + "url": { + "raw": "{{baseUrl}}/ping", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ping" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -452,6 +692,45 @@ "body": null }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie/:movieId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie", + ":movieId" + ], + "query": [], + "variable": [ + { + "key": "movieId", + "description": null, + "value": "movie-c06a4ad7" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"id\": \"movie-c06a4ad7\",\n \"prequel\": \"movie-cv9b914f\",\n \"title\": \"The Boy and the Heron\",\n \"from\": \"Hayao Miyazaki\",\n \"rating\": 8,\n \"type\": \"movie\",\n \"tag\": \"tag-wf9as23d\",\n \"metadata\": {\n \"actors\": [\n \"Christian Bale\",\n \"Florence Pugh\",\n \"Willem Dafoe\"\n ],\n \"releaseDate\": \"2023-12-08\",\n \"ratings\": {\n \"rottenTomatoes\": 97,\n \"imdb\": 7.6\n }\n }\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -529,6 +808,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"movie-c06a4ad7\",\n \"prequel\": \"movie-cv9b914f\",\n \"title\": \"The Boy and the Heron\",\n \"from\": \"Hayao Miyazaki\",\n \"rating\": 8,\n \"type\": \"movie\",\n \"tag\": \"tag-wf9as23d\",\n \"metadata\": {\n \"actors\": [\n \"Christian Bale\",\n \"Florence Pugh\",\n \"Willem Dafoe\"\n ],\n \"releaseDate\": \"2023-12-08\",\n \"ratings\": {\n \"rottenTomatoes\": 97,\n \"imdb\": 7.6\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"movie-c06a4ad7\"", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -664,6 +983,55 @@ "description": null, "body": "{\n \"type\": \"html\",\n \"extra\": {\n \"version\": \"0.0.1\",\n \"tenancy\": \"test\"\n },\n \"tags\": [\n \"development\",\n \"public\"\n ],\n \"value\": \"...\"\n}", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/metadata?shallow=true&tag=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "metadata" + ], + "query": [ + { + "key": "shallow", + "description": null, + "value": "true" + }, + { + "key": "tag", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "key": "X-API-Version", + "description": null, + "type": "text", + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"type\": \"html\",\n \"extra\": {\n \"version\": \"0.0.1\",\n \"tenancy\": \"test\"\n },\n \"tags\": [\n \"development\",\n \"public\"\n ],\n \"value\": \"...\"\n}", + "_postman_previewlanguage": "json" } ] }, @@ -695,6 +1063,38 @@ "body": null }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/response", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "response" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"response\": \"Initializing...\",\n \"identifiers\": [\n {\n \"type\": \"primitive\",\n \"value\": \"example\",\n \"label\": \"Primitive\"\n },\n {\n \"type\": \"unknown\",\n \"value\": \"{}\",\n \"label\": \"Unknown\"\n }\n ]\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -765,6 +1165,44 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"Hello world!\\\\n\\\\nwith\\\\n\\\\tnewlines\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"Hello world!\\\\n\\\\nwith\\\\n\\\\tnewlines\"", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/exhaustive/.mock/definition/types/object.yml b/seed/postman/exhaustive/.mock/definition/types/object.yml index ca4844a583a..a165ed94cfe 100644 --- a/seed/postman/exhaustive/.mock/definition/types/object.yml +++ b/seed/postman/exhaustive/.mock/definition/types/object.yml @@ -1,7 +1,9 @@ types: ObjectWithOptionalField: #generic object that supports any type, makes it easier to use when testing properties: - string: optional + string: + type: optional + docs: This is a rather long descriptor of this single field in a more complex type. If you ask me I think this is a pretty good description for this field all things considered. integer: optional long: optional double: optional diff --git a/seed/postman/exhaustive/collection.json b/seed/postman/exhaustive/collection.json index 3511056007b..f4e23e103a7 100644 --- a/seed/postman/exhaustive/collection.json +++ b/seed/postman/exhaustive/collection.json @@ -54,12 +54,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n \"example\"\n]", + "raw": "[\n \"string\"\n]", "options": { "raw": { "language": "json" @@ -67,7 +73,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/list-of-primitives", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "list-of-primitives" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n \"string\"\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n \"string\"\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -86,12 +134,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n {\n \"string\": \"example\"\n }\n]", + "raw": "[\n {\n \"string\": \"string\"\n }\n]", "options": { "raw": { "language": "json" @@ -99,7 +153,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/list-of-objects", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "list-of-objects" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n {\n \"string\": \"string\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n {\n \"string\": \"string\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -118,12 +214,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n \"example\"\n]", + "raw": "[\n \"string\"\n]", "options": { "raw": { "language": "json" @@ -131,7 +233,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/set-of-primitives", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "set-of-primitives" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n \"string\"\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n \"string\"\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -150,12 +294,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n {\n \"string\": \"example\"\n }\n]", + "raw": "[\n {\n \"string\": \"string\"\n }\n]", "options": { "raw": { "language": "json" @@ -163,7 +313,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/set-of-objects", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "set-of-objects" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n {\n \"string\": \"string\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n {\n \"string\": \"string\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -182,12 +374,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"example\": \"example\"\n}", + "raw": "{\n \"string\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -195,7 +393,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/map-prim-to-prim", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "map-prim-to-prim" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -214,12 +454,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"example\": {\n \"string\": \"example\"\n }\n}", + "raw": "{\n \"string\": {\n \"string\": \"string\"\n }\n}", "options": { "raw": { "language": "json" @@ -227,7 +473,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/map-prim-to-object", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "map-prim-to-object" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": {\n \"string\": \"string\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": {\n \"string\": \"string\"\n }\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -246,12 +534,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\"\n}", + "raw": "{\n \"string\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -259,7 +553,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/container/opt-objects", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "container", + "opt-objects" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -284,7 +620,13 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { @@ -297,7 +639,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/enum", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "enum" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"SUNNY\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"SUNNY\"", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -324,17 +707,63 @@ "variable": [ { "key": "id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/http-methods/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "http-methods", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -352,12 +781,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\"\n}", + "raw": "{\n \"string\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -365,7 +800,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/http-methods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "http-methods" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -385,17 +861,23 @@ "variable": [ { "key": "id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\"\n}", + "raw": "{\n \"string\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -403,7 +885,55 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/http-methods/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "http-methods", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -423,17 +953,23 @@ "variable": [ { "key": "id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PATCH", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\",\n \"integer\": 0,\n \"long\": 10000000,\n \"double\": 0,\n \"bool\": true,\n \"datetime\": \"1994-11-05T13:15:30Z\",\n \"date\": \"1994-11-05\",\n \"uuid\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"base64\": \"SGVsbG8gV29ybGQ=\",\n \"list\": [\n \"example\"\n ],\n \"set\": [\n \"example\"\n ],\n \"map\": {\n \"0\": \"example\"\n },\n \"bigint\": \"example\"\n}", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", "options": { "raw": { "language": "json" @@ -441,7 +977,55 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/http-methods/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "http-methods", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -461,17 +1045,63 @@ "variable": [ { "key": "id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/http-methods/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "http-methods", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null, + "body": null + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -497,12 +1127,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\",\n \"integer\": 0,\n \"long\": 10000000,\n \"double\": 0,\n \"bool\": true,\n \"datetime\": \"1994-11-05T13:15:30Z\",\n \"date\": \"1994-11-05\",\n \"uuid\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"base64\": \"SGVsbG8gV29ybGQ=\",\n \"list\": [\n \"example\"\n ],\n \"set\": [\n \"example\"\n ],\n \"map\": {\n \"0\": \"example\"\n },\n \"bigint\": \"example\"\n}", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", "options": { "raw": { "language": "json" @@ -510,7 +1146,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/object/get-and-return-with-optional-field", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "object", + "get-and-return-with-optional-field" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -529,12 +1207,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\"\n}", + "raw": "{\n \"string\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -542,7 +1226,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/object/get-and-return-with-required-field", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "object", + "get-and-return-with-required-field" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -561,12 +1287,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"map\": {\n \"example\": {\n \"example\": \"example\"\n }\n }\n}", + "raw": "{\n \"map\": {\n \"string\": {\n \"string\": \"string\"\n }\n }\n}", "options": { "raw": { "language": "json" @@ -574,7 +1306,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/object/get-and-return-with-map-of-map", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "object", + "get-and-return-with-map-of-map" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"map\": {\n \"string\": {\n \"string\": \"string\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"map\": {\n \"string\": {\n \"string\": \"string\"\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -593,12 +1367,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\",\n \"NestedObject\": {\n \"string\": \"example\",\n \"integer\": 0,\n \"long\": 10000000,\n \"double\": 0,\n \"bool\": true,\n \"datetime\": \"1994-11-05T13:15:30Z\",\n \"date\": \"1994-11-05\",\n \"uuid\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"base64\": \"SGVsbG8gV29ybGQ=\",\n \"list\": [\n \"example\"\n ],\n \"set\": [\n \"example\"\n ],\n \"map\": {\n \"0\": \"example\"\n },\n \"bigint\": \"example\"\n }\n}", + "raw": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", "options": { "raw": { "language": "json" @@ -606,7 +1386,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/object/get-and-return-nested-with-optional-field", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "object", + "get-and-return-nested-with-optional-field" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -627,17 +1449,23 @@ "variable": [ { "key": "string", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\",\n \"NestedObject\": {\n \"string\": \"example\",\n \"integer\": 0,\n \"long\": 10000000,\n \"double\": 0,\n \"bool\": true,\n \"datetime\": \"1994-11-05T13:15:30Z\",\n \"date\": \"1994-11-05\",\n \"uuid\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"base64\": \"SGVsbG8gV29ybGQ=\",\n \"list\": [\n \"example\"\n ],\n \"set\": [\n \"example\"\n ],\n \"map\": {\n \"0\": \"example\"\n },\n \"bigint\": \"example\"\n }\n}", + "raw": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", "options": { "raw": { "language": "json" @@ -645,7 +1473,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/object/get-and-return-nested-with-required-field/:string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "object", + "get-and-return-nested-with-required-field", + ":string" + ], + "query": [], + "variable": [ + { + "key": "string", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -664,12 +1541,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n {\n \"string\": \"example\",\n \"NestedObject\": {\n \"string\": \"example\",\n \"integer\": 0,\n \"long\": 10000000,\n \"double\": 0,\n \"bool\": true,\n \"datetime\": \"1994-11-05T13:15:30Z\",\n \"date\": \"1994-11-05\",\n \"uuid\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"base64\": \"SGVsbG8gV29ybGQ=\",\n \"list\": [\n \"example\"\n ],\n \"set\": [\n \"example\"\n ],\n \"map\": {\n \"0\": \"example\"\n },\n \"bigint\": \"example\"\n }\n }\n]", + "raw": "[\n {\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n }\n]", "options": { "raw": { "language": "json" @@ -677,7 +1560,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/object/get-and-return-nested-with-required-field-list", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "object", + "get-and-return-nested-with-required-field-list" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n {\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -705,17 +1630,64 @@ "variable": [ { "key": "param", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET with path param", + "url": { + "raw": "{{baseUrl}}/params/path/:param", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "params", + "path", + ":param" + ], + "query": [], + "variable": [ + { + "key": "param", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -723,7 +1695,7 @@ "request": { "description": "GET with query param", "url": { - "raw": "{{baseUrl}}/params?query=&number=", + "raw": "{{baseUrl}}/params?query=string&number=1", "host": [ "{{baseUrl}}" ], @@ -733,23 +1705,73 @@ "query": [ { "key": "query", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "number", - "value": "", - "description": null + "description": null, + "value": "1" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET with query param", + "url": { + "raw": "{{baseUrl}}/params?query=string&number=1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "params" + ], + "query": [ + { + "key": "query", + "description": null, + "value": "string" + }, + { + "key": "number", + "description": null, + "value": "1" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -757,7 +1779,7 @@ "request": { "description": "GET with multiple of same query param", "url": { - "raw": "{{baseUrl}}/params?query=&numer=", + "raw": "{{baseUrl}}/params?query=string&numer=1", "host": [ "{{baseUrl}}" ], @@ -767,23 +1789,73 @@ "query": [ { "key": "query", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "numer", - "value": "", - "description": null + "description": null, + "value": "1" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET with multiple of same query param", + "url": { + "raw": "{{baseUrl}}/params?query=string&numer=1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "params" + ], + "query": [ + { + "key": "query", + "description": null, + "value": "string" + }, + { + "key": "numer", + "description": null, + "value": "1" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -791,7 +1863,7 @@ "request": { "description": "GET with path and query params", "url": { - "raw": "{{baseUrl}}/params/path-query/:param?query=", + "raw": "{{baseUrl}}/params/path-query/:param?query=string", "host": [ "{{baseUrl}}" ], @@ -803,24 +1875,77 @@ "query": [ { "key": "query", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [ { "key": "param", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "GET with path and query params", + "url": { + "raw": "{{baseUrl}}/params/path-query/:param?query=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "params", + "path-query", + ":param" + ], + "query": [ + { + "key": "query", + "description": null, + "value": "string" + } + ], + "variable": [ + { + "key": "param", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -841,17 +1966,23 @@ "variable": [ { "key": "param", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -859,7 +1990,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "PUT to update with path param", + "url": { + "raw": "{{baseUrl}}/params/path/:param", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "params", + "path", + ":param" + ], + "query": [], + "variable": [ + { + "key": "param", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -885,12 +2065,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -898,7 +2084,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "string" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -917,12 +2145,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "0", + "raw": "1", "options": { "raw": { "language": "json" @@ -930,7 +2164,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/integer", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "integer" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "1", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "1", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -949,12 +2225,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "10000000", + "raw": "1000000", "options": { "raw": { "language": "json" @@ -962,7 +2244,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/long", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "long" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "1000000", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "1000000", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -981,12 +2305,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "0", + "raw": "1.1", "options": { "raw": { "language": "json" @@ -994,7 +2324,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/double", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "double" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "1.1", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "1.1", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1013,7 +2385,13 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { @@ -1026,7 +2404,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/boolean", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "boolean" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "true", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1045,12 +2465,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"1994-11-05T13:15:30Z\"", + "raw": "\"2024-01-15T09:30:00Z\"", "options": { "raw": { "language": "json" @@ -1058,7 +2484,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/datetime", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "datetime" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"2024-01-15T09:30:00Z\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"2024-01-15T09:30:00Z\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1077,12 +2545,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"1994-11-05\"", + "raw": "\"2023-01-15\"", "options": { "raw": { "language": "json" @@ -1090,7 +2564,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/date", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "date" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"2023-01-15\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"2023-01-15\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1109,12 +2625,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"3d20db99-b2d9-4643-8f04-13452707b8e8\"", + "raw": "\"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"", "options": { "raw": { "language": "json" @@ -1122,7 +2644,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/uuid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "uuid" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1141,12 +2705,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"SGVsbG8gV29ybGQ=\"", + "raw": "\"SGVsbG8gd29ybGQh\"", "options": { "raw": { "language": "json" @@ -1154,7 +2724,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/primitive/base64", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "primitive", + "base64" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"SGVsbG8gd29ybGQh\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"SGVsbG8gd29ybGQh\"", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1179,12 +2791,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"animal\": \"dog\",\n \"name\": \"example\",\n \"likesToWoof\": true\n}", + "raw": "{\n \"animal\": \"dog\",\n \"name\": \"string\",\n \"likesToWoof\": true\n}", "options": { "raw": { "language": "json" @@ -1192,7 +2810,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/union", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "union" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"animal\": \"dog\",\n \"name\": \"string\",\n \"likesToWoof\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"animal\": \"dog\",\n \"name\": \"string\",\n \"likesToWoof\": true\n}", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -1220,12 +2879,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"string\": \"example\",\n \"integer\": 0,\n \"NestedObject\": {\n \"string\": \"example\",\n \"integer\": 0,\n \"long\": 10000000,\n \"double\": 0,\n \"bool\": true,\n \"datetime\": \"1994-11-05T13:15:30Z\",\n \"date\": \"1994-11-05\",\n \"uuid\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"base64\": \"SGVsbG8gV29ybGQ=\",\n \"list\": [\n \"example\"\n ],\n \"set\": [\n \"example\"\n ],\n \"map\": {\n \"0\": \"example\"\n },\n \"bigint\": \"example\"\n }\n}", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", "options": { "raw": { "language": "json" @@ -1233,7 +2898,90 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "POST with custom object in request body, response is an object", + "url": { + "raw": "{{baseUrl}}/req-bodies/object", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "req-bodies", + "object" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "_postman_previewlanguage": "json" + }, + { + "name": "Bad Request Body", + "status": "Bad Request Body", + "code": 400, + "originalRequest": { + "description": "POST with custom object in request body, response is an object", + "url": { + "raw": "{{baseUrl}}/req-bodies/object", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "req-bodies", + "object" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"NestedObject\": {\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1258,12 +3006,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"UNKNOWN\"", + "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" @@ -1271,7 +3025,88 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "POST request with no auth", + "url": { + "raw": "{{baseUrl}}/no-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "no-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + }, + { + "name": "Bad Request Body", + "status": "Bad Request Body", + "code": 400, + "originalRequest": { + "description": "POST request with no auth", + "url": { + "raw": "{{baseUrl}}/no-auth", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "no-auth" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1296,12 +3131,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/no-req-body", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "no-req-body" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"string\": \"string\",\n \"integer\": 1,\n \"long\": 1000000,\n \"double\": 1.1,\n \"bool\": true,\n \"datetime\": \"2024-01-15T09:30:00Z\",\n \"date\": \"2023-01-15\",\n \"uuid\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"base64\": \"SGVsbG8gd29ybGQh\",\n \"list\": [\n \"string\"\n ],\n \"set\": [\n \"string\"\n ],\n \"map\": {\n \"1\": \"string\"\n },\n \"bigint\": \"123456789123456789\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1319,12 +3193,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/no-req-body", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "no-req-body" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1355,20 +3268,25 @@ "key": "X-TEST-SERVICE-HEADER", "description": null, "type": "text", - "value": "\"example\"" + "value": "\"string\"" }, { "key": "X-TEST-ENDPOINT-HEADER", "description": null, "type": "text", - "value": "\"example\"" + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -1376,7 +3294,61 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/test-headers/custom-header", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "test-headers", + "custom-header" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-TEST-SERVICE-HEADER", + "description": null, + "type": "text", + "value": "\"string\"" + }, + { + "key": "X-TEST-ENDPOINT-HEADER", + "description": null, + "type": "text", + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/extends/collection.json b/seed/postman/extends/collection.json index 3c2bb87efec..49db6d0b630 100644 --- a/seed/postman/extends/collection.json +++ b/seed/postman/extends/collection.json @@ -30,12 +30,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"unique\": \"example\",\n \"docs\": \"This is an example type.\",\n \"name\": \"Example\"\n}", + "raw": "{\n \"unique\": \"string\",\n \"name\": \"string\",\n \"docs\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -43,7 +49,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/extends/extended-inline-request-body", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "extends", + "extended-inline-request-body" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"unique\": \"string\",\n \"name\": \"string\",\n \"docs\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/extra-properties/collection.json b/seed/postman/extra-properties/collection.json new file mode 100644 index 00000000000..ec2d45a1895 --- /dev/null +++ b/seed/postman/extra-properties/collection.json @@ -0,0 +1,102 @@ +{ + "info": { + "name": "Extra Properties", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + } + ], + "auth": null, + "item": [ + { + "_type": "container", + "description": null, + "name": "User", + "item": [ + { + "_type": "endpoint", + "name": "Create User", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/user", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "user" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"_type\": \"CreateUserRequest\",\n \"_version\": \"v1\",\n \"name\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/user", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "user" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"_type\": \"CreateUserRequest\",\n \"_version\": \"v1\",\n \"name\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"name\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/file-download/collection.json b/seed/postman/file-download/collection.json index 959da0ac4a6..8c6f0e07475 100644 --- a/seed/postman/file-download/collection.json +++ b/seed/postman/file-download/collection.json @@ -32,12 +32,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "\"SGVsbG8gd29ybGQh\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/file-upload/collection.json b/seed/postman/file-upload/collection.json index b6b570ea50f..f32f5902f66 100644 --- a/seed/postman/file-upload/collection.json +++ b/seed/postman/file-upload/collection.json @@ -32,20 +32,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, - "body": { - "mode": "raw", - "raw": "{\n \"maybeString\": \"example\",\n \"integer\": 0,\n \"maybeInteger\": 0,\n \"optionalListOfStrings\": [\n \"example\"\n ],\n \"listOfObjects\": [\n {\n \"foo\": \"example\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - } + "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -63,20 +92,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, - "body": { - "mode": "raw", - "raw": "{}", - "options": { - "raw": { - "language": "json" - } - } - } + "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/just-file", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "just-file" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -84,7 +144,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/just-file-with-query-params?maybeString=&integer=&maybeInteger=&listOfStrings=&optionalListOfStrings=", + "raw": "{{baseUrl}}/just-file-with-query-params?maybeString=string&integer=1&maybeInteger=1&listOfStrings=string&optionalListOfStrings=string", "host": [ "{{baseUrl}}" ], @@ -94,46 +154,103 @@ "query": [ { "key": "maybeString", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "integer", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "maybeInteger", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "listOfStrings", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "optionalListOfStrings", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, - "body": { - "mode": "raw", - "raw": "{}", - "options": { - "raw": { - "language": "json" - } - } - } + "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/just-file-with-query-params?maybeString=string&integer=1&maybeInteger=1&listOfStrings=string&optionalListOfStrings=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "just-file-with-query-params" + ], + "query": [ + { + "key": "maybeString", + "description": null, + "value": "string" + }, + { + "key": "integer", + "description": null, + "value": "1" + }, + { + "key": "maybeInteger", + "description": null, + "value": "1" + }, + { + "key": "listOfStrings", + "description": null, + "value": "string" + }, + { + "key": "optionalListOfStrings", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/folders/collection.json b/seed/postman/folders/collection.json index 9410ca89046..d0d5538347a 100644 --- a/seed/postman/folders/collection.json +++ b/seed/postman/folders/collection.json @@ -37,12 +37,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -65,12 +102,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -102,12 +176,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/service", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "service" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -125,12 +238,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"UNKNOWN\"", + "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" @@ -138,7 +257,88 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/service", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "service" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Not Found Error", + "status": "Not Found Error", + "code": 404, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/service", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "service" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -156,12 +356,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -179,12 +416,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/grpc-proto-exhaustive/collection.json b/seed/postman/grpc-proto-exhaustive/collection.json index 855fb77a3d4..d5914b8243c 100644 --- a/seed/postman/grpc-proto-exhaustive/collection.json +++ b/seed/postman/grpc-proto-exhaustive/collection.json @@ -54,6 +54,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"columns\": [\n {\n \"id\": \"id\",\n \"values\": [\n 1.1\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "OK", + "body": "{\n \"count\": 1\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -133,6 +173,47 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data/delete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data", + "delete" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "OK", + "body": "{}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -213,6 +294,47 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data/describe", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data", + "describe" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "OK", + "body": "{\n \"namespaces\": {\n \"key\": {\n \"count\": 1\n }\n },\n \"dimension\": 1,\n \"fullness\": 1.1,\n \"totalCount\": 1\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -317,6 +439,50 @@ "description": "OK", "body": "{\n \"columns\": {\n \"key\": {\n \"id\": \"id\",\n \"values\": [\n 1.1\n ],\n \"metadata\": {\n \"key\": 1.1\n },\n \"indexedData\": {\n \"indices\": [\n 1\n ],\n \"values\": [\n 1.1\n ]\n }\n }\n },\n \"namespace\": \"namespace\",\n \"usage\": {\n \"units\": 1\n }\n}", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data/fetch?ids=string&namespace=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data", + "fetch" + ], + "query": [ + { + "key": "ids", + "description": null, + "value": "string" + }, + { + "key": "namespace", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": "OK", + "body": "{\n \"columns\": {\n \"key\": {\n \"id\": \"id\",\n \"values\": [\n 1.1\n ],\n \"metadata\": {\n \"key\": 1.1\n },\n \"indexedData\": {\n \"indices\": [\n 1\n ],\n \"values\": [\n 1.1\n ]\n }\n }\n },\n \"namespace\": \"namespace\",\n \"usage\": {\n \"units\": 1\n }\n}", + "_postman_previewlanguage": "json" } ] }, @@ -381,6 +547,60 @@ "description": "OK", "body": "{\n \"columns\": [\n {\n \"id\": \"id\"\n }\n ],\n \"pagination\": {\n \"next\": \"next\"\n },\n \"namespace\": \"namespace\",\n \"usage\": {\n \"units\": 1\n }\n}", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data/list?prefix=string&limit=1&paginationToken=string&namespace=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data", + "list" + ], + "query": [ + { + "key": "prefix", + "description": null, + "value": "string" + }, + { + "key": "limit", + "description": null, + "value": "1" + }, + { + "key": "paginationToken", + "description": null, + "value": "string" + }, + { + "key": "namespace", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": "OK", + "body": "{\n \"columns\": [\n {\n \"id\": \"id\"\n }\n ],\n \"pagination\": {\n \"next\": \"next\"\n },\n \"namespace\": \"namespace\",\n \"usage\": {\n \"units\": 1\n }\n}", + "_postman_previewlanguage": "json" } ] }, @@ -421,6 +641,47 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data/query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data", + "query" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"topK\": 1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "OK", + "body": "{\n \"results\": [\n {\n \"matches\": [\n {\n \"id\": \"id\"\n }\n ],\n \"namespace\": \"namespace\"\n }\n ],\n \"matches\": [\n {\n \"id\": \"id\",\n \"score\": 1.1,\n \"values\": [\n 1.1\n ],\n \"metadata\": {\n \"key\": 1.1\n },\n \"indexedData\": {\n \"indices\": [\n 1\n ],\n \"values\": [\n 1.1\n ]\n }\n }\n ],\n \"namespace\": \"namespace\",\n \"usage\": {\n \"units\": 1\n }\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -501,6 +762,47 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/data/update", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "data", + "update" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"id\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "OK", + "body": "{}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/grpc-proto/collection.json b/seed/postman/grpc-proto/collection.json index 90c007f2b59..97353a799fd 100644 --- a/seed/postman/grpc-proto/collection.json +++ b/seed/postman/grpc-proto/collection.json @@ -54,6 +54,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "OK", + "body": "{\n \"user\": {\n \"username\": \"username\",\n \"email\": \"email\",\n \"age\": 1,\n \"weight\": 1.1,\n \"metadata\": {\n \"key\": 1.1\n }\n }\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/grpc/.mock/definition/api.yml b/seed/postman/grpc/.mock/definition/api.yml new file mode 100644 index 00000000000..15a9f823724 --- /dev/null +++ b/seed/postman/grpc/.mock/definition/api.yml @@ -0,0 +1,4 @@ +name: api + +error-discrimination: + strategy: status-code \ No newline at end of file diff --git a/seed/postman/grpc/.mock/definition/user.yml b/seed/postman/grpc/.mock/definition/user.yml new file mode 100644 index 00000000000..80223300afc --- /dev/null +++ b/seed/postman/grpc/.mock/definition/user.yml @@ -0,0 +1,61 @@ +types: + Metadata: + type: map> + encoding: + proto: + type: google.protobuf.Struct + + MetadataValue: + discriminated: false + union: + - double + - string + - boolean + - list + encoding: + proto: + type: google.protobuf.Value + + User: + properties: + id: string + username: string + email: optional + age: optional + weight: optional + metadata: optional + + CreateUserResponse: + properties: + user: User + +service: + auth: false + base-path: / + transport: + grpc: + service-name: UserService + endpoints: + createUser: + method: POST + path: /users + request: + name: CreateUserRequest + body: + properties: + username: string + email: optional + age: optional + weight: optional + response: CreateUserResponse + + getUser: + method: GET + path: /users + request: + name: GetUserRequest + query-parameters: + username: optional + age: optional + weight: optional + response: User diff --git a/seed/postman/grpc/.mock/fern.config.json b/seed/postman/grpc/.mock/fern.config.json new file mode 100644 index 00000000000..4c8e54ac313 --- /dev/null +++ b/seed/postman/grpc/.mock/fern.config.json @@ -0,0 +1 @@ +{"organization": "fern-test", "version": "*"} \ No newline at end of file diff --git a/seed/postman/grpc/.mock/generators.yml b/seed/postman/grpc/.mock/generators.yml new file mode 100644 index 00000000000..9e26dfeeb6e --- /dev/null +++ b/seed/postman/grpc/.mock/generators.yml @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/seed/postman/grpc/collection.json b/seed/postman/grpc/collection.json new file mode 100644 index 00000000000..2a33fd4493e --- /dev/null +++ b/seed/postman/grpc/collection.json @@ -0,0 +1,196 @@ +{ + "info": { + "name": "Api", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + } + ], + "auth": null, + "item": [ + { + "_type": "container", + "description": null, + "name": "User", + "item": [ + { + "_type": "endpoint", + "name": "Create User", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"username\": \"string\",\n \"email\": \"string\",\n \"age\": 1,\n \"weight\": 1.1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"username\": \"string\",\n \"email\": \"string\",\n \"age\": 1,\n \"weight\": 1.1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"user\": {\n \"id\": \"string\",\n \"username\": \"string\",\n \"email\": \"string\",\n \"age\": 1,\n \"weight\": 1.1,\n \"metadata\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] + }, + { + "_type": "endpoint", + "name": "Get User", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?username=string&age=1&weight=1.1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "username", + "description": null, + "value": "string" + }, + { + "key": "age", + "description": null, + "value": "1" + }, + { + "key": "weight", + "description": null, + "value": "1.1" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?username=string&age=1&weight=1.1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "username", + "description": null, + "value": "string" + }, + { + "key": "age", + "description": null, + "value": "1" + }, + { + "key": "weight", + "description": null, + "value": "1.1" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"username\": \"string\",\n \"email\": \"string\",\n \"age\": 1,\n \"weight\": 1.1,\n \"metadata\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/grpc/snippet-templates.json b/seed/postman/grpc/snippet-templates.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/grpc/snippet.json b/seed/postman/grpc/snippet.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/idempotency-headers/collection.json b/seed/postman/idempotency-headers/collection.json index e03b785c606..7deebf88ea1 100644 --- a/seed/postman/idempotency-headers/collection.json +++ b/seed/postman/idempotency-headers/collection.json @@ -48,12 +48,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"amount\": 0,\n \"currency\": \"USD\"\n}", + "raw": "{\n \"amount\": 1,\n \"currency\": \"USD\"\n}", "options": { "raw": { "language": "json" @@ -61,7 +67,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/payment", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payment" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"amount\": 1,\n \"currency\": \"USD\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -81,17 +128,63 @@ "variable": [ { "key": "paymentId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/payment/:paymentId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payment", + ":paymentId" + ], + "query": [], + "variable": [ + { + "key": "paymentId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/imdb/collection.json b/seed/postman/imdb/collection.json index e44e55b4757..f5327978bb5 100644 --- a/seed/postman/imdb/collection.json +++ b/seed/postman/imdb/collection.json @@ -49,12 +49,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"title\": \"example\",\n \"rating\": 0\n}", + "raw": "{\n \"title\": \"string\",\n \"rating\": 1.1\n}", "options": { "raw": { "language": "json" @@ -62,7 +68,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Add a movie to the database", + "url": { + "raw": "{{baseUrl}}/movies/create-movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movies", + "create-movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"string\",\n \"rating\": 1.1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -82,17 +130,102 @@ "variable": [ { "key": "movieId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movies/:movieId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movies", + ":movieId" + ], + "query": [], + "variable": [ + { + "key": "movieId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"title\": \"string\",\n \"rating\": 1.1\n}", + "_postman_previewlanguage": "json" + }, + { + "name": "Movie Does Not Exist Error", + "status": "Movie Does Not Exist Error", + "code": 404, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movies/:movieId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movies", + ":movieId" + ], + "query": [], + "variable": [ + { + "key": "movieId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/literal/collection.json b/seed/postman/literal/collection.json index 57db15cbd6d..9f087239519 100644 --- a/seed/postman/literal/collection.json +++ b/seed/postman/literal/collection.json @@ -66,6 +66,58 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/headers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "headers" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "X-Endpoint-Version", + "description": null, + "type": "text", + "value": "\"02-12-2024\"" + }, + { + "key": "X-Async", + "description": null, + "type": "text", + "value": "true" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"What is the weather today\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"message\": \"The weather is sunny\",\n \"status\": 200,\n \"success\": true\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -163,6 +215,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/inlined", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "inlined" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"temperature\": 10.1,\n \"prompt\": \"You are a helpful assistant\",\n \"context\": \"You're super wise\",\n \"aliasedContext\": \"You're super wise\",\n \"maybeContext\": \"You're super wise\",\n \"stream\": false,\n \"query\": \"What is the weather today\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"message\": \"The weather is sunny\",\n \"status\": 200,\n \"success\": true\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -247,6 +339,45 @@ "body": null }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/path/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "path", + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": null, + "value": "123" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"message\": \"The weather is sunny\",\n \"status\": 200,\n \"success\": true\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", @@ -386,6 +517,54 @@ "description": null, "body": "{\n \"message\": \"The weather is sunny\",\n \"status\": 200,\n \"success\": true\n}", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/query?prompt=You+are+a+helpful+assistant&query=string&stream=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "query" + ], + "query": [ + { + "key": "prompt", + "description": null, + "value": "You are a helpful assistant" + }, + { + "key": "query", + "description": null, + "value": "string" + }, + { + "key": "stream", + "description": null, + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"message\": \"The weather is sunny\",\n \"status\": 200,\n \"success\": true\n}", + "_postman_previewlanguage": "json" } ] } @@ -432,6 +611,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/reference", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "reference" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"prompt\": \"You are a helpful assistant\",\n \"stream\": false,\n \"context\": \"You're super wise\",\n \"query\": \"What is the weather today\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"message\": \"The weather is sunny\",\n \"status\": 200,\n \"success\": true\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/mixed-case/collection.json b/seed/postman/mixed-case/collection.json index 6be87fb37d1..155b38c0405 100644 --- a/seed/postman/mixed-case/collection.json +++ b/seed/postman/mixed-case/collection.json @@ -91,6 +91,45 @@ "description": null, "body": "{\n \"resource_type\": \"user\",\n \"userName\": \"username\",\n \"metadata_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"EXTRA_PROPERTIES\": {\n \"foo\": \"bar\",\n \"baz\": \"qux\"\n }\n}", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/resource/:ResourceID", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resource", + ":ResourceID" + ], + "query": [], + "variable": [ + { + "key": "ResourceID", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"resource_type\": \"user\",\n \"userName\": \"username\",\n \"metadata_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"EXTRA_PROPERTIES\": {\n \"foo\": \"bar\",\n \"baz\": \"qux\"\n }\n}", + "_postman_previewlanguage": "json" } ] }, @@ -175,6 +214,49 @@ "description": null, "body": "[\n {\n \"resource_type\": \"user\",\n \"userName\": \"username\",\n \"metadata_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"EXTRA_PROPERTIES\": {\n \"foo\": \"bar\",\n \"baz\": \"qux\"\n }\n }\n]", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/resource?page_limit=1&beforeDate=2023-01-15", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resource" + ], + "query": [ + { + "key": "page_limit", + "description": null, + "value": "1" + }, + { + "key": "beforeDate", + "description": null, + "value": "2023-01-15" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"resource_type\": \"user\",\n \"userName\": \"username\",\n \"metadata_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"EXTRA_PROPERTIES\": {\n \"foo\": \"bar\",\n \"baz\": \"qux\"\n }\n }\n]", + "_postman_previewlanguage": "json" } ] } diff --git a/seed/postman/multi-line-docs/collection.json b/seed/postman/multi-line-docs/collection.json index c39be99a6a7..416c5d4e529 100644 --- a/seed/postman/multi-line-docs/collection.json +++ b/seed/postman/multi-line-docs/collection.json @@ -36,17 +36,63 @@ "variable": [ { "key": "userId", - "value": "", - "description": "The ID of the user to retrieve.\nThis ID is unique to each user." + "description": "The ID of the user to retrieve.\nThis ID is unique to each user.", + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Retrieve a user.\nThis endpoint is used to retrieve a user.", + "url": { + "raw": "{{baseUrl}}/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users", + ":userId" + ], + "query": [], + "variable": [ + { + "key": "userId", + "description": "The ID of the user to retrieve.\nThis ID is unique to each user.", + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -64,12 +110,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"name\": \"example\",\n \"age\": 0\n}", + "raw": "{\n \"name\": \"string\",\n \"age\": 1\n}", "options": { "raw": { "language": "json" @@ -77,7 +129,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Create a new user.\nThis endpoint is used to create a new user.", + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\",\n \"age\": 1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"age\": 1\n}", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/multi-url-environment-no-default/collection.json b/seed/postman/multi-url-environment-no-default/collection.json index 4e3e5dbd27e..994ffd9f85d 100644 --- a/seed/postman/multi-url-environment-no-default/collection.json +++ b/seed/postman/multi-url-environment-no-default/collection.json @@ -49,12 +49,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"size\": \"example\"\n}", + "raw": "{\n \"size\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -62,7 +68,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/ec2/boot", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ec2", + "boot" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"size\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -88,12 +136,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"s3Key\": \"example\"\n}", + "raw": "{\n \"s3Key\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -101,7 +155,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/s3/presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "s3", + "presigned-url" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"s3Key\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/multi-url-environment/collection.json b/seed/postman/multi-url-environment/collection.json index 6525f84fe9d..a4dc1134f69 100644 --- a/seed/postman/multi-url-environment/collection.json +++ b/seed/postman/multi-url-environment/collection.json @@ -49,12 +49,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"size\": \"example\"\n}", + "raw": "{\n \"size\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -62,7 +68,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/ec2/boot", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ec2", + "boot" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"size\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -88,12 +136,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"s3Key\": \"example\"\n}", + "raw": "{\n \"s3Key\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -101,7 +155,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/s3/presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "s3", + "presigned-url" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"s3Key\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/no-environment/collection.json b/seed/postman/no-environment/collection.json index fe580f9dbeb..c58bea109e6 100644 --- a/seed/postman/no-environment/collection.json +++ b/seed/postman/no-environment/collection.json @@ -48,12 +48,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/dummy", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dummy" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/oauth-client-credentials-default/collection.json b/seed/postman/oauth-client-credentials-default/collection.json new file mode 100644 index 00000000000..fc0c0692ff9 --- /dev/null +++ b/seed/postman/oauth-client-credentials-default/collection.json @@ -0,0 +1,116 @@ +{ + "info": { + "name": "Oauth Client Credentials Default", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + }, + { + "key": "token", + "value": "", + "type": "string" + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{token}}", + "type": "string" + } + ] + }, + "item": [ + { + "_type": "container", + "description": null, + "name": "Auth", + "item": [ + { + "_type": "endpoint", + "name": "Get Token", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"grant_type\": \"client_credentials\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"grant_type\": \"client_credentials\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/oauth-client-credentials-environment-variables/collection.json b/seed/postman/oauth-client-credentials-environment-variables/collection.json new file mode 100644 index 00000000000..14e47a7873c --- /dev/null +++ b/seed/postman/oauth-client-credentials-environment-variables/collection.json @@ -0,0 +1,194 @@ +{ + "info": { + "name": "Oauth Client Credentials Environment Variables", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + }, + { + "key": "token", + "value": "", + "type": "string" + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{token}}", + "type": "string" + } + ] + }, + "item": [ + { + "_type": "container", + "description": null, + "name": "Auth", + "item": [ + { + "_type": "endpoint", + "name": "Get Token With Client Credentials", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1,\n \"refresh_token\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + }, + { + "_type": "endpoint", + "name": "Refresh Token", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"refresh_token\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"refresh_token\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"refresh_token\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"refresh_token\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1,\n \"refresh_token\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/oauth-client-credentials-nested-root/collection.json b/seed/postman/oauth-client-credentials-nested-root/collection.json new file mode 100644 index 00000000000..6a41db90eb8 --- /dev/null +++ b/seed/postman/oauth-client-credentials-nested-root/collection.json @@ -0,0 +1,116 @@ +{ + "info": { + "name": "Oauth Client Credentials", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + }, + { + "key": "token", + "value": "", + "type": "string" + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{token}}", + "type": "string" + } + ] + }, + "item": [ + { + "_type": "container", + "description": null, + "name": "Auth", + "item": [ + { + "_type": "endpoint", + "name": "Get Token", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1,\n \"refresh_token\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/oauth-client-credentials/collection.json b/seed/postman/oauth-client-credentials/collection.json new file mode 100644 index 00000000000..fa2e8f77abe --- /dev/null +++ b/seed/postman/oauth-client-credentials/collection.json @@ -0,0 +1,194 @@ +{ + "info": { + "name": "Oauth Client Credentials", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + }, + { + "key": "token", + "value": "", + "type": "string" + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{token}}", + "type": "string" + } + ] + }, + "item": [ + { + "_type": "container", + "description": null, + "name": "Auth", + "item": [ + { + "_type": "endpoint", + "name": "Get Token With Client Credentials", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"client_credentials\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1,\n \"refresh_token\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + }, + { + "_type": "endpoint", + "name": "Refresh Token", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"refresh_token\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"refresh_token\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "token" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"refresh_token\": \"string\",\n \"audience\": \"https://api.example.com\",\n \"grant_type\": \"refresh_token\",\n \"scope\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 1,\n \"refresh_token\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/optional/collection.json b/seed/postman/optional/collection.json index 2debebda780..662269bafac 100644 --- a/seed/postman/optional/collection.json +++ b/seed/postman/optional/collection.json @@ -34,12 +34,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"example\": \"UNKNOWN\"\n}", + "raw": "{\n \"string\": {\n \"key\": \"value\"\n }\n}", "options": { "raw": { "language": "json" @@ -47,7 +53,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/send-optional-body", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "send-optional-body" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"string\": {\n \"key\": \"value\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": "Id of the created resource", + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/package-yml/collection.json b/seed/postman/package-yml/collection.json index 25fb344627e..ce0ae9c6e73 100644 --- a/seed/postman/package-yml/collection.json +++ b/seed/postman/package-yml/collection.json @@ -89,6 +89,44 @@ "description": null, "body": "", "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/:nestedId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":nestedId" + ], + "query": [], + "variable": [ + { + "key": "nestedId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" } ] } @@ -128,6 +166,44 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Hello world!\",\n \"size\": 20\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"Hello world!\"", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/pagination/collection.json b/seed/postman/pagination/collection.json index 2ae7e14dd78..d9b34291019 100644 --- a/seed/postman/pagination/collection.json +++ b/seed/postman/pagination/collection.json @@ -38,7 +38,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?page=&per_page=&order=&starting_after=", + "raw": "{{baseUrl}}/users?page=1&per_page=1&order=asc&starting_after=string", "host": [ "{{baseUrl}}" ], @@ -48,33 +48,93 @@ "query": [ { "key": "page", - "value": "", - "description": "Defaults to first page" + "description": "Defaults to first page", + "value": "1" }, { "key": "per_page", - "value": "", - "description": "Defaults to per page" + "description": "Defaults to per page", + "value": "1" }, { "key": "order", - "value": "", - "description": null + "description": null, + "value": "asc" }, { "key": "starting_after", - "value": "", - "description": "The cursor used for pagination in order to fetch\nthe next page of results." + "description": "The cursor used for pagination in order to fetch\nthe next page of results.", + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?page=1&per_page=1&order=asc&starting_after=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "page", + "description": "Defaults to first page", + "value": "1" + }, + { + "key": "per_page", + "description": "Defaults to per page", + "value": "1" + }, + { + "key": "order", + "description": null, + "value": "asc" + }, + { + "key": "starting_after", + "description": "The cursor used for pagination in order to fetch\nthe next page of results.", + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"hasNextPage\": true,\n \"page\": {\n \"page\": 1,\n \"next\": {\n \"page\": 1,\n \"starting_after\": \"string\"\n },\n \"per_page\": 1,\n \"total_page\": 1\n },\n \"total_count\": 1,\n \"data\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -92,12 +152,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"pagination\": {\n \"cursor\": \"example\"\n }\n}", + "raw": "{\n \"pagination\": {\n \"cursor\": \"string\"\n }\n}", "options": { "raw": { "language": "json" @@ -105,7 +171,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"pagination\": {\n \"cursor\": \"string\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"hasNextPage\": true,\n \"page\": {\n \"page\": 1,\n \"next\": {\n \"page\": 1,\n \"starting_after\": \"string\"\n },\n \"per_page\": 1,\n \"total_page\": 1\n },\n \"total_count\": 1,\n \"data\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -113,7 +220,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?page=&per_page=&order=&starting_after=", + "raw": "{{baseUrl}}/users?page=1&per_page=1&order=asc&starting_after=string", "host": [ "{{baseUrl}}" ], @@ -123,33 +230,93 @@ "query": [ { "key": "page", - "value": "", - "description": "Defaults to first page" + "description": "Defaults to first page", + "value": "1" }, { "key": "per_page", - "value": "", - "description": "Defaults to per page" + "description": "Defaults to per page", + "value": "1" }, { "key": "order", - "value": "", - "description": null + "description": null, + "value": "asc" }, { "key": "starting_after", - "value": "", - "description": "The cursor used for pagination in order to fetch\nthe next page of results." + "description": "The cursor used for pagination in order to fetch\nthe next page of results.", + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?page=1&per_page=1&order=asc&starting_after=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "page", + "description": "Defaults to first page", + "value": "1" + }, + { + "key": "per_page", + "description": "Defaults to per page", + "value": "1" + }, + { + "key": "order", + "description": null, + "value": "asc" + }, + { + "key": "starting_after", + "description": "The cursor used for pagination in order to fetch\nthe next page of results.", + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"hasNextPage\": true,\n \"page\": {\n \"page\": 1,\n \"next\": {\n \"page\": 1,\n \"starting_after\": \"string\"\n },\n \"per_page\": 1,\n \"total_page\": 1\n },\n \"total_count\": 1,\n \"data\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -167,12 +334,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"pagination\": {\n \"page\": 0\n }\n}", + "raw": "{\n \"pagination\": {\n \"page\": 1\n }\n}", "options": { "raw": { "language": "json" @@ -180,7 +353,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"pagination\": {\n \"page\": 1\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"hasNextPage\": true,\n \"page\": {\n \"page\": 1,\n \"next\": {\n \"page\": 1,\n \"starting_after\": \"string\"\n },\n \"per_page\": 1,\n \"total_page\": 1\n },\n \"total_count\": 1,\n \"data\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -188,7 +402,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?page=&limit=&order=", + "raw": "{{baseUrl}}/users?page=1&limit=1&order=asc", "host": [ "{{baseUrl}}" ], @@ -198,28 +412,83 @@ "query": [ { "key": "page", - "value": "", - "description": "Defaults to first page" + "description": "Defaults to first page", + "value": "1" }, { "key": "limit", - "value": "", - "description": "The maxiumum number of elements to return.\nThis is also used as the step size in this\npaginated endpoint." + "description": "The maxiumum number of elements to return.\nThis is also used as the step size in this\npaginated endpoint.", + "value": "1" }, { "key": "order", - "value": "", - "description": null + "description": null, + "value": "asc" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?page=1&limit=1&order=asc", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "page", + "description": "Defaults to first page", + "value": "1" + }, + { + "key": "limit", + "description": "The maxiumum number of elements to return.\nThis is also used as the step size in this\npaginated endpoint.", + "value": "1" + }, + { + "key": "order", + "description": null, + "value": "asc" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"hasNextPage\": true,\n \"page\": {\n \"page\": 1,\n \"next\": {\n \"page\": 1,\n \"starting_after\": \"string\"\n },\n \"per_page\": 1,\n \"total_page\": 1\n },\n \"total_count\": 1,\n \"data\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -227,7 +496,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?page=&limit=&order=", + "raw": "{{baseUrl}}/users?page=1&limit=1&order=asc", "host": [ "{{baseUrl}}" ], @@ -237,28 +506,83 @@ "query": [ { "key": "page", - "value": "", - "description": "Defaults to first page" + "description": "Defaults to first page", + "value": "1" }, { "key": "limit", - "value": "", - "description": "The maxiumum number of elements to return.\nThis is also used as the step size in this\npaginated endpoint." + "description": "The maxiumum number of elements to return.\nThis is also used as the step size in this\npaginated endpoint.", + "value": "1" }, { "key": "order", - "value": "", - "description": null + "description": null, + "value": "asc" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?page=1&limit=1&order=asc", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "page", + "description": "Defaults to first page", + "value": "1" + }, + { + "key": "limit", + "description": "The maxiumum number of elements to return.\nThis is also used as the step size in this\npaginated endpoint.", + "value": "1" + }, + { + "key": "order", + "description": null, + "value": "asc" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"hasNextPage\": true,\n \"page\": {\n \"page\": 1,\n \"next\": {\n \"page\": 1,\n \"starting_after\": \"string\"\n },\n \"per_page\": 1,\n \"total_page\": 1\n },\n \"total_count\": 1,\n \"data\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -266,7 +590,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?cursor=", + "raw": "{{baseUrl}}/users?cursor=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "host": [ "{{baseUrl}}" ], @@ -276,18 +600,63 @@ "query": [ { "key": "cursor", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?cursor=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "cursor", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"total_count\": 1,\n \"data\": {\n \"users\": [\n {\n \"name\": \"string\",\n \"id\": 1\n }\n ]\n },\n \"next\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -295,7 +664,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?starting_after=", + "raw": "{{baseUrl}}/users?starting_after=string", "host": [ "{{baseUrl}}" ], @@ -305,18 +674,63 @@ "query": [ { "key": "starting_after", - "value": "", - "description": "The cursor used for pagination in order to fetch\nthe next page of results." + "description": "The cursor used for pagination in order to fetch\nthe next page of results.", + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?starting_after=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "starting_after", + "description": "The cursor used for pagination in order to fetch\nthe next page of results.", + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"cursor\": {\n \"after\": \"string\",\n \"data\": [\n \"string\"\n ]\n }\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -324,7 +738,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/users?offset=", + "raw": "{{baseUrl}}/users?offset=1", "host": [ "{{baseUrl}}" ], @@ -334,18 +748,63 @@ "query": [ { "key": "offset", - "value": "", - "description": null + "description": null, + "value": "1" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users?offset=1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users" + ], + "query": [ + { + "key": "offset", + "description": null, + "value": "1" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"results\": [\n \"string\"\n ]\n}", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/plain-text/collection.json b/seed/postman/plain-text/collection.json index f9e28ecd3b0..b0961788058 100644 --- a/seed/postman/plain-text/collection.json +++ b/seed/postman/plain-text/collection.json @@ -34,12 +34,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/text", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "text" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/query-parameters/collection.json b/seed/postman/query-parameters/collection.json index f5ec6ae02d2..41303fecd70 100644 --- a/seed/postman/query-parameters/collection.json +++ b/seed/postman/query-parameters/collection.json @@ -24,7 +24,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}/user?limit=&id=&date=&deadline=&bytes=&user=&userList=&optionalDeadline=&keyValue=&optionalString=&nestedUser=&optionalUser=&excludeUser=&filter=", + "raw": "{{baseUrl}}/user?limit=1&id=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32&date=2023-01-15&deadline=2024-01-15T09%3A30%3A00Z&bytes=SGVsbG8gd29ybGQh&user=%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D&userList=%5B%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D%5D&optionalDeadline=2024-01-15T09%3A30%3A00Z&keyValue=%7B%22string%22%3A%22string%22%7D&optionalString=string&nestedUser=%7B%22name%22%3A%22string%22%2C%22user%22%3A%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D%7D&optionalUser=%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D&excludeUser=%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D&filter=string", "host": [ "{{baseUrl}}" ], @@ -34,83 +34,193 @@ "query": [ { "key": "limit", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "id", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "key": "date", - "value": "", - "description": null + "description": null, + "value": "2023-01-15" }, { "key": "deadline", - "value": "", - "description": null + "description": null, + "value": "2024-01-15T09:30:00Z" }, { "key": "bytes", - "value": "", - "description": null + "description": null, + "value": "SGVsbG8gd29ybGQh" }, { "key": "user", - "value": "", - "description": null + "description": null, + "value": "{\"name\":\"string\",\"tags\":[\"string\"]}" }, { "key": "userList", - "value": "", - "description": null + "description": null, + "value": "[{\"name\":\"string\",\"tags\":[\"string\"]}]" }, { "key": "optionalDeadline", - "value": "", - "description": null + "description": null, + "value": "2024-01-15T09:30:00Z" }, { "key": "keyValue", - "value": "", - "description": null + "description": null, + "value": "{\"string\":\"string\"}" }, { "key": "optionalString", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "nestedUser", - "value": "", - "description": null + "description": null, + "value": "{\"name\":\"string\",\"user\":{\"name\":\"string\",\"tags\":[\"string\"]}}" }, { "key": "optionalUser", - "value": "", - "description": null + "description": null, + "value": "{\"name\":\"string\",\"tags\":[\"string\"]}" }, { "key": "excludeUser", - "value": "", - "description": null + "description": null, + "value": "{\"name\":\"string\",\"tags\":[\"string\"]}" }, { "key": "filter", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/user?limit=1&id=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32&date=2023-01-15&deadline=2024-01-15T09%3A30%3A00Z&bytes=SGVsbG8gd29ybGQh&user=%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D&userList=%5B%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D%5D&optionalDeadline=2024-01-15T09%3A30%3A00Z&keyValue=%7B%22string%22%3A%22string%22%7D&optionalString=string&nestedUser=%7B%22name%22%3A%22string%22%2C%22user%22%3A%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D%7D&optionalUser=%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D&excludeUser=%7B%22name%22%3A%22string%22%2C%22tags%22%3A%5B%22string%22%5D%7D&filter=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "user" + ], + "query": [ + { + "key": "limit", + "description": null, + "value": "1" + }, + { + "key": "id", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + }, + { + "key": "date", + "description": null, + "value": "2023-01-15" + }, + { + "key": "deadline", + "description": null, + "value": "2024-01-15T09:30:00Z" + }, + { + "key": "bytes", + "description": null, + "value": "SGVsbG8gd29ybGQh" + }, + { + "key": "user", + "description": null, + "value": "{\"name\":\"string\",\"tags\":[\"string\"]}" + }, + { + "key": "userList", + "description": null, + "value": "[{\"name\":\"string\",\"tags\":[\"string\"]}]" + }, + { + "key": "optionalDeadline", + "description": null, + "value": "2024-01-15T09:30:00Z" + }, + { + "key": "keyValue", + "description": null, + "value": "{\"string\":\"string\"}" + }, + { + "key": "optionalString", + "description": null, + "value": "string" + }, + { + "key": "nestedUser", + "description": null, + "value": "{\"name\":\"string\",\"user\":{\"name\":\"string\",\"tags\":[\"string\"]}}" + }, + { + "key": "optionalUser", + "description": null, + "value": "{\"name\":\"string\",\"tags\":[\"string\"]}" + }, + { + "key": "excludeUser", + "description": null, + "value": "{\"name\":\"string\",\"tags\":[\"string\"]}" + }, + { + "key": "filter", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"name\": \"string\",\n \"tags\": [\n \"string\"\n ]\n}", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/reserved-keywords/collection.json b/seed/postman/reserved-keywords/collection.json index dab1f436f7e..ab704642898 100644 --- a/seed/postman/reserved-keywords/collection.json +++ b/seed/postman/reserved-keywords/collection.json @@ -24,7 +24,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}?for=", + "raw": "{{baseUrl}}?for=string", "host": [ "{{baseUrl}}" ], @@ -32,18 +32,61 @@ "query": [ { "key": "for", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}?for=string", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [ + { + "key": "for", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/response-property/collection.json b/seed/postman/response-property/collection.json index 40c9ee3b5e1..ac912dc30a2 100644 --- a/seed/postman/response-property/collection.json +++ b/seed/postman/response-property/collection.json @@ -34,12 +34,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -47,7 +53,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -65,12 +112,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -78,7 +131,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -96,12 +190,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -109,7 +209,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -127,12 +268,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -140,7 +287,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"string\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -158,12 +346,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -171,7 +365,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -189,12 +424,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -202,7 +443,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -220,12 +502,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -233,7 +521,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/movie", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "movie" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/seed.yml b/seed/postman/seed.yml index 085c326e1fd..8a35398c7d6 100644 --- a/seed/postman/seed.yml +++ b/seed/postman/seed.yml @@ -1,4 +1,4 @@ -irVersion: v23 +irVersion: v53 docker: fernapi/fern-postman:latest dockerCommand: pnpm --filter @fern-api/postman-generator dockerTagLatest generatorType: Documentation diff --git a/seed/postman/simple-fhir/collection.json b/seed/postman/simple-fhir/collection.json index c00ec7409ff..0092581f9fa 100644 --- a/seed/postman/simple-fhir/collection.json +++ b/seed/postman/simple-fhir/collection.json @@ -31,17 +31,63 @@ "variable": [ { "key": "account_id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/account/:account_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "account", + ":account_id" + ], + "query": [], + "variable": [ + { + "key": "account_id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"resource_type\": \"Account\",\n \"name\": \"string\",\n \"patient\": {\n \"resource_type\": \"Patient\",\n \"name\": \"string\",\n \"scripts\": [\n {\n \"key\": \"value\"\n }\n ],\n \"id\": \"string\",\n \"related_resources\": [\n {\n \"key\": \"value\"\n }\n ],\n \"memo\": {\n \"description\": \"string\",\n \"account\": {\n \"key\": \"value\"\n }\n }\n },\n \"practitioner\": {\n \"resource_type\": \"Practitioner\",\n \"name\": \"string\",\n \"id\": \"string\",\n \"related_resources\": [\n {\n \"key\": \"value\"\n }\n ],\n \"memo\": {\n \"description\": \"string\",\n \"account\": {\n \"key\": \"value\"\n }\n }\n },\n \"id\": \"string\",\n \"related_resources\": [\n {\n \"key\": \"value\"\n }\n ],\n \"memo\": {\n \"description\": \"string\",\n \"account\": {\n \"key\": \"value\"\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/single-url-environment-default/collection.json b/seed/postman/single-url-environment-default/collection.json index 51cb14ae81a..19cd2ee5eb8 100644 --- a/seed/postman/single-url-environment-default/collection.json +++ b/seed/postman/single-url-environment-default/collection.json @@ -48,12 +48,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/dummy", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dummy" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/single-url-environment-no-default/collection.json b/seed/postman/single-url-environment-no-default/collection.json index 989c61ccbf1..d1761533a23 100644 --- a/seed/postman/single-url-environment-no-default/collection.json +++ b/seed/postman/single-url-environment-no-default/collection.json @@ -48,12 +48,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/dummy", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dummy" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/streaming-parameter/.mock/definition/api.yml b/seed/postman/streaming-parameter/.mock/definition/api.yml new file mode 100644 index 00000000000..32ff55461ef --- /dev/null +++ b/seed/postman/streaming-parameter/.mock/definition/api.yml @@ -0,0 +1,3 @@ +name: streaming +error-discrimination: + strategy: status-code diff --git a/seed/postman/streaming-parameter/.mock/definition/dummy.yml b/seed/postman/streaming-parameter/.mock/definition/dummy.yml new file mode 100644 index 00000000000..c39bf9879d0 --- /dev/null +++ b/seed/postman/streaming-parameter/.mock/definition/dummy.yml @@ -0,0 +1,35 @@ +types: + RegularResponse: + properties: + id: string + name: optional + StreamResponse: + properties: + id: string + name: optional + +service: + auth: false + base-path: "" + endpoints: + generate: + path: /generate + method: POST + stream-condition: $request.stream + request: + name: GenerateRequest + body: + properties: + stream: boolean + num_events: integer + response: RegularResponse + response-stream: StreamResponse + examples: + - name: Default + request: + stream: false + num_events: 5 + response: + body: + id: id + name: name diff --git a/seed/postman/streaming-parameter/.mock/fern.config.json b/seed/postman/streaming-parameter/.mock/fern.config.json new file mode 100644 index 00000000000..4c8e54ac313 --- /dev/null +++ b/seed/postman/streaming-parameter/.mock/fern.config.json @@ -0,0 +1 @@ +{"organization": "fern-test", "version": "*"} \ No newline at end of file diff --git a/seed/postman/streaming-parameter/.mock/generators.yml b/seed/postman/streaming-parameter/.mock/generators.yml new file mode 100644 index 00000000000..0967ef424bc --- /dev/null +++ b/seed/postman/streaming-parameter/.mock/generators.yml @@ -0,0 +1 @@ +{} diff --git a/seed/postman/streaming-parameter/collection.json b/seed/postman/streaming-parameter/collection.json new file mode 100644 index 00000000000..01d4165b852 --- /dev/null +++ b/seed/postman/streaming-parameter/collection.json @@ -0,0 +1,142 @@ +{ + "info": { + "name": "Streaming", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + } + ], + "auth": null, + "item": [ + { + "_type": "container", + "description": null, + "name": "Dummy", + "item": [ + { + "_type": "endpoint", + "name": "Generate", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/generate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generate" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"stream\": false,\n \"num_events\": 5\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/generate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generate" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"stream\": false,\n \"num_events\": 5\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"id\": \"id\",\n \"name\": \"name\"\n}", + "_postman_previewlanguage": "json" + }, + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/generate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generate" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"stream\": false,\n \"num_events\": 5\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"id\": \"id\",\n \"name\": \"name\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/streaming-parameter/snippet-templates.json b/seed/postman/streaming-parameter/snippet-templates.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/streaming-parameter/snippet.json b/seed/postman/streaming-parameter/snippet.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/streaming/collection.json b/seed/postman/streaming/collection.json index 35e7da3ef3b..c7cf8a49de7 100644 --- a/seed/postman/streaming/collection.json +++ b/seed/postman/streaming/collection.json @@ -34,12 +34,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"stream\": true,\n \"num_events\": 0\n}", + "raw": "{\n \"stream\": true,\n \"num_events\": 1\n}", "options": { "raw": { "language": "json" @@ -47,7 +53,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/generate-stream", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generate-stream" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"stream\": true,\n \"num_events\": 1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -85,6 +132,46 @@ } }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/generate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generate" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"stream\": false,\n \"num_events\": 5\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"id\": \"id\",\n \"name\": \"name\"\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/trace/collection.json b/seed/postman/trace/collection.json index 38e5b878a95..e050172f4c4 100644 --- a/seed/postman/trace/collection.json +++ b/seed/postman/trace/collection.json @@ -54,12 +54,52 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns lightweight versions of all problems", + "url": { + "raw": "{{baseUrl}}/problems-v2/lightweight-problem-info", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "lightweight-problem-info" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"problemId\": \"string\",\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"variableTypes\": [\n {\n \"type\": \"integerType\"\n }\n ]\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -78,12 +118,52 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns latest versions of all problems", + "url": { + "raw": "{{baseUrl}}/problems-v2/problem-info", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "problem-info" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"problemId\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"supportedLanguages\": [\n \"JAVA\"\n ],\n \"customFiles\": {\n \"type\": \"basic\"\n },\n \"generatedFiles\": {\n \"generatedTestCaseFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"generatedTemplateFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"other\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n }\n },\n \"customTestCaseTemplates\": [\n {\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"implementation\": {\n \"description\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"key\": \"value\"\n }\n ]\n },\n \"function\": {\n \"type\": \"withActualResult\"\n }\n }\n }\n ],\n \"testcases\": [\n {\n \"metadata\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hidden\": true\n },\n \"implementation\": {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"templateId\"\n },\n \"arguments\": {\n \"string\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n }\n },\n \"expects\": {\n \"expectedStdout\": {\n \"key\": \"value\"\n }\n }\n }\n ],\n \"isPublic\": true\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -104,17 +184,64 @@ "variable": [ { "key": "problemId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns latest version of a problem", + "url": { + "raw": "{{baseUrl}}/problems-v2/problem-info/:problemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "problem-info", + ":problemId" + ], + "query": [], + "variable": [ + { + "key": "problemId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"problemId\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"supportedLanguages\": [\n \"JAVA\"\n ],\n \"customFiles\": {\n \"type\": \"basic\"\n },\n \"generatedFiles\": {\n \"generatedTestCaseFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"generatedTemplateFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"other\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n }\n },\n \"customTestCaseTemplates\": [\n {\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"implementation\": {\n \"description\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"key\": \"value\"\n }\n ]\n },\n \"function\": {\n \"type\": \"withActualResult\"\n }\n }\n }\n ],\n \"testcases\": [\n {\n \"metadata\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hidden\": true\n },\n \"implementation\": {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"templateId\"\n },\n \"arguments\": {\n \"string\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n }\n },\n \"expects\": {\n \"expectedStdout\": {\n \"key\": \"value\"\n }\n }\n }\n ],\n \"isPublic\": true\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -137,22 +264,76 @@ "variable": [ { "key": "problemId", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "problemVersion", - "value": "", - "description": null + "description": null, + "value": "1" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns requested version of a problem", + "url": { + "raw": "{{baseUrl}}/problems-v2/problem-info/:problemId/version/:problemVersion", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "problem-info", + ":problemId", + "version", + ":problemVersion" + ], + "query": [], + "variable": [ + { + "key": "problemId", + "description": null, + "value": "string" + }, + { + "key": "problemVersion", + "description": null, + "value": "1" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"problemId\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"supportedLanguages\": [\n \"JAVA\"\n ],\n \"customFiles\": {\n \"type\": \"basic\"\n },\n \"generatedFiles\": {\n \"generatedTestCaseFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"generatedTemplateFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"other\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n }\n },\n \"customTestCaseTemplates\": [\n {\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"implementation\": {\n \"description\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"key\": \"value\"\n }\n ]\n },\n \"function\": {\n \"type\": \"withActualResult\"\n }\n }\n }\n ],\n \"testcases\": [\n {\n \"metadata\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hidden\": true\n },\n \"implementation\": {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"templateId\"\n },\n \"arguments\": {\n \"string\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n }\n },\n \"expects\": {\n \"expectedStdout\": {\n \"key\": \"value\"\n }\n }\n }\n ],\n \"isPublic\": true\n}", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -183,12 +364,52 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns lightweight versions of all problems", + "url": { + "raw": "{{baseUrl}}/problems-v2/lightweight-problem-info", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "lightweight-problem-info" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"problemId\": \"string\",\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"variableTypes\": [\n {\n \"type\": \"integerType\"\n }\n ]\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -207,12 +428,52 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns latest versions of all problems", + "url": { + "raw": "{{baseUrl}}/problems-v2/problem-info", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "problem-info" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"problemId\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"supportedLanguages\": [\n \"JAVA\"\n ],\n \"customFiles\": {\n \"type\": \"basic\"\n },\n \"generatedFiles\": {\n \"generatedTestCaseFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"generatedTemplateFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"other\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n }\n },\n \"customTestCaseTemplates\": [\n {\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"implementation\": {\n \"description\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"key\": \"value\"\n }\n ]\n },\n \"function\": {\n \"type\": \"withActualResult\"\n }\n }\n }\n ],\n \"testcases\": [\n {\n \"metadata\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hidden\": true\n },\n \"implementation\": {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"templateId\"\n },\n \"arguments\": {\n \"string\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n }\n },\n \"expects\": {\n \"expectedStdout\": {\n \"key\": \"value\"\n }\n }\n }\n ],\n \"isPublic\": true\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -233,17 +494,64 @@ "variable": [ { "key": "problemId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns latest version of a problem", + "url": { + "raw": "{{baseUrl}}/problems-v2/problem-info/:problemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "problem-info", + ":problemId" + ], + "query": [], + "variable": [ + { + "key": "problemId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"problemId\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"supportedLanguages\": [\n \"JAVA\"\n ],\n \"customFiles\": {\n \"type\": \"basic\"\n },\n \"generatedFiles\": {\n \"generatedTestCaseFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"generatedTemplateFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"other\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n }\n },\n \"customTestCaseTemplates\": [\n {\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"implementation\": {\n \"description\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"key\": \"value\"\n }\n ]\n },\n \"function\": {\n \"type\": \"withActualResult\"\n }\n }\n }\n ],\n \"testcases\": [\n {\n \"metadata\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hidden\": true\n },\n \"implementation\": {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"templateId\"\n },\n \"arguments\": {\n \"string\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n }\n },\n \"expects\": {\n \"expectedStdout\": {\n \"key\": \"value\"\n }\n }\n }\n ],\n \"isPublic\": true\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -266,22 +574,76 @@ "variable": [ { "key": "problemId", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "problemVersion", - "value": "", - "description": null + "description": null, + "value": "1" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns requested version of a problem", + "url": { + "raw": "{{baseUrl}}/problems-v2/problem-info/:problemId/version/:problemVersion", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problems-v2", + "problem-info", + ":problemId", + "version", + ":problemVersion" + ], + "query": [], + "variable": [ + { + "key": "problemId", + "description": null, + "value": "string" + }, + { + "key": "problemVersion", + "description": null, + "value": "1" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"problemId\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"problemName\": \"string\",\n \"problemVersion\": 1,\n \"supportedLanguages\": [\n \"JAVA\"\n ],\n \"customFiles\": {\n \"type\": \"basic\"\n },\n \"generatedFiles\": {\n \"generatedTestCaseFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"generatedTemplateFiles\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n },\n \"other\": {\n \"string\": {\n \"files\": [\n {\n \"key\": \"value\"\n }\n ]\n }\n }\n },\n \"customTestCaseTemplates\": [\n {\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"implementation\": {\n \"description\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"key\": \"value\"\n }\n ]\n },\n \"function\": {\n \"type\": \"withActualResult\"\n }\n }\n }\n ],\n \"testcases\": [\n {\n \"metadata\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hidden\": true\n },\n \"implementation\": {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"templateId\"\n },\n \"arguments\": {\n \"string\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n }\n },\n \"expects\": {\n \"expectedStdout\": {\n \"key\": \"value\"\n }\n }\n }\n ],\n \"isPublic\": true\n}", + "_postman_previewlanguage": "json" + } + ] } ] } @@ -301,12 +663,49 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -334,12 +733,18 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { @@ -352,7 +757,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-test-submission-status/:submissionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-test-submission-status", + ":submissionId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"stopped\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -373,17 +827,23 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"updateTime\": \"1994-11-05T13:15:30Z\",\n \"updateInfo\": {\n \"type\": \"running\",\n \"value\": \"QUEUEING_SUBMISSION\"\n }\n}", + "raw": "{\n \"updateTime\": \"2024-01-15T09:30:00Z\",\n \"updateInfo\": {\n \"0\": \"Q\",\n \"1\": \"U\",\n \"2\": \"E\",\n \"3\": \"U\",\n \"4\": \"E\",\n \"5\": \"I\",\n \"6\": \"N\",\n \"7\": \"G\",\n \"8\": \"_\",\n \"9\": \"S\",\n \"10\": \"U\",\n \"11\": \"B\",\n \"12\": \"M\",\n \"13\": \"I\",\n \"14\": \"S\",\n \"15\": \"S\",\n \"16\": \"I\",\n \"17\": \"O\",\n \"18\": \"N\",\n \"type\": \"running\"\n }\n}", "options": { "raw": { "language": "json" @@ -391,7 +851,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-test-submission-status-v2/:submissionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-test-submission-status-v2", + ":submissionId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"updateTime\": \"2024-01-15T09:30:00Z\",\n \"updateInfo\": {\n \"0\": \"Q\",\n \"1\": \"U\",\n \"2\": \"E\",\n \"3\": \"U\",\n \"4\": \"E\",\n \"5\": \"I\",\n \"6\": \"N\",\n \"7\": \"G\",\n \"8\": \"_\",\n \"9\": \"S\",\n \"10\": \"U\",\n \"11\": \"B\",\n \"12\": \"M\",\n \"13\": \"I\",\n \"14\": \"S\",\n \"15\": \"S\",\n \"16\": \"I\",\n \"17\": \"O\",\n \"18\": \"N\",\n \"type\": \"running\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -412,12 +921,18 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { @@ -430,7 +945,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-workspace-submission-status/:submissionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-workspace-submission-status", + ":submissionId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"stopped\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -451,17 +1015,23 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"updateTime\": \"1994-11-05T13:15:30Z\",\n \"updateInfo\": {\n \"type\": \"running\",\n \"value\": \"QUEUEING_SUBMISSION\"\n }\n}", + "raw": "{\n \"updateTime\": \"2024-01-15T09:30:00Z\",\n \"updateInfo\": {\n \"0\": \"Q\",\n \"1\": \"U\",\n \"2\": \"E\",\n \"3\": \"U\",\n \"4\": \"E\",\n \"5\": \"I\",\n \"6\": \"N\",\n \"7\": \"G\",\n \"8\": \"_\",\n \"9\": \"S\",\n \"10\": \"U\",\n \"11\": \"B\",\n \"12\": \"M\",\n \"13\": \"I\",\n \"14\": \"S\",\n \"15\": \"S\",\n \"16\": \"I\",\n \"17\": \"O\",\n \"18\": \"N\",\n \"type\": \"running\"\n }\n}", "options": { "raw": { "language": "json" @@ -469,7 +1039,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-workspace-submission-status-v2/:submissionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-workspace-submission-status-v2", + ":submissionId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"updateTime\": \"2024-01-15T09:30:00Z\",\n \"updateInfo\": {\n \"0\": \"Q\",\n \"1\": \"U\",\n \"2\": \"E\",\n \"3\": \"U\",\n \"4\": \"E\",\n \"5\": \"I\",\n \"6\": \"N\",\n \"7\": \"G\",\n \"8\": \"_\",\n \"9\": \"S\",\n \"10\": \"U\",\n \"11\": \"B\",\n \"12\": \"M\",\n \"13\": \"I\",\n \"14\": \"S\",\n \"15\": \"S\",\n \"16\": \"I\",\n \"17\": \"O\",\n \"18\": \"N\",\n \"type\": \"running\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -493,22 +1112,28 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "key": "testCaseId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"result\": {\n \"result\": {\n \"expectedResult\": {\n \"type\": \"integerValue\",\n \"value\": 0\n },\n \"actualResult\": {\n \"type\": \"value\"\n },\n \"passed\": true\n },\n \"stdout\": \"example\"\n },\n \"traceResponses\": [\n {\n \"submissionId\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"lineNumber\": 0,\n \"returnValue\": {\n \"type\": \"integerValue\",\n \"value\": 0\n },\n \"expressionLocation\": {\n \"start\": 0,\n \"offset\": 0\n },\n \"stack\": {\n \"numStackFrames\": 0,\n \"topStackFrame\": {\n \"methodName\": \"example\",\n \"lineNumber\": 0,\n \"scopes\": [\n {\n \"variables\": {}\n }\n ]\n }\n },\n \"stdout\": \"example\"\n }\n ]\n}", + "raw": "{\n \"result\": {\n \"result\": {\n \"expectedResult\": {\n \"type\": \"integerValue\"\n },\n \"actualResult\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n },\n \"passed\": true\n },\n \"stdout\": \"string\"\n },\n \"traceResponses\": [\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -516,22 +1141,79 @@ } } }, - "response": [] - }, - { - "_type": "endpoint", - "name": "Store Traced Test Case V 2", - "request": { - "description": null, - "url": { - "raw": "{{baseUrl}}/admin/store-test-trace-v2/submission/:submissionId/testCase/:testCaseId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "store-test-trace-v2", - "submission", + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-test-trace/submission/:submissionId/testCase/:testCaseId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-test-trace", + "submission", + ":submissionId", + "testCase", + ":testCaseId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + }, + { + "key": "testCaseId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"result\": {\n \"result\": {\n \"expectedResult\": {\n \"type\": \"integerValue\"\n },\n \"actualResult\": {\n \"type\": \"integerValue\",\n \"key\": \"value\"\n },\n \"passed\": true\n },\n \"stdout\": \"string\"\n },\n \"traceResponses\": [\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] + }, + { + "_type": "endpoint", + "name": "Store Traced Test Case V 2", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-test-trace-v2/submission/:submissionId/testCase/:testCaseId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-test-trace-v2", + "submission", ":submissionId", "testCase", ":testCaseId" @@ -540,22 +1222,28 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "key": "testCaseId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n {\n \"submissionId\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"lineNumber\": 0,\n \"file\": {\n \"filename\": \"example\",\n \"directory\": \"example\"\n },\n \"returnValue\": {\n \"type\": \"integerValue\",\n \"value\": 0\n },\n \"expressionLocation\": {\n \"start\": 0,\n \"offset\": 0\n },\n \"stack\": {\n \"numStackFrames\": 0,\n \"topStackFrame\": {\n \"methodName\": \"example\",\n \"lineNumber\": 0,\n \"scopes\": [\n {\n \"variables\": {}\n }\n ]\n }\n },\n \"stdout\": \"example\"\n }\n]", + "raw": "[\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"file\": {\n \"filename\": \"string\",\n \"directory\": \"string\"\n },\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n]", "options": { "raw": { "language": "json" @@ -563,7 +1251,64 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-test-trace-v2/submission/:submissionId/testCase/:testCaseId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-test-trace-v2", + "submission", + ":submissionId", + "testCase", + ":testCaseId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + }, + { + "key": "testCaseId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"file\": {\n \"filename\": \"string\",\n \"directory\": \"string\"\n },\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -585,17 +1330,23 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"workspaceRunDetails\": {\n \"exceptionV2\": {\n \"type\": \"generic\",\n \"exceptionType\": \"example\",\n \"exceptionMessage\": \"example\",\n \"exceptionStacktrace\": \"example\"\n },\n \"stdout\": \"example\"\n },\n \"traceResponses\": [\n {\n \"submissionId\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"lineNumber\": 0,\n \"returnValue\": {\n \"type\": \"integerValue\",\n \"value\": 0\n },\n \"expressionLocation\": {\n \"start\": 0,\n \"offset\": 0\n },\n \"stack\": {\n \"numStackFrames\": 0,\n \"topStackFrame\": {\n \"methodName\": \"example\",\n \"lineNumber\": 0,\n \"scopes\": [\n {\n \"variables\": {}\n }\n ]\n }\n },\n \"stdout\": \"example\"\n }\n ]\n}", + "raw": "{\n \"workspaceRunDetails\": {\n \"exceptionV2\": {\n \"type\": \"generic\",\n \"exceptionType\": \"string\",\n \"exceptionMessage\": \"string\",\n \"exceptionStacktrace\": \"string\"\n },\n \"exception\": {\n \"exceptionType\": \"string\",\n \"exceptionMessage\": \"string\",\n \"exceptionStacktrace\": \"string\"\n },\n \"stdout\": \"string\"\n },\n \"traceResponses\": [\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -603,7 +1354,57 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-workspace-trace/submission/:submissionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-workspace-trace", + "submission", + ":submissionId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"workspaceRunDetails\": {\n \"exceptionV2\": {\n \"type\": \"generic\",\n \"exceptionType\": \"string\",\n \"exceptionMessage\": \"string\",\n \"exceptionStacktrace\": \"string\"\n },\n \"exception\": {\n \"exceptionType\": \"string\",\n \"exceptionMessage\": \"string\",\n \"exceptionStacktrace\": \"string\"\n },\n \"stdout\": \"string\"\n },\n \"traceResponses\": [\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -625,17 +1426,23 @@ "variable": [ { "key": "submissionId", - "value": "", - "description": null + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n {\n \"submissionId\": \"3d20db99-b2d9-4643-8f04-13452707b8e8\",\n \"lineNumber\": 0,\n \"file\": {\n \"filename\": \"example\",\n \"directory\": \"example\"\n },\n \"returnValue\": {\n \"type\": \"integerValue\",\n \"value\": 0\n },\n \"expressionLocation\": {\n \"start\": 0,\n \"offset\": 0\n },\n \"stack\": {\n \"numStackFrames\": 0,\n \"topStackFrame\": {\n \"methodName\": \"example\",\n \"lineNumber\": 0,\n \"scopes\": [\n {\n \"variables\": {}\n }\n ]\n }\n },\n \"stdout\": \"example\"\n }\n]", + "raw": "[\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"file\": {\n \"filename\": \"string\",\n \"directory\": \"string\"\n },\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n]", "options": { "raw": { "language": "json" @@ -643,7 +1450,57 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/admin/store-workspace-trace-v2/submission/:submissionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "store-workspace-trace-v2", + "submission", + ":submissionId" + ], + "query": [], + "variable": [ + { + "key": "submissionId", + "description": null, + "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n {\n \"submissionId\": \"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32\",\n \"lineNumber\": 1,\n \"file\": {\n \"filename\": \"string\",\n \"directory\": \"string\"\n },\n \"returnValue\": {\n \"type\": \"integerValue\"\n },\n \"expressionLocation\": {\n \"start\": 1,\n \"offset\": 1\n },\n \"stack\": {\n \"numStackFrames\": 1,\n \"topStackFrame\": {\n \"methodName\": \"string\",\n \"lineNumber\": 1,\n \"scopes\": [\n {\n \"variables\": {\n \"string\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n },\n \"stdout\": \"string\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -668,12 +1525,51 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/homepage-problems", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "homepage-problems" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n \"string\"\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -691,12 +1587,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "[\n \"example\"\n]", + "raw": "[\n \"string\"\n]", "options": { "raw": { "language": "json" @@ -704,7 +1606,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/homepage-problems", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "homepage-problems" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "[\n \"string\"\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -735,14 +1678,59 @@ "key": "admin-key-header", "description": null, "type": "text", - "value": "\"example\"" + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" } ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/migration-info/all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "migration-info", + "all" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "admin-key-header", + "description": null, + "type": "text", + "value": "\"string\"" + }, + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"name\": \"string\",\n \"status\": \"RUNNING\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -757,7 +1745,7 @@ "request": { "description": "Create a new playlist", "url": { - "raw": "{{baseUrl}}/v2/playlist/:serviceParam/create?datetime=&optionalDatetime=", + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/create?datetime=2024-01-15T09%3A30%3A00Z&optionalDatetime=2024-01-15T09%3A30%3A00Z", "host": [ "{{baseUrl}}" ], @@ -770,29 +1758,35 @@ "query": [ { "key": "datetime", - "value": "", - "description": null + "description": null, + "value": "2024-01-15T09:30:00Z" }, { "key": "optionalDatetime", - "value": "", - "description": null + "description": null, + "value": "2024-01-15T09:30:00Z" } ], "variable": [ { "key": "serviceParam", - "value": "", - "description": null + "description": null, + "value": "1" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"name\": \"example\",\n \"problems\": [\n \"example\"\n ]\n}", + "raw": "{\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" @@ -800,7 +1794,68 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Create a new playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/create?datetime=2024-01-15T09%3A30%3A00Z&optionalDatetime=2024-01-15T09%3A30%3A00Z", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + "create" + ], + "query": [ + { + "key": "datetime", + "description": null, + "value": "2024-01-15T09:30:00Z" + }, + { + "key": "optionalDatetime", + "description": null, + "value": "2024-01-15T09:30:00Z" + } + ], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"playlist_id\": \"string\",\n \"owner-id\": \"string\",\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -808,7 +1863,7 @@ "request": { "description": "Returns the user's playlists", "url": { - "raw": "{{baseUrl}}/v2/playlist/:serviceParam/all?limit=&otherField=&multiLineDocs=&optionalMultipleField=&multipleField=", + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/all?limit=1&otherField=string&multiLineDocs=string&optionalMultipleField=string&multipleField=string", "host": [ "{{baseUrl}}" ], @@ -821,44 +1876,118 @@ "query": [ { "key": "limit", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "otherField", - "value": "", - "description": "i'm another field" + "description": "i'm another field", + "value": "string" }, { "key": "multiLineDocs", - "value": "", - "description": "I'm a multiline\ndescription" + "description": "I'm a multiline\ndescription", + "value": "string" }, { "key": "optionalMultipleField", - "value": "", - "description": null + "description": null, + "value": "string" }, { "key": "multipleField", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [ { "key": "serviceParam", - "value": "", - "description": null + "description": null, + "value": "1" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns the user's playlists", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/all?limit=1&otherField=string&multiLineDocs=string&optionalMultipleField=string&multipleField=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + "all" + ], + "query": [ + { + "key": "limit", + "description": null, + "value": "1" + }, + { + "key": "otherField", + "description": "i'm another field", + "value": "string" + }, + { + "key": "multiLineDocs", + "description": "I'm a multiline\ndescription", + "value": "string" + }, + { + "key": "optionalMultipleField", + "description": null, + "value": "string" + }, + { + "key": "multipleField", + "description": null, + "value": "string" + } + ], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "[\n {\n \"playlist_id\": \"string\",\n \"owner-id\": \"string\",\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -880,23 +2009,168 @@ "variable": [ { "key": "serviceParam", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "playlistId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] - }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns a playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/:playlistId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + ":playlistId" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + }, + { + "key": "playlistId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"playlist_id\": \"string\",\n \"owner-id\": \"string\",\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", + "_postman_previewlanguage": "json" + }, + { + "name": "Playlist Id Not Found Error", + "status": "Playlist Id Not Found Error", + "code": 404, + "originalRequest": { + "description": "Returns a playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/:playlistId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + ":playlistId" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + }, + { + "key": "playlistId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + }, + { + "name": "Unauthorized Error", + "status": "Unauthorized Error", + "code": 401, + "originalRequest": { + "description": "Returns a playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/:playlistId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + ":playlistId" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + }, + { + "key": "playlistId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] + }, { "_type": "endpoint", "name": "Update Playlist", @@ -917,22 +2191,28 @@ "variable": [ { "key": "serviceParam", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "playlistId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"name\": \"example\",\n \"problems\": [\n \"example\"\n ]\n}", + "raw": "{\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" @@ -940,7 +2220,116 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Updates a playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/:playlistId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + ":playlistId" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + }, + { + "key": "playlistId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"playlist_id\": \"string\",\n \"owner-id\": \"string\",\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", + "_postman_previewlanguage": "json" + }, + { + "name": "Playlist Id Not Found Error", + "status": "Playlist Id Not Found Error", + "code": 404, + "originalRequest": { + "description": "Updates a playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/:playlistId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + ":playlistId" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + }, + { + "key": "playlistId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\",\n \"problems\": [\n \"string\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -962,22 +2351,75 @@ "variable": [ { "key": "serviceParam", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "playlist_id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Deletes a playlist", + "url": { + "raw": "{{baseUrl}}/v2/playlist/:serviceParam/:playlist_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "playlist", + ":serviceParam", + ":playlist_id" + ], + "query": [], + "variable": [ + { + "key": "serviceParam", + "description": null, + "value": "1" + }, + { + "key": "playlist_id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1003,12 +2445,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"problemName\": \"example\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"value\": \"example\"\n }\n ]\n },\n \"files\": {\n \"JAVA\": {\n \"solutionFile\": {\n \"filename\": \"example\",\n \"contents\": \"example\"\n },\n \"readOnlyFiles\": [\n null\n ]\n }\n },\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"example\"\n }\n ],\n \"testcases\": [\n {\n \"testCase\": {\n \"id\": \"example\",\n \"params\": [\n {\n \"type\": \"integerValue\",\n \"value\": 0\n }\n ]\n }\n }\n ],\n \"methodName\": \"example\"\n}", + "raw": "{\n \"problemName\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"files\": {\n \"string\": {\n \"solutionFile\": {\n \"filename\": \"string\",\n \"contents\": \"string\"\n },\n \"readOnlyFiles\": [\n {\n \"filename\": \"string\",\n \"contents\": \"string\"\n }\n ]\n }\n },\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"string\"\n }\n ],\n \"outputType\": {\n \"type\": \"integerType\"\n },\n \"testcases\": [\n {\n \"testCase\": {\n \"id\": \"string\",\n \"params\": [\n {\n \"type\": \"integerValue\"\n }\n ]\n },\n \"expectedResult\": {\n \"type\": \"integerValue\"\n }\n }\n ],\n \"methodName\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -1016,7 +2464,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Creates a problem", + "url": { + "raw": "{{baseUrl}}/problem-crud/create", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problem-crud", + "create" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"problemName\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"files\": {\n \"string\": {\n \"solutionFile\": {\n \"filename\": \"string\",\n \"contents\": \"string\"\n },\n \"readOnlyFiles\": [\n {\n \"filename\": \"string\",\n \"contents\": \"string\"\n }\n ]\n }\n },\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"string\"\n }\n ],\n \"outputType\": {\n \"type\": \"integerType\"\n },\n \"testcases\": [\n {\n \"testCase\": {\n \"id\": \"string\",\n \"params\": [\n {\n \"type\": \"integerValue\"\n }\n ]\n },\n \"expectedResult\": {\n \"type\": \"integerValue\"\n }\n }\n ],\n \"methodName\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"success\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1037,17 +2527,23 @@ "variable": [ { "key": "problemId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"problemName\": \"example\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"type\": \"html\",\n \"value\": \"example\"\n }\n ]\n },\n \"files\": {\n \"JAVA\": {\n \"solutionFile\": {\n \"filename\": \"example\",\n \"contents\": \"example\"\n },\n \"readOnlyFiles\": [\n null\n ]\n }\n },\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"example\"\n }\n ],\n \"testcases\": [\n {\n \"testCase\": {\n \"id\": \"example\",\n \"params\": [\n {\n \"type\": \"integerValue\",\n \"value\": 0\n }\n ]\n }\n }\n ],\n \"methodName\": \"example\"\n}", + "raw": "{\n \"problemName\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"files\": {\n \"string\": {\n \"solutionFile\": {\n \"filename\": \"string\",\n \"contents\": \"string\"\n },\n \"readOnlyFiles\": [\n {\n \"filename\": \"string\",\n \"contents\": \"string\"\n }\n ]\n }\n },\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"string\"\n }\n ],\n \"outputType\": {\n \"type\": \"integerType\"\n },\n \"testcases\": [\n {\n \"testCase\": {\n \"id\": \"string\",\n \"params\": [\n {\n \"type\": \"integerValue\"\n }\n ]\n },\n \"expectedResult\": {\n \"type\": \"integerValue\"\n }\n }\n ],\n \"methodName\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -1055,7 +2551,56 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Updates a problem", + "url": { + "raw": "{{baseUrl}}/problem-crud/update/:problemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problem-crud", + "update", + ":problemId" + ], + "query": [], + "variable": [ + { + "key": "problemId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"problemName\": \"string\",\n \"problemDescription\": {\n \"boards\": [\n {\n \"0\": \"s\",\n \"1\": \"t\",\n \"2\": \"r\",\n \"3\": \"i\",\n \"4\": \"n\",\n \"5\": \"g\",\n \"type\": \"html\"\n }\n ]\n },\n \"files\": {\n \"string\": {\n \"solutionFile\": {\n \"filename\": \"string\",\n \"contents\": \"string\"\n },\n \"readOnlyFiles\": [\n {\n \"filename\": \"string\",\n \"contents\": \"string\"\n }\n ]\n }\n },\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"string\"\n }\n ],\n \"outputType\": {\n \"type\": \"integerType\"\n },\n \"testcases\": [\n {\n \"testCase\": {\n \"id\": \"string\",\n \"params\": [\n {\n \"type\": \"integerValue\"\n }\n ]\n },\n \"expectedResult\": {\n \"type\": \"integerValue\"\n }\n }\n ],\n \"methodName\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"problemVersion\": 1\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1076,17 +2621,64 @@ "variable": [ { "key": "problemId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Soft deletes a problem", + "url": { + "raw": "{{baseUrl}}/problem-crud/delete/:problemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problem-crud", + "delete", + ":problemId" + ], + "query": [], + "variable": [ + { + "key": "problemId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1105,12 +2697,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"example\"\n }\n ],\n \"methodName\": \"example\"\n}", + "raw": "{\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"string\"\n }\n ],\n \"outputType\": {\n \"type\": \"integerType\"\n },\n \"methodName\": \"string\"\n}", "options": { "raw": { "language": "json" @@ -1118,7 +2716,49 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns default starter files for problem", + "url": { + "raw": "{{baseUrl}}/problem-crud/default-starter-files", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "problem-crud", + "default-starter-files" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"inputParams\": [\n {\n \"variableType\": {\n \"type\": \"integerType\"\n },\n \"name\": \"string\"\n }\n ],\n \"outputType\": {\n \"type\": \"integerType\"\n },\n \"methodName\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"files\": {\n \"string\": {\n \"solutionFile\": {\n \"filename\": \"string\",\n \"contents\": \"string\"\n },\n \"readOnlyFiles\": [\n {\n \"filename\": \"string\",\n \"contents\": \"string\"\n }\n ]\n }\n }\n}", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1146,17 +2786,64 @@ "variable": [ { "key": "language", - "value": "", - "description": null + "description": null, + "value": "JAVA" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns sessionId and execution server URL for session. Spins up server.", + "url": { + "raw": "{{baseUrl}}/sessions/create-session/:language", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + "create-session", + ":language" + ], + "query": [], + "variable": [ + { + "key": "language", + "description": null, + "value": "JAVA" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"sessionId\": \"string\",\n \"executionSessionUrl\": \"string\",\n \"language\": \"JAVA\",\n \"status\": \"CREATING_CONTAINER\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1176,17 +2863,63 @@ "variable": [ { "key": "sessionId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Returns execution server URL for session. Returns empty if session isn't registered.", + "url": { + "raw": "{{baseUrl}}/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + ":sessionId" + ], + "query": [], + "variable": [ + { + "key": "sessionId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"sessionId\": \"string\",\n \"executionSessionUrl\": \"string\",\n \"language\": \"JAVA\",\n \"status\": \"CREATING_CONTAINER\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1207,17 +2940,64 @@ "variable": [ { "key": "sessionId", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": "Stops execution session.", + "url": { + "raw": "{{baseUrl}}/sessions/stop/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + "stop", + ":sessionId" + ], + "query": [], + "variable": [ + { + "key": "sessionId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1236,12 +3016,52 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/sessions/execution-sessions-state", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + "execution-sessions-state" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"states\": {\n \"string\": {\n \"lastTimeContacted\": \"string\",\n \"sessionId\": \"string\",\n \"isWarmInstance\": true,\n \"awsTaskId\": \"string\",\n \"language\": \"JAVA\",\n \"status\": \"CREATING_CONTAINER\"\n }\n },\n \"numWarmingInstances\": 1,\n \"warmingSessionIds\": [\n \"string\"\n ]\n}", + "_postman_previewlanguage": "json" + } + ] } ] }, @@ -1270,22 +3090,75 @@ "variable": [ { "key": "language", - "value": "", - "description": null + "description": null, + "value": "JAVA" }, { "key": "numWarmInstances", - "value": "", - "description": null + "description": null, + "value": "1" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/sysprop/num-warm-instances/:language/:numWarmInstances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sysprop", + "num-warm-instances", + ":language", + ":numWarmInstances" + ], + "query": [], + "variable": [ + { + "key": "language", + "description": null, + "value": "JAVA" + }, + { + "key": "numWarmInstances", + "description": null, + "value": "1" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -1304,12 +3177,52 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/sysprop/num-warm-instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sysprop", + "num-warm-instances" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"string\": 1\n}", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/undiscriminated-unions/collection.json b/seed/postman/undiscriminated-unions/collection.json index 1b0d8d8700c..7f11fc8b20e 100644 --- a/seed/postman/undiscriminated-unions/collection.json +++ b/seed/postman/undiscriminated-unions/collection.json @@ -32,12 +32,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"example\"", + "raw": "\"string\"", "options": { "raw": { "language": "json" @@ -45,7 +51,46 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "\"string\"", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "\"string\"", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -75,6 +120,38 @@ "body": null }, "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/metadata", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "metadata" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"name\": \"exampleName\",\n \"value\": \"exampleValue\",\n \"default\": \"exampleDefault\"\n}", + "_postman_previewlanguage": "json" + }, { "name": "Success", "status": "OK", diff --git a/seed/postman/unions/collection.json b/seed/postman/unions/collection.json index f382b2452c9..324ccc7b9ac 100644 --- a/seed/postman/unions/collection.json +++ b/seed/postman/unions/collection.json @@ -35,17 +35,62 @@ "variable": [ { "key": "id", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":id" + ], + "query": [], + "variable": [ + { + "key": "id", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"type\": \"circle\",\n \"id\": \"string\",\n \"radius\": 1.1\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -61,12 +106,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PATCH", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"type\": \"circle\",\n \"radius\": 0\n}", + "raw": "{\n \"type\": \"circle\",\n \"id\": \"string\",\n \"radius\": 1.1\n}", "options": { "raw": { "language": "json" @@ -74,7 +125,46 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"circle\",\n \"id\": \"string\",\n \"radius\": 1.1\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "true", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/unknown/collection.json b/seed/postman/unknown/collection.json index 43f8a5b8af5..5bd898bde03 100644 --- a/seed/postman/unknown/collection.json +++ b/seed/postman/unknown/collection.json @@ -32,12 +32,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "\"UNKNOWN\"", + "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" @@ -45,7 +51,46 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n {\n \"key\": \"value\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -63,7 +108,13 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { @@ -76,7 +127,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/with-object", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "with-object" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "[\n {\n \"key\": \"value\"\n }\n]", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/validation/collection.json b/seed/postman/validation/collection.json index 3d1f414b9d7..762c3b5cf42 100644 --- a/seed/postman/validation/collection.json +++ b/seed/postman/validation/collection.json @@ -29,12 +29,18 @@ "query": [], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": { "mode": "raw", - "raw": "{\n \"decimal\": 0,\n \"even\": 0,\n \"name\": \"example\",\n \"shape\": \"SQUARE\"\n}", + "raw": "{\n \"decimal\": 1.1,\n \"even\": 1,\n \"name\": \"string\",\n \"shape\": \"SQUARE\"\n}", "options": { "raw": { "language": "json" @@ -42,7 +48,48 @@ } } }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/create", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "create" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"decimal\": 1.1,\n \"even\": 1,\n \"name\": \"string\",\n \"shape\": \"SQUARE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "description": null, + "body": "{\n \"decimal\": 1.1,\n \"even\": 2,\n \"name\": \"rules\",\n \"shape\": \"SQUARE\"\n}", + "_postman_previewlanguage": "json" + } + ] }, { "_type": "endpoint", @@ -50,7 +97,7 @@ "request": { "description": null, "url": { - "raw": "{{baseUrl}}?decimal=&even=&name=", + "raw": "{{baseUrl}}?decimal=1.1&even=1&name=string", "host": [ "{{baseUrl}}" ], @@ -58,28 +105,81 @@ "query": [ { "key": "decimal", - "value": "", - "description": null + "description": null, + "value": "1.1" }, { "key": "even", - "value": "", - "description": null + "description": null, + "value": "1" }, { "key": "name", - "value": "", - "description": null + "description": null, + "value": "string" } ], "variable": [] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "GET", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}?decimal=1.1&even=1&name=string", + "host": [ + "{{baseUrl}}" + ], + "path": [], + "query": [ + { + "key": "decimal", + "description": null, + "value": "1.1" + }, + { + "key": "even", + "description": null, + "value": "1" + }, + { + "key": "name", + "description": null, + "value": "string" + } + ], + "variable": [] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"decimal\": 1.1,\n \"even\": 2,\n \"name\": \"rules\",\n \"shape\": \"SQUARE\"\n}", + "_postman_previewlanguage": "json" + } + ] } ] } \ No newline at end of file diff --git a/seed/postman/variables/collection.json b/seed/postman/variables/collection.json index af19894dc25..495f670532c 100644 --- a/seed/postman/variables/collection.json +++ b/seed/postman/variables/collection.json @@ -35,17 +35,62 @@ "variable": [ { "key": "endpointParam", - "value": "", - "description": null + "description": null, + "value": "string" } ] }, - "header": [], + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "auth": null, "body": null }, - "response": [] + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/:endpointParam", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":endpointParam" + ], + "query": [], + "variable": [ + { + "key": "endpointParam", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": null + }, + "description": null, + "body": "", + "_postman_previewlanguage": "json" + } + ] } ] } diff --git a/seed/postman/version-no-default/.mock/definition/api.yml b/seed/postman/version-no-default/.mock/definition/api.yml new file mode 100644 index 00000000000..73791585822 --- /dev/null +++ b/seed/postman/version-no-default/.mock/definition/api.yml @@ -0,0 +1,7 @@ +name: version +version: + header: X-API-Version + values: + - "1.0.0" + - "2.0.0" + - "latest" \ No newline at end of file diff --git a/seed/postman/version-no-default/.mock/definition/user.yml b/seed/postman/version-no-default/.mock/definition/user.yml new file mode 100644 index 00000000000..2a60426d62e --- /dev/null +++ b/seed/postman/version-no-default/.mock/definition/user.yml @@ -0,0 +1,18 @@ +types: + UserId: string + + User: + properties: + id: UserId + name: string + +service: + auth: false + base-path: /users + endpoints: + getUser: + method: GET + path: /{userId} + path-parameters: + userId: UserId + response: User diff --git a/seed/postman/version-no-default/.mock/fern.config.json b/seed/postman/version-no-default/.mock/fern.config.json new file mode 100644 index 00000000000..4c8e54ac313 --- /dev/null +++ b/seed/postman/version-no-default/.mock/fern.config.json @@ -0,0 +1 @@ +{"organization": "fern-test", "version": "*"} \ No newline at end of file diff --git a/seed/postman/version-no-default/collection.json b/seed/postman/version-no-default/collection.json new file mode 100644 index 00000000000..73ece69cff2 --- /dev/null +++ b/seed/postman/version-no-default/collection.json @@ -0,0 +1,100 @@ +{ + "info": { + "name": "Version", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + } + ], + "auth": null, + "item": [ + { + "_type": "container", + "description": null, + "name": "User", + "item": [ + { + "_type": "endpoint", + "name": "Get User", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users", + ":userId" + ], + "query": [], + "variable": [ + { + "key": "userId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users", + ":userId" + ], + "query": [], + "variable": [ + { + "key": "userId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/version-no-default/snippet-templates.json b/seed/postman/version-no-default/snippet-templates.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/version-no-default/snippet.json b/seed/postman/version-no-default/snippet.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/version/.mock/definition/api.yml b/seed/postman/version/.mock/definition/api.yml new file mode 100644 index 00000000000..8a52c2ad5e6 --- /dev/null +++ b/seed/postman/version/.mock/definition/api.yml @@ -0,0 +1,8 @@ +name: version +version: + header: X-API-Version + default: "2.0.0" + values: + - "1.0.0" + - "2.0.0" + - "latest" \ No newline at end of file diff --git a/seed/postman/version/.mock/definition/user.yml b/seed/postman/version/.mock/definition/user.yml new file mode 100644 index 00000000000..2a60426d62e --- /dev/null +++ b/seed/postman/version/.mock/definition/user.yml @@ -0,0 +1,18 @@ +types: + UserId: string + + User: + properties: + id: UserId + name: string + +service: + auth: false + base-path: /users + endpoints: + getUser: + method: GET + path: /{userId} + path-parameters: + userId: UserId + response: User diff --git a/seed/postman/version/.mock/fern.config.json b/seed/postman/version/.mock/fern.config.json new file mode 100644 index 00000000000..4c8e54ac313 --- /dev/null +++ b/seed/postman/version/.mock/fern.config.json @@ -0,0 +1 @@ +{"organization": "fern-test", "version": "*"} \ No newline at end of file diff --git a/seed/postman/version/collection.json b/seed/postman/version/collection.json new file mode 100644 index 00000000000..73ece69cff2 --- /dev/null +++ b/seed/postman/version/collection.json @@ -0,0 +1,100 @@ +{ + "info": { + "name": "Version", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": null + }, + "variable": [ + { + "key": "baseUrl", + "value": "", + "type": "string" + } + ], + "auth": null, + "item": [ + { + "_type": "container", + "description": null, + "name": "User", + "item": [ + { + "_type": "endpoint", + "name": "Get User", + "request": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users", + ":userId" + ], + "query": [], + "variable": [ + { + "key": "userId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "response": [ + { + "name": "Success", + "status": "OK", + "code": 200, + "originalRequest": { + "description": null, + "url": { + "raw": "{{baseUrl}}/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "users", + ":userId" + ], + "query": [], + "variable": [ + { + "key": "userId", + "description": null, + "value": "string" + } + ] + }, + "header": [ + { + "type": "text", + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "GET", + "auth": null, + "body": null + }, + "description": null, + "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", + "_postman_previewlanguage": "json" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/seed/postman/version/snippet-templates.json b/seed/postman/version/snippet-templates.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/postman/version/snippet.json b/seed/postman/version/snippet.json new file mode 100644 index 00000000000..e69de29bb2d diff --git a/seed/ts-sdk/seed.yml b/seed/ts-sdk/seed.yml index f3667085245..8303e6561fa 100644 --- a/seed/ts-sdk/seed.yml +++ b/seed/ts-sdk/seed.yml @@ -12,6 +12,8 @@ local: runCommand: node sdk/cli/dist/nodeCli.cjs env: NODE_ENV: test +customFixtureConfig: + generateWireTests: true fixtures: imdb: - customConfig: null