Created
February 11, 2015 09:06
-
-
Save alagna/ba50ec3c25a4d0c0168a to your computer and use it in GitHub Desktop.
swagger definition that causes problem when registering to the WSO2 AM (see http://stackoverflow.com/questions/28428162/wso2-am-1-8-resourcenotfoundexception-resource-does-not-exist-when-importing-sw)
This file contains 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
apiVersion: 1.1.1 | |
swaggerVersion: "1.2" | |
apis: | |
- path: /api/budget | |
description: Budget Codes | |
file: | |
apiVersion: "1.0" | |
swaggerVersion: "1.2" | |
basePath: /sd | |
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: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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 | |
- path: /api/structure | |
description: Organization Structure | |
file: | |
apiVersion: "1.0" | |
swaggerVersion: "1.2" | |
basePath: /sd | |
resourcePath: /api/structure | |
produces: | |
- application/json | |
apis: | |
- path: /api/structure/ | |
description: getAllOrganizationStucture | |
operations: | |
- method: GET | |
summary: Get the complete Organization Structure | |
notes: getAllOrganizationStucture | |
type: Organization | |
nickname: getAllOrganizationStucture | |
produces: | |
- application/json | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/branch/ | |
description: getAllBranches | |
operations: | |
- method: GET | |
summary: getAllBranches | |
notes: getAllBranches | |
type: array | |
items: | |
$ref: Branch | |
nickname: getAllBranches | |
produces: | |
- application/json | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/branch/{branchCode}" | |
description: getBranch | |
operations: | |
- method: GET | |
summary: getBranch | |
notes: getBranch | |
type: Branch | |
nickname: getBranch | |
produces: | |
- application/json | |
parameters: | |
- name: branchCode | |
description: branchCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: Branch | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: "/api/structure/branch/{branchCode}/unit" | |
description: getUnits | |
operations: | |
- method: GET | |
summary: getUnits | |
notes: getUnits | |
type: array | |
items: | |
$ref: Unit | |
nickname: getUnits | |
produces: | |
- application/json | |
parameters: | |
- name: branchCode | |
description: branchCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/department/ | |
description: getAllDepartments | |
operations: | |
- method: GET | |
summary: getAllDepartments | |
notes: getAllDepartments | |
type: array | |
items: | |
$ref: Department | |
nickname: getAllDepartments | |
produces: | |
- application/json | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/department/{departmentCode}" | |
description: getDepartment | |
operations: | |
- method: GET | |
summary: getDepartment | |
notes: getDepartment | |
type: Department | |
nickname: getDepartment | |
produces: | |
- application/json | |
parameters: | |
- name: departmentCode | |
description: departmentCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: Department | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: "/api/structure/department/{departmentCode}/division" | |
description: getDivisions | |
operations: | |
- method: GET | |
summary: getDivisions | |
notes: getDivisions | |
type: array | |
items: | |
$ref: Division | |
nickname: getDivisions | |
produces: | |
- application/json | |
parameters: | |
- name: departmentCode | |
description: departmentCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/division/ | |
description: getAllDivisions | |
operations: | |
- method: GET | |
summary: getAllDivisions | |
notes: getAllDivisions | |
type: array | |
items: | |
$ref: Division | |
nickname: getAllDivisions | |
produces: | |
- application/json | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/division/{divisionCode}" | |
description: getDivision | |
operations: | |
- method: GET | |
summary: getDivision | |
notes: getDivision | |
type: Division | |
nickname: getDivision | |
produces: | |
- application/json | |
parameters: | |
- name: divisionCode | |
description: divisionCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: Division | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: "/api/structure/division/{divisionCode}/branch" | |
description: getBranches | |
operations: | |
- method: GET | |
summary: getBranches | |
notes: getBranches | |
type: array | |
items: | |
$ref: Branch | |
nickname: getBranches | |
produces: | |
- application/json | |
parameters: | |
- name: divisionCode | |
description: divisionCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/organization/ | |
description: getAllOrganizations | |
operations: | |
- method: GET | |
summary: getAllOrganizations | |
notes: getAllOrganizations | |
type: array | |
items: | |
$ref: Organization | |
nickname: getAllOrganizations | |
produces: | |
- application/json | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/organization/{organizationCode}" | |
description: getOrganization | |
operations: | |
- method: GET | |
summary: getOrganization | |
notes: getOrganization | |
type: Organization | |
nickname: getOrganization | |
produces: | |
- application/json | |
parameters: | |
- name: organizationCode | |
description: organizationCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: Organization | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: "/api/structure/organization/{organizationCode}/department" | |
description: getDepartments | |
operations: | |
- method: GET | |
summary: getDepartments | |
notes: getDepartments | |
type: array | |
items: | |
$ref: Department | |
nickname: getDepartments | |
produces: | |
- application/json | |
parameters: | |
- name: organizationCode | |
description: organizationCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/unit/ | |
description: getAllUnits | |
operations: | |
- method: GET | |
summary: getAllUnits | |
notes: getAllUnits | |
type: array | |
items: | |
$ref: Unit | |
nickname: getAllUnits | |
produces: | |
- application/json | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/structure/unit/{unitCode}" | |
description: getUnit | |
operations: | |
- method: GET | |
summary: getUnit | |
notes: getUnit | |
type: Unit | |
nickname: getUnit | |
produces: | |
- application/json | |
parameters: | |
- name: unitCode | |
description: unitCode | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: Unit | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
models: | |
Department: | |
id: Department | |
description: "" | |
extends: "" | |
properties: | |
departmentName: | |
type: string | |
divisions: | |
type: array | |
items: | |
$ref: Division | |
departmentCode: | |
type: string | |
organizationCode: | |
type: string | |
Division: | |
id: Division | |
description: "" | |
extends: "" | |
properties: | |
divisionCode: | |
type: string | |
departmentCode: | |
type: string | |
organizationCode: | |
type: string | |
branches: | |
type: array | |
items: | |
$ref: Branch | |
divisionName: | |
type: string | |
Branch: | |
id: Branch | |
description: "" | |
extends: "" | |
properties: | |
divisionCode: | |
type: string | |
departmentCode: | |
type: string | |
organizationCode: | |
type: string | |
branchCode: | |
type: string | |
branchName: | |
type: string | |
units: | |
type: array | |
items: | |
$ref: Unit | |
Organization: | |
id: Organization | |
description: "" | |
extends: "" | |
properties: | |
organizationName: | |
type: string | |
departments: | |
type: array | |
items: | |
$ref: Department | |
organizationCode: | |
type: string | |
Unit: | |
id: Unit | |
description: "" | |
extends: "" | |
properties: | |
unitCode: | |
type: string | |
divisionCode: | |
type: string | |
departmentCode: | |
type: string | |
organizationCode: | |
type: string | |
branchCode: | |
type: string | |
unitName: | |
type: string | |
- path: /api/people | |
description: People | |
file: | |
apiVersion: "1.0" | |
swaggerVersion: "1.2" | |
basePath: /sd | |
resourcePath: /api/people/org | |
produces: | |
- application/json | |
- text/plain | |
- image/jpeg | |
apis: | |
- path: /api/people/org/activedirectory | |
description: getorgEmployeeActiveDirectory | |
operations: | |
- method: GET | |
summary: Get extract for Active Directory | |
notes: getorgEmployeeActiveDirectory | |
type: orgEmployeeActiveDirectory | |
nickname: getorgEmployeeActiveDirectory | |
produces: | |
- application/json | |
- text/plain | |
parameters: | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/people/org/employee | |
description: getEmployee | |
operations: | |
- method: GET | |
summary: Get information about a single org employee | |
notes: getEmployee | |
type: Employee | |
nickname: getEmployee | |
produces: | |
- application/json | |
parameters: | |
- name: email | |
description: email | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: domain | |
description: "Represents the domain. If not set it defaults to orgDOMAIN. For this to have any effect on the query, the accountName must also be part of the query." | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: accountName | |
description: accountName | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: indexNumber | |
description: indexNumber | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: active | |
description: active | |
defaultValue: "" | |
required: false | |
type: boolean | |
paramType: query | |
allowMultiple: false | |
- name: informationFetchMode | |
description: Choose the information to fetch for each person. Default mode is COMPLETE. | |
defaultValue: "" | |
required: false | |
type: array | |
items: | |
type: string | |
paramType: query | |
allowMultiple: true | |
enum: | |
- PERSON | |
- POSITION | |
- ASSIGNMENT | |
- CONTACTS | |
- COMPLETE | |
- name: organization | |
description: Employee organization | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
enum: | |
- org | |
- WFP | |
- UNDP | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: Employee | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: /api/people/org/employee/photo | |
description: getorgEmployeePhoto | |
operations: | |
- method: GET | |
summary: Get photo of a single org employee | |
notes: getorgEmployeePhoto | |
type: BufferedImage | |
nickname: getorgEmployeePhoto | |
produces: | |
- image/jpeg | |
parameters: | |
- name: email | |
description: email | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: domain | |
description: "Represents the domain. If not set it defaults to orgDOMAIN. For this to have any effect on the query, the accountName must also be part of the query." | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: accountName | |
description: accountName | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: indexNumber | |
description: indexNumber | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: BufferedImage | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: "/api/people/org/employee/photo/{photoId}" | |
description: getorgEmployeePhoto | |
operations: | |
- method: GET | |
summary: Get photo of a single org employee | |
notes: getorgEmployeePhoto | |
type: BufferedImage | |
nickname: getorgEmployeePhoto | |
produces: | |
- image/jpeg | |
parameters: | |
- name: photoId | |
description: photoId | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: path | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: BufferedImage | |
- code: {} | |
message: Forbidden | |
- code: {} | |
message: Unauthorized | |
- code: {} | |
message: Not Found | |
deprecated: "false" | |
- path: /api/people/org/employees | |
description: getEmployees | |
operations: | |
- method: GET | |
summary: Get a list of all org employees | |
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: Employee | |
nickname: getEmployees | |
produces: | |
- application/json | |
- text/plain | |
parameters: | |
- name: active | |
description: active | |
defaultValue: "" | |
required: false | |
type: boolean | |
paramType: query | |
allowMultiple: false | |
- name: lastName | |
description: lastName | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: firstResult | |
description: First result to fetch. Defaults to 0. | |
defaultValue: "0" | |
required: false | |
type: integer | |
format: int32 | |
paramType: query | |
allowMultiple: false | |
- name: maxResults | |
description: How many results to fetch. Defaults to 100. | |
defaultValue: "100" | |
required: false | |
type: integer | |
format: int32 | |
paramType: query | |
allowMultiple: false | |
- name: organization | |
description: Employee organization | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
enum: | |
- org | |
- WFP | |
- UNDP | |
- name: staffOnly | |
description: staffOnly | |
defaultValue: "" | |
required: false | |
type: boolean | |
paramType: query | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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/people/org/timecard | |
description: getEmployeeTimecards | |
operations: | |
- method: GET | |
summary: Get information about timecards | |
notes: getEmployeeTimecards | |
type: orgNshrOtl | |
nickname: getEmployeeTimecards | |
produces: | |
- application/json | |
parameters: | |
- name: dateFrom | |
description: Starting date in DD/MM/YYYY format. | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: dateTo | |
description: Ending date in DD/MM/YYYY format. | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: organizationUnit | |
description: organizationUnit | |
defaultValue: "" | |
required: true | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: email | |
description: email | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: indexNumber | |
description: indexNumber | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-api-version | |
description: API Version. If not set it defaults to latest version. | |
defaultValue: "" | |
required: false | |
type: string | |
paramType: query | |
allowMultiple: false | |
- name: sd-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: | |
ImageProducer: | |
id: ImageProducer | |
description: "" | |
extends: "" | |
properties: {} | |
ColorSpace: | |
id: ColorSpace | |
description: "" | |
extends: "" | |
properties: | |
type: | |
type: integer | |
format: int32 | |
numComponents: | |
type: integer | |
format: int32 | |
TextAttribute: | |
id: TextAttribute | |
description: "" | |
extends: "" | |
properties: {} | |
Rectangle: | |
id: Rectangle | |
description: "" | |
extends: "" | |
properties: | |
empty: | |
type: boolean | |
location: | |
$ref: Point | |
size: | |
$ref: Dimension | |
bounds: | |
$ref: Rectangle | |
x: | |
type: number | |
format: double | |
"y": | |
type: number | |
format: double | |
height: | |
type: number | |
format: double | |
width: | |
type: number | |
format: double | |
bounds2D: | |
$ref: Rectangle2D | |
minX: | |
type: number | |
format: double | |
minY: | |
type: number | |
format: double | |
frame: | |
$ref: Rectangle2D | |
maxX: | |
type: number | |
format: double | |
maxY: | |
type: number | |
format: double | |
centerX: | |
type: number | |
format: double | |
centerY: | |
type: number | |
format: double | |
Rectangle2D: | |
id: Rectangle2D | |
description: "" | |
extends: "" | |
properties: | |
bounds2D: | |
$ref: Rectangle2D | |
empty: | |
type: boolean | |
bounds: | |
$ref: Rectangle | |
minX: | |
type: number | |
format: double | |
minY: | |
type: number | |
format: double | |
x: | |
type: number | |
format: double | |
"y": | |
type: number | |
format: double | |
height: | |
type: number | |
format: double | |
width: | |
type: number | |
format: double | |
frame: | |
$ref: Rectangle2D | |
maxX: | |
type: number | |
format: double | |
maxY: | |
type: number | |
format: double | |
centerX: | |
type: number | |
format: double | |
centerY: | |
type: number | |
format: double | |
DataBuffer: | |
id: DataBuffer | |
description: "" | |
extends: "" | |
properties: | |
size: | |
type: integer | |
format: int32 | |
offset: | |
type: integer | |
format: int32 | |
offsets: | |
type: array | |
items: | |
type: int | |
dataType: | |
type: integer | |
format: int32 | |
numBanks: | |
type: integer | |
format: int32 | |
Point: | |
id: Point | |
description: "" | |
extends: "" | |
properties: | |
location: | |
$ref: Point | |
x: | |
type: number | |
format: double | |
"y": | |
type: number | |
format: double | |
Graphics: | |
id: Graphics | |
description: "" | |
extends: "" | |
properties: | |
font: | |
$ref: Font | |
color: | |
$ref: Color | |
clip: | |
$ref: Shape | |
fontMetrics: | |
$ref: FontMetrics | |
clipBounds: | |
$ref: Rectangle | |
clipRect: | |
$ref: Rectangle | |
orgNshrOtl: | |
id: orgNshrOtl | |
description: "" | |
extends: "" | |
properties: | |
id: | |
$ref: orgNshrOtlPk | |
quantity: | |
type: number | |
format: double | |
approvalStatus: | |
type: string | |
emailAddress: | |
type: string | |
organizationUnit: | |
type: string | |
fullName: | |
type: string | |
Raster: | |
id: Raster | |
description: "" | |
extends: "" | |
properties: | |
parent: | |
$ref: Raster | |
bounds: | |
$ref: Rectangle | |
minX: | |
type: integer | |
format: int32 | |
minY: | |
type: integer | |
format: int32 | |
height: | |
type: integer | |
format: int32 | |
numBands: | |
type: integer | |
format: int32 | |
sampleModel: | |
$ref: SampleModel | |
width: | |
type: integer | |
format: int32 | |
transferType: | |
type: integer | |
format: int32 | |
dataBuffer: | |
$ref: DataBuffer | |
sampleModelTranslateX: | |
type: integer | |
format: int32 | |
sampleModelTranslateY: | |
type: integer | |
format: int32 | |
numDataElements: | |
type: integer | |
format: int32 | |
FontRenderContext: | |
id: FontRenderContext | |
description: "" | |
extends: "" | |
properties: | |
transformed: | |
type: boolean | |
antiAliasingHint: | |
$ref: object | |
fractionalMetricsHint: | |
$ref: object | |
transform: | |
$ref: AffineTransform | |
transformType: | |
type: integer | |
format: int32 | |
antiAliased: | |
type: boolean | |
ColorModel: | |
id: ColorModel | |
description: "" | |
extends: "" | |
properties: | |
alphaPremultiplied: | |
type: boolean | |
componentSize: | |
type: array | |
items: | |
type: int | |
colorSpace: | |
$ref: ColorSpace | |
numComponents: | |
type: integer | |
format: int32 | |
transparency: | |
type: integer | |
format: int32 | |
numColorComponents: | |
type: integer | |
format: int32 | |
transferType: | |
type: integer | |
format: int32 | |
pixelSize: | |
type: integer | |
format: int32 | |
BufferedImage: | |
id: BufferedImage | |
description: "" | |
extends: "" | |
properties: | |
type: | |
type: integer | |
format: int32 | |
data: | |
$ref: Raster | |
source: | |
$ref: ImageProducer | |
minTileX: | |
type: integer | |
format: int32 | |
propertyNames: | |
type: array | |
items: | |
type: string | |
minTileY: | |
type: integer | |
format: int32 | |
minX: | |
type: integer | |
format: int32 | |
minY: | |
type: integer | |
format: int32 | |
numXTiles: | |
type: integer | |
format: int32 | |
numYTiles: | |
type: integer | |
format: int32 | |
sources: | |
type: array | |
items: | |
$ref: RenderedImage | |
alphaPremultiplied: | |
type: boolean | |
graphics: | |
$ref: Graphics | |
height: | |
type: integer | |
format: int32 | |
colorModel: | |
$ref: ColorModel | |
sampleModel: | |
$ref: SampleModel | |
width: | |
type: integer | |
format: int32 | |
tileGridXOffset: | |
type: integer | |
format: int32 | |
tileGridYOffset: | |
type: integer | |
format: int32 | |
tileHeight: | |
type: integer | |
format: int32 | |
tileWidth: | |
type: integer | |
format: int32 | |
transparency: | |
type: integer | |
format: int32 | |
alphaRaster: | |
$ref: WritableRaster | |
raster: | |
$ref: WritableRaster | |
writableTileIndices: | |
type: array | |
items: | |
$ref: Point | |
accelerationPriority: | |
type: number | |
format: float | |
Shape: | |
id: Shape | |
description: "" | |
extends: "" | |
properties: | |
bounds: | |
$ref: Rectangle | |
bounds2D: | |
$ref: Rectangle2D | |
AffineTransform: | |
id: AffineTransform | |
description: "" | |
extends: "" | |
properties: | |
type: | |
type: integer | |
format: int32 | |
identity: | |
type: boolean | |
translateY: | |
type: number | |
format: double | |
determinant: | |
type: number | |
format: double | |
scaleX: | |
type: number | |
format: double | |
scaleY: | |
type: number | |
format: double | |
shearX: | |
type: number | |
format: double | |
shearY: | |
type: number | |
format: double | |
translateX: | |
type: number | |
format: double | |
orgNshrOtlPk: | |
id: orgNshrOtlPk | |
description: "" | |
extends: "" | |
properties: | |
employeeNumber: | |
type: string | |
workingDay: | |
type: string | |
format: date-time | |
Dimension: | |
id: Dimension | |
description: "" | |
extends: "" | |
properties: | |
size: | |
$ref: Dimension | |
height: | |
type: number | |
format: double | |
width: | |
type: number | |
format: double | |
FontMetrics: | |
id: FontMetrics | |
description: "" | |
extends: "" | |
properties: | |
font: | |
$ref: Font | |
height: | |
type: integer | |
format: int32 | |
ascent: | |
type: integer | |
format: int32 | |
descent: | |
type: integer | |
format: int32 | |
leading: | |
type: integer | |
format: int32 | |
fontRenderContext: | |
$ref: FontRenderContext | |
maxAdvance: | |
type: integer | |
format: int32 | |
maxAscent: | |
type: integer | |
format: int32 | |
maxDecent: | |
type: integer | |
format: int32 | |
maxDescent: | |
type: integer | |
format: int32 | |
widths: | |
type: array | |
items: | |
type: int | |
Date: | |
id: Date | |
description: "" | |
extends: "" | |
properties: | |
hours: | |
type: integer | |
format: int32 | |
minutes: | |
type: integer | |
format: int32 | |
seconds: | |
type: integer | |
format: int32 | |
date: | |
type: integer | |
format: int32 | |
month: | |
type: integer | |
format: int32 | |
time: | |
type: integer | |
format: int64 | |
year: | |
type: integer | |
format: int32 | |
day: | |
type: integer | |
format: int32 | |
timezoneOffset: | |
type: integer | |
format: int32 | |
WritableRaster: | |
id: WritableRaster | |
description: "" | |
extends: "" | |
properties: | |
writableParent: | |
$ref: WritableRaster | |
parent: | |
$ref: Raster | |
bounds: | |
$ref: Rectangle | |
minX: | |
type: integer | |
format: int32 | |
minY: | |
type: integer | |
format: int32 | |
height: | |
type: integer | |
format: int32 | |
numBands: | |
type: integer | |
format: int32 | |
sampleModel: | |
$ref: SampleModel | |
width: | |
type: integer | |
format: int32 | |
transferType: | |
type: integer | |
format: int32 | |
dataBuffer: | |
$ref: DataBuffer | |
sampleModelTranslateX: | |
type: integer | |
format: int32 | |
sampleModelTranslateY: | |
type: integer | |
format: int32 | |
numDataElements: | |
type: integer | |
format: int32 | |
Employee: | |
id: Employee | |
description: "" | |
extends: "" | |
properties: | |
typeCode: | |
type: string | |
extension: | |
type: string | |
organization: | |
type: string | |
appointmentStart: | |
type: string | |
format: date-time | |
appointmentEnd: | |
type: string | |
format: date-time | |
lastName: | |
type: string | |
firstName: | |
type: string | |
dateOfBirth: | |
type: string | |
format: date-time | |
gender: | |
type: string | |
nationalityCountryCode: | |
type: string | |
nationalityCountryDesc: | |
type: string | |
maritalStatus: | |
type: string | |
jobTitle: | |
type: string | |
appointmentType: | |
type: string | |
grade: | |
type: string | |
gradeStep: | |
type: string | |
activeValue: | |
type: string | |
supervisorIndexNumber: | |
type: string | |
supervisorName: | |
type: string | |
assignemntDutyStationCountryCode: | |
type: string | |
assignemntDutyStationCountryDesc: | |
type: string | |
assignemntDutyStationCityDesc: | |
type: string | |
assignemntDutyStationRegion: | |
type: string | |
assignmentEntitlementCat: | |
type: string | |
recruitment: | |
type: string | |
assignmentStart: | |
type: string | |
format: date-time | |
assignmentEnd: | |
type: string | |
format: date-time | |
technicalOrganization: | |
type: string | |
room: | |
type: string | |
account: | |
type: string | |
title: | |
type: string | |
cityOfBirth: | |
type: string | |
countryOfBirthCode: | |
type: string | |
permanentCity: | |
type: string | |
permanentCountryCode: | |
type: string | |
typeDesc: | |
type: string | |
specialityCode: | |
type: string | |
specialityDesc: | |
type: string | |
originalDateOfHire: | |
type: string | |
format: date-time | |
actualTerminationDate: | |
type: string | |
format: date-time | |
positionNumber: | |
type: string | |
positionId: | |
type: integer | |
format: int32 | |
positionSharing: | |
type: string | |
positionRequestType: | |
type: string | |
positionRequestReason: | |
type: string | |
positionFund: | |
type: string | |
positionName: | |
type: string | |
positionTitle: | |
type: string | |
positionTitleSpecialization: | |
type: string | |
positionDurationType: | |
type: string | |
positionType: | |
type: string | |
positionGrade: | |
type: string | |
positionProject: | |
type: string | |
positionPwb: | |
type: string | |
positionCcogCode: | |
type: string | |
positionEntitlementCat: | |
type: string | |
positionTechnicalOrganization: | |
type: string | |
positionAdministrativeOrganization: | |
type: string | |
positionOperationalOrganization: | |
type: string | |
positionLocationId: | |
type: string | |
positionLocationCode: | |
type: string | |
positionLocationType: | |
type: string | |
positionLocationCountryCode: | |
type: string | |
positionLocationCountryDesc: | |
type: string | |
positionLocationCity: | |
type: string | |
assignmentId: | |
type: integer | |
format: int32 | |
assignmentNumber: | |
type: string | |
assignmentTitle: | |
type: string | |
assignmentAdministrativeOrg: | |
type: string | |
assignmentPartTime: | |
type: string | |
assignmentContractType: | |
type: string | |
assignmentWorkClassId: | |
type: integer | |
format: int32 | |
assignmentWorkClassDesc: | |
type: string | |
assignmentOfficeName: | |
type: string | |
assignmentDsCode: | |
type: string | |
contactsBpId: | |
type: integer | |
format: int32 | |
contactsBpType: | |
type: string | |
contactsBpCode: | |
type: string | |
contactsBpEnd: | |
type: string | |
format: date-time | |
contactsDirect: | |
type: string | |
contactsOfficialMobile: | |
type: string | |
emailAddress: | |
type: string | |
indexNumber: | |
type: string | |
contactsPhoto: | |
type: string | |
fullName: | |
type: string | |
SampleModel: | |
id: SampleModel | |
description: "" | |
extends: "" | |
properties: | |
height: | |
type: integer | |
format: int32 | |
numBands: | |
type: integer | |
format: int32 | |
sampleSize: | |
type: array | |
items: | |
type: int | |
width: | |
type: integer | |
format: int32 | |
dataType: | |
type: integer | |
format: int32 | |
transferType: | |
type: integer | |
format: int32 | |
numDataElements: | |
type: integer | |
format: int32 | |
RenderedImage: | |
id: RenderedImage | |
description: "" | |
extends: "" | |
properties: | |
data: | |
$ref: Raster | |
minTileX: | |
type: integer | |
format: int32 | |
propertyNames: | |
type: array | |
items: | |
type: string | |
minTileY: | |
type: integer | |
format: int32 | |
minX: | |
type: integer | |
format: int32 | |
minY: | |
type: integer | |
format: int32 | |
numXTiles: | |
type: integer | |
format: int32 | |
numYTiles: | |
type: integer | |
format: int32 | |
sources: | |
type: array | |
items: | |
$ref: RenderedImage | |
height: | |
type: integer | |
format: int32 | |
colorModel: | |
$ref: ColorModel | |
sampleModel: | |
$ref: SampleModel | |
width: | |
type: integer | |
format: int32 | |
tileGridXOffset: | |
type: integer | |
format: int32 | |
tileGridYOffset: | |
type: integer | |
format: int32 | |
tileHeight: | |
type: integer | |
format: int32 | |
tileWidth: | |
type: integer | |
format: int32 | |
Attribute: | |
id: Attribute | |
description: "" | |
extends: "" | |
properties: {} | |
Color: | |
id: Color | |
description: "" | |
extends: "" | |
properties: | |
alpha: | |
type: integer | |
format: int32 | |
colorSpace: | |
$ref: ColorSpace | |
blue: | |
type: integer | |
format: int32 | |
green: | |
type: integer | |
format: int32 | |
red: | |
type: integer | |
format: int32 | |
transparency: | |
type: integer | |
format: int32 | |
FontPeer: | |
id: FontPeer | |
description: "" | |
extends: "" | |
properties: {} | |
orgEmployeeActiveDirectory: | |
id: orgEmployeeActiveDirectory | |
description: "" | |
extends: "" | |
properties: | |
extension: | |
type: string | |
lastName: | |
type: string | |
firstName: | |
type: string | |
jobTitle: | |
type: string | |
assignemntDutyStationCountryDesc: | |
type: string | |
assignemntDutyStationCityDesc: | |
type: string | |
technicalOrganization: | |
type: string | |
room: | |
type: string | |
title: | |
type: string | |
assignmentOfficeName: | |
type: string | |
contactsDirect: | |
type: string | |
contactsOfficialMobile: | |
type: string | |
emailAddress: | |
type: string | |
indexNumber: | |
type: string | |
contactsPhoto: | |
type: string | |
lastUpdateDate: | |
type: string | |
format: date-time | |
activeDirectoryExportStatus: | |
type: string | |
enum: | |
- ADDED | |
- DELETED | |
- UPDATED | |
Font: | |
id: Font | |
description: "" | |
extends: "" | |
properties: | |
name: | |
type: string | |
size: | |
type: integer | |
format: int32 | |
attributes: | |
type: array | |
items: | |
$ref: "Entry«TextAttribute,object»" | |
peer: | |
$ref: FontPeer | |
transformed: | |
type: boolean | |
style: | |
type: integer | |
format: int32 | |
family: | |
type: string | |
availableAttributes: | |
type: array | |
items: | |
$ref: Attribute | |
fontName: | |
type: string | |
italicAngle: | |
type: number | |
format: float | |
missingGlyphCode: | |
type: integer | |
format: int32 | |
numGlyphs: | |
type: integer | |
format: int32 | |
size2D: | |
type: number | |
format: float | |
transform: | |
$ref: AffineTransform | |
bold: | |
type: boolean | |
italic: | |
type: boolean | |
plain: | |
type: boolean | |
"Entry«TextAttribute,object»": | |
id: "Entry«TextAttribute,object»" | |
description: "" | |
extends: "" | |
properties: | |
key: | |
$ref: object | |
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