Skip to content

Instantly share code, notes, and snippets.

@alagna
Created February 19, 2015 11:49
Show Gist options
  • Save alagna/d4c22d3e18c0015fd588 to your computer and use it in GitHub Desktop.
Save alagna/d4c22d3e18c0015fd588 to your computer and use it in GitHub Desktop.
apiVersion: 1.1.1
swaggerVersion: "1.2"
apis:
- path: /budget
description: Budget Codes
file:
apiVersion: "1.0"
swaggerVersion: "1.2"
basePath: /fsd
resourcePath: /api/budget
produces:
- application/json
apis:
- path: /api/budget/budgetcode/segments
description: getFilteredBudgetCodes
operations:
- method: GET
summary: Search for budget codes.
notes: getFilteredBudgetCodes
type: BudgetCode
nickname: getFilteredBudgetCodes
produces:
- application/json
parameters:
- name: segment1
description: segment1
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: segment2
description: segment2
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: segment3
description: segment3
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: segment4
description: segment4
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: segment5
description: segment5
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: segment6
description: segment6
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: firstResult
description: firstResult
defaultValue: "0"
required: false
type: integer
format: int32
paramType: query
allowMultiple: false
- name: maxResults
description: maxResults
defaultValue: "100"
required: false
type: integer
format: int32
paramType: query
allowMultiple: false
- name: fsd-api-version
description: API Version. If not set it defaults to latest version.
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: fsd-api-version
description: API Version. If not set it defaults to latest version.
defaultValue: ""
required: false
type: string
paramType: header
allowMultiple: false
responseMessages:
- code: {}
message: OK
responseModel: List
- code: {}
message: Forbidden
- code: {}
message: Unauthorized
- code: {}
message: Not Found
deprecated: "false"
- path: /api/budget/segment/
description: getAllSegments
operations:
- method: GET
summary: Get all the possible segments
notes: "WARNING: this operation may crash swagger UI because of it's huge result set. Try it directly with your browser, not with swagger UI."
type: Segment
nickname: getAllSegments
produces:
- application/json
parameters:
- name: fsd-api-version
description: API Version. If not set it defaults to latest version.
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: fsd-api-version
description: API Version. If not set it defaults to latest version.
defaultValue: ""
required: false
type: string
paramType: header
allowMultiple: false
responseMessages:
- code: {}
message: OK
responseModel: List
- code: {}
message: Forbidden
- code: {}
message: Unauthorized
- code: {}
message: Not Found
deprecated: "false"
- path: "/api/budget/segment/{segmentNumber}"
description: getSegments
operations:
- method: GET
summary: Search for segments.
notes: getSegments
type: Segment
nickname: getSegments
produces:
- application/json
parameters:
- name: segmentNumber
description: segmentNumber
defaultValue: ""
required: true
type: integer
format: int32
paramType: path
allowMultiple: false
- name: fsd-api-version
description: API Version. If not set it defaults to latest version.
defaultValue: ""
required: false
type: string
paramType: query
allowMultiple: false
- name: fsd-api-version
description: API Version. If not set it defaults to latest version.
defaultValue: ""
required: false
type: string
paramType: header
allowMultiple: false
responseMessages:
- code: {}
message: OK
responseModel: List
- code: {}
message: Forbidden
- code: {}
message: Unauthorized
- code: {}
message: Not Found
deprecated: "false"
models:
BudgetCode:
id: BudgetCode
description: ""
extends: ""
properties:
segment1:
type: string
segment2:
type: string
segment3:
type: string
segment4:
type: string
segment5:
type: string
segment6:
type: string
Segment:
id: Segment
description: ""
extends: ""
properties:
code:
type: string
segment:
type: integer
format: int32
authorizations:
oauth2:
type: oauth2
scopes: []
info:
title: ORGSupportDataRESTAPI
description: ORG Support Data REST API
termsOfServiceUrl: ""
contact: "CIO-IS-Development-Team-List@ORG.org"
license: ""
licenseUrl: ""
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment