Skip to content

Commit 04fd566

Browse files
sap-alex-oliveirasap-alex-oliveira
authored
Merge pull request #1752 from jpoutche/TVR-33625
TVR-33625 : [API] Cascading Request - API Swagger documentation
2 parents 42a45ec + 796d62f commit 04fd566

File tree

2 files changed

+231
-3
lines changed

2 files changed

+231
-3
lines changed

‎src/api-explorer/v4-0/ConcurRequest.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ reference-type: swagger
55
---
66

77

8-
8+
{% include prerelease.html %}
99
{% swagger /api-explorer/v4-0/ConcurRequest.swagger2.json %}

‎src/api-explorer/v4-0/ConcurRequest.swagger2.json‎

Lines changed: 230 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"description": "Request as a Service",
55
"version": "4.0",
6-
"title": "Concur Request API Documentation"
6+
"title": "Request"
77
},
88
"host": "us.api.concursolutions.com",
99
"basePath": "/travelrequest/v4",
@@ -2705,6 +2705,177 @@
27052705
}
27062706
}
27072707
}
2708+
},
2709+
"/v4/requests/{requestUuid}/participants": {
2710+
"get": {
2711+
"tags": [
2712+
"Request Resource"
2713+
],
2714+
"summary": "Get participants for a Budget Request",
2715+
"operationId": "getParticipants",
2716+
"consumes": [
2717+
"application/json"
2718+
],
2719+
"produces": [
2720+
"application/json"
2721+
],
2722+
"parameters": [
2723+
{
2724+
"name": "requestUuid",
2725+
"in": "path",
2726+
"description": "The unique identifier of the Request",
2727+
"required": true,
2728+
"type": "string"
2729+
},
2730+
{
2731+
"name": "userId",
2732+
"in": "query",
2733+
"description": "The unique identifier of the user",
2734+
"required": false,
2735+
"type": "string"
2736+
},
2737+
{
2738+
"name": "concur-correlationid",
2739+
"in": "header",
2740+
"description": "Client generated request identifier passed through all requests",
2741+
"required": false,
2742+
"type": "string"
2743+
}
2744+
],
2745+
"responses": {
2746+
"200": {
2747+
"description": "OK",
2748+
"schema": {
2749+
"type": "array",
2750+
"items": {
2751+
"$ref": "#/definitions/ParentRequestParticipant"
2752+
}
2753+
}
2754+
},
2755+
"400": {
2756+
"description": "Bad param: invalid Guid",
2757+
"schema": {
2758+
"$ref": "#/definitions/ErrorResponse"
2759+
}
2760+
},
2761+
"401": {
2762+
"description": "Invalid or non existent authorization HTTP header",
2763+
"schema": {
2764+
"$ref": "#/definitions/ErrorResponse"
2765+
}
2766+
},
2767+
"403": {
2768+
"description": "You do not have permission to perform this operation",
2769+
"schema": {
2770+
"$ref": "#/definitions/ErrorResponse"
2771+
}
2772+
},
2773+
"404": {
2774+
"description": "Not found",
2775+
"schema": {
2776+
"$ref": "#/definitions/ErrorResponse"
2777+
}
2778+
},
2779+
"500": {
2780+
"description": "An unexpected error has prevented the operation",
2781+
"schema": {
2782+
"$ref": "#/definitions/ErrorResponse"
2783+
}
2784+
},
2785+
"503": {
2786+
"description": "The service is currently unavailable.",
2787+
"schema": {
2788+
"$ref": "#/definitions/ErrorResponse"
2789+
}
2790+
}
2791+
}
2792+
},
2793+
"patch": {
2794+
"tags": [
2795+
"Request Resource"
2796+
],
2797+
"summary": "Manage participants of a Budget Request",
2798+
"operationId": "manageParticipants",
2799+
"consumes": [
2800+
"application/merge-patch+json"
2801+
],
2802+
"produces": [
2803+
"application/json"
2804+
],
2805+
"parameters": [
2806+
{
2807+
"name": "requestUuid",
2808+
"in": "path",
2809+
"description": "The unique identifier of the Request",
2810+
"required": true,
2811+
"type": "string"
2812+
},
2813+
{
2814+
"name": "userId",
2815+
"in": "query",
2816+
"description": "The unique identifier of the user",
2817+
"required": false,
2818+
"type": "string"
2819+
},
2820+
{
2821+
"name": "concur-correlationid",
2822+
"in": "header",
2823+
"description": "Client generated request identifier passed through all requests",
2824+
"required": false,
2825+
"type": "string"
2826+
},
2827+
{
2828+
"in": "body",
2829+
"name": "body",
2830+
"description": "The list of participants to add or delete from the Request",
2831+
"required": true,
2832+
"schema": {
2833+
"$ref": "#/definitions/RequestParticipantsForPatch"
2834+
}
2835+
}
2836+
],
2837+
"responses": {
2838+
"204": {
2839+
"description": "No Content"
2840+
},
2841+
"400": {
2842+
"description": "Bad param: invalid Guid",
2843+
"schema": {
2844+
"$ref": "#/definitions/ErrorResponse"
2845+
}
2846+
},
2847+
"401": {
2848+
"description": "Invalid or non existent authorization HTTP header",
2849+
"schema": {
2850+
"$ref": "#/definitions/ErrorResponse"
2851+
}
2852+
},
2853+
"403": {
2854+
"description": "You do not have permission to perform this operation",
2855+
"schema": {
2856+
"$ref": "#/definitions/ErrorResponse"
2857+
}
2858+
},
2859+
"404": {
2860+
"description": "Not found",
2861+
"schema": {
2862+
"$ref": "#/definitions/ErrorResponse"
2863+
}
2864+
},
2865+
"500": {
2866+
"description": "An unexpected error has prevented the operation",
2867+
"schema": {
2868+
"$ref": "#/definitions/ErrorResponse"
2869+
}
2870+
},
2871+
"503": {
2872+
"description": "The service is currently unavailable.",
2873+
"schema": {
2874+
"$ref": "#/definitions/ErrorResponse"
2875+
}
2876+
}
2877+
}
2878+
}
27082879
}
27092880
},
27102881
"definitions": {
@@ -3838,6 +4009,48 @@
38384009
}
38394010
}
38404011
},
4012+
"ParentRequestParticipant": {
4013+
"type": "object",
4014+
"properties": {
4015+
"participant": {
4016+
"description": "A Participant of the Budget Request",
4017+
"$ref": "#/definitions/ResourceLink"
4018+
},
4019+
"requests": {
4020+
"type": "array",
4021+
"description": "The list of Child Requests from the Participant associated to the Budget Request",
4022+
"items": {
4023+
"$ref": "#/definitions/ResourceLink"
4024+
}
4025+
}
4026+
}
4027+
},
4028+
"RequestParticipantsForPatch": {
4029+
"type": "object",
4030+
"properties": {
4031+
"value": {
4032+
"type": "array",
4033+
"items": {
4034+
"$ref": "#/definitions/RequestParticipantForPatch"
4035+
}
4036+
}
4037+
},
4038+
"description": "The list of Participants to be added or deleted from the Budget Request"
4039+
},
4040+
"RequestParticipantForPatch": {
4041+
"type": "object",
4042+
"properties": {
4043+
"@deleted": {
4044+
"type": "boolean",
4045+
"description": "Whether the Participant should be added or deleted from the Budget Request. If false or not provided then the Participant is added"
4046+
},
4047+
"id": {
4048+
"type": "string",
4049+
"description": "The Participant unique identifier"
4050+
}
4051+
},
4052+
"description": "A Participant to be added or removed from the Budget Request"
4053+
},
38414054
"Request": {
38424055
"type": "object",
38434056
"properties": {
@@ -4082,6 +4295,17 @@
40824295
"type": {
40834296
"description": "The type of the Request, inherited from the Request policy type",
40844297
"$ref": "#/definitions/RequestType"
4298+
},
4299+
"isParentRequest": {
4300+
"type": "boolean",
4301+
"description": "Indicates whether this Request is a Budget Request"
4302+
},
4303+
"parentRequest": {
4304+
"$ref": "#/definitions/ResourceLink"
4305+
},
4306+
"parentRequestId": {
4307+
"type": "string",
4308+
"description": "Required if a Child Request is created, corresponds to the unique identifier of the Budget Request the Child Request will be linked to"
40854309
}
40864310
}
40874311
},
@@ -4432,6 +4656,10 @@
44324656
"description": "Name of the Request policy",
44334657
"minLength": 1,
44344658
"maxLength": 2147483647
4659+
},
4660+
"allowParticipants": {
4661+
"type": "boolean",
4662+
"description": "Whether this policy can add participants (policy is a Budget Request)"
44354663
}
44364664
}
44374665
},
@@ -4796,4 +5024,4 @@
47965024
"description": "Comment when the workflow action is ‘sendback’."
47975025
}
47985026
}
4799-
}
5027+
}

0 commit comments

Comments
 (0)