Last active
March 8, 2019 10:50
-
-
Save sjcotto/34bd4fe7eb6c9feff2234fd9cee4dfa1 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swagger: "2.0" | |
info: | |
description: "Aquila APIs" | |
version: "2.0.0" | |
title: "Aquila APIs" | |
contact: | |
email: "[email protected]" | |
host: "pr-proxy-backend.azurewebsites.net" | |
basePath: "/dev/services" | |
schemes: | |
- "https" | |
- "http" | |
paths: | |
/documents/psc: | |
post: | |
tags: | |
- "psc" | |
summary: "Add a new psc document" | |
description: "" | |
operationId: "addPsc" | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
parameters: | |
- in: "body" | |
name: "body" | |
description: "PSC object that needs to be added to the store" | |
required: true | |
schema: | |
$ref: "#/definitions/PSC" | |
responses: | |
400: | |
description: "Invalid input" | |
200: | |
description: "Success" | |
put: | |
tags: | |
- "psc" | |
summary: "Add a new psc document" | |
description: "" | |
operationId: "updatePsc" | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
parameters: | |
- in: "body" | |
name: "body" | |
description: "PSC object that needs to be added to the store" | |
required: true | |
schema: | |
$ref: "#/definitions/PSC" | |
responses: | |
400: | |
description: "Invalid input" | |
200: | |
description: "Success" | |
/documents/psc/findByERPId: | |
get: | |
tags: | |
- "psc" | |
summary: "Finds PSC by ERP ID" | |
description: "" | |
operationId: "findPscByERP" | |
produces: | |
- "application/json" | |
parameters: | |
- name: "erpId" | |
in: "query" | |
description: "ERP ID" | |
required: true | |
type: "number" | |
- name: "erpCompany" | |
in: "query" | |
description: "ERP Company" | |
required: true | |
type: "number" | |
responses: | |
200: | |
description: "successful operation" | |
400: | |
description: "Invalid status value" | |
/documents/psc/{pscId}: | |
get: | |
tags: | |
- "psc" | |
summary: "Find PSC by ID" | |
description: "Returns a single PSC" | |
operationId: "getPSCById" | |
produces: | |
- "application/json" | |
parameters: | |
- name: "pscId" | |
in: "path" | |
description: "ID of PSC to return" | |
required: true | |
type: "integer" | |
format: "int64" | |
responses: | |
200: | |
description: "successful operation" | |
schema: | |
$ref: "#/definitions/PSC" | |
400: | |
description: "Invalid ID supplied" | |
security: | |
- api_key: [] | |
delete: | |
tags: | |
- "pet" | |
summary: "Deletes a PSC" | |
description: "" | |
operationId: "deletePsc" | |
produces: | |
- "application/json" | |
parameters: | |
- name: "pscId" | |
in: "path" | |
description: "Psc id to delete" | |
required: true | |
type: "integer" | |
format: "int64" | |
responses: | |
400: | |
description: "Invalid ID supplied" | |
components: | |
securitySchemes: | |
ApiKeyAuth: # arbitrary name for the security scheme | |
type: apiKey | |
in: header # can be "header", "query" or "cookie" | |
name: X-API-KEY | |
security: | |
- ApiKeyAuth: [] | |
definitions: | |
PSC: | |
type: "object" | |
required: | |
- "name" | |
- "photoUrls" | |
properties: | |
id: | |
type: "integer" | |
format: "int64" | |
type: | |
type: "string" | |
example: "PSC" | |
description: | |
type: "string" | |
example: "PSC" | |
requestDate: | |
type: "string" | |
format: "date" | |
shipTo: | |
type: "object" | |
properties: | |
idAddress: | |
type: "integer" | |
format: "int64" | |
company: | |
type: "object" | |
properties: | |
id: | |
type: "integer" | |
format: "int64" | |
soldTo: | |
type: "object" | |
properties: | |
id: | |
type: "integer" | |
format: "int64" | |
almacen: | |
type: "object" | |
properties: | |
idAlmacen: | |
type: "integer" | |
format: "int64" | |
conceptoGasto: | |
type: "object" | |
properties: | |
idConceptoGasto: | |
type: "integer" | |
format: "int64" | |
currency: | |
type: "object" | |
properties: | |
idCurrency: | |
type: "integer" | |
format: "int64" | |
status: | |
type: "object" | |
properties: | |
idStatus: | |
type: "integer" | |
format: "int64" | |
activity: | |
type: "object" | |
properties: | |
idActivity: | |
type: "integer" | |
format: "int64" | |
requestingUser: | |
type: "string" | |
format: "int64" | |
jdeId: | |
type: "integer" | |
format: "int64" | |
phone: | |
type: "string" | |
format: "int64" | |
contact: | |
type: "string" | |
format: "int64" | |
deliveryInstructions: | |
type: "string" | |
format: "int64" | |
skus: | |
type: "array" | |
items: | |
type: 'object' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment