Updated api usage, corrected table designs
This commit is contained in:
@@ -1193,7 +1193,7 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/projects/beneficiaries/{projectId}": {
|
||||
"/v1/api/projects/{projectId}/beneficiaries": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Projects"
|
||||
@@ -1355,7 +1355,7 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/projects/changerequests/{projectId}": {
|
||||
"/v1/api/projects/{projectId}/changerequests": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Projects"
|
||||
@@ -1573,7 +1573,7 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/projects/issues/{projectId}": {
|
||||
"/v1/api/projects/{projectId}/issues": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Projects"
|
||||
@@ -2308,7 +2308,7 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/projects/sitevisits/{projectId}": {
|
||||
"/v1/api/projects/{projectId}/sitevisits": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Projects"
|
||||
@@ -2740,6 +2740,54 @@
|
||||
"security": [
|
||||
{}
|
||||
]
|
||||
},
|
||||
"put": {
|
||||
"tags": [
|
||||
"Governance"
|
||||
],
|
||||
"description": "Updates a specific budget",
|
||||
"operationId": "updatebudget",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UpdateBudgetRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK"
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized"
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/grants/contracts": {
|
||||
@@ -3770,6 +3818,66 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/auditlog": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Governance"
|
||||
],
|
||||
"description": "Retrieves audit logs based on pagination parameters",
|
||||
"operationId": "getauditlogs",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Pagination"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/AuditLog"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized"
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/instruments/{programmeId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -3876,6 +3984,124 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/organisations/{organisationId}/portfolio": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Governance"
|
||||
],
|
||||
"description": "Get all portfolios belonging to a specific organisation",
|
||||
"operationId": "getorganisationportfolios",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "organisationId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Portfolio"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden"
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized"
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/portfolios/{portfolioId}/value": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Governance"
|
||||
],
|
||||
"description": "Calculates and returns a portfolio's total project's budget value",
|
||||
"operationId": "getporfoliovalue",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "portfolioId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$",
|
||||
"type": [
|
||||
"number",
|
||||
"string"
|
||||
],
|
||||
"format": "double"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden"
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized"
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/portfolios/{portfolioId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -3998,23 +4224,23 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/organisations/{organisationId}/portfolio": {
|
||||
"get": {
|
||||
"/v1/api/governance/organisations/portfolios": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Governance"
|
||||
],
|
||||
"description": "Get all portfolios",
|
||||
"operationId": "getportfolios",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "organisationId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Pagination"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
@@ -4104,6 +4330,71 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/programmes/{programmeId}/value": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Governance"
|
||||
],
|
||||
"description": "Calculates and returns a programme's total project budget value",
|
||||
"operationId": "getprogrammevalue",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "programmeId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$",
|
||||
"type": [
|
||||
"number",
|
||||
"string"
|
||||
],
|
||||
"format": "double"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden"
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized"
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"content": {
|
||||
"application/json; version=1": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProblemDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/api/governance/tenants/{tenantId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -5935,6 +6226,63 @@
|
||||
"ApprovalStatus": {
|
||||
"type": "integer"
|
||||
},
|
||||
"AuditLog": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"pattern": "^-?(?:0|[1-9]\\d*)$",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
],
|
||||
"format": "int64"
|
||||
},
|
||||
"tenantId": {
|
||||
"pattern": "^-?(?:0|[1-9]\\d*)$",
|
||||
"type": [
|
||||
"null",
|
||||
"integer",
|
||||
"string"
|
||||
],
|
||||
"format": "int64"
|
||||
},
|
||||
"entityName": {
|
||||
"type": [
|
||||
"null",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"entityId": {
|
||||
"type": [
|
||||
"null",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"action": {
|
||||
"type": [
|
||||
"null",
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"changes": {
|
||||
"type": [
|
||||
"null",
|
||||
"array"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"performedBy": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"timestamp": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Award": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -6158,6 +6506,9 @@
|
||||
"string"
|
||||
],
|
||||
"format": "double"
|
||||
},
|
||||
"status": {
|
||||
"$ref": "#/components/schemas/ApprovalStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -8481,6 +8832,26 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateBudgetRequest": {
|
||||
"required": [
|
||||
"budgetId",
|
||||
"status"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"budgetId": {
|
||||
"pattern": "^-?(?:0|[1-9]\\d*)$",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
],
|
||||
"format": "int64"
|
||||
},
|
||||
"status": {
|
||||
"$ref": "#/components/schemas/ApprovalStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateChangeRequest": {
|
||||
"required": [
|
||||
"changeRequestId",
|
||||
|
||||
Reference in New Issue
Block a user