Skip to content

Commit 9ba408c

Browse files
author
David Ronk
committed
Switch back to single response object.
This reverts commit 6ab079e. This commit was designed to increase backwards compatibility but after further discussion it was decided that the added complexity was less desirable. Additionally there are already breaking changes in this new version that will need address and this would be a minor one.
1 parent 6ab079e commit 9ba408c

File tree

8 files changed

+30
-243
lines changed

8 files changed

+30
-243
lines changed

docraptor.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ paths:
171171
200:
172172
description: Successful response
173173
schema:
174-
$ref: '#/definitions/AsyncDocStatus'
174+
$ref: '#/definitions/DocStatus'
175175
401:
176176
description: Unauthorized
177177
403:
@@ -436,7 +436,7 @@ definitions:
436436
type: string
437437
description: The identifier used to get the status of the document using the status API.
438438

439-
AsyncDocStatus:
439+
DocStatus:
440440
type: object
441441
properties:
442442
status:
@@ -457,7 +457,4 @@ definitions:
457457
validation_errors:
458458
type: string
459459
description: Error information.
460-
DocStatus:
461-
type: object
462-
allOf:
463-
- $ref: '#/definitions/AsyncDocStatus'
460+

examples/async.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ static void Main(string[] args) {
3838

3939
AsyncDoc response = docraptor.CreateAsyncDoc(doc);
4040

41-
AsyncDocStatus status_response;
41+
DocStatus status_response;
4242
Boolean done = false;
4343
while(!done) {
4444
status_response = docraptor.GetAsyncDocStatus(response.StatusId);

examples/hosted_async.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ static void Main(string[] args) {
4747

4848
AsyncDoc response = docraptor.CreateHostedAsyncDoc(doc);
4949

50-
AsyncDocStatus status_response;
50+
DocStatus status_response;
5151
Boolean done = false;
5252
while(!done) {
5353
status_response = docraptor.GetAsyncDocStatus(response.StatusId);

src/DocRaptor/Api/DocApi.cs

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ public interface IDocApi : IApiAccessor
158158
/// </remarks>
159159
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
160160
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
161-
/// <returns>AsyncDocStatus</returns>
162-
AsyncDocStatus GetAsyncDocStatus (string id);
161+
/// <returns>DocStatus</returns>
162+
DocStatus GetAsyncDocStatus (string id);
163163

164164
/// <summary>
165165
///
@@ -169,8 +169,8 @@ public interface IDocApi : IApiAccessor
169169
/// </remarks>
170170
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
171171
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
172-
/// <returns>ApiResponse of AsyncDocStatus</returns>
173-
ApiResponse<AsyncDocStatus> GetAsyncDocStatusWithHttpInfo (string id);
172+
/// <returns>ApiResponse of DocStatus</returns>
173+
ApiResponse<DocStatus> GetAsyncDocStatusWithHttpInfo (string id);
174174
#endregion Synchronous Operations
175175
#region Asynchronous Operations
176176
/// <summary>
@@ -307,8 +307,8 @@ public interface IDocApi : IApiAccessor
307307
/// </remarks>
308308
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
309309
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
310-
/// <returns>Task of AsyncDocStatus</returns>
311-
System.Threading.Tasks.Task<AsyncDocStatus> GetAsyncDocStatusAsync (string id);
310+
/// <returns>Task of DocStatus</returns>
311+
System.Threading.Tasks.Task<DocStatus> GetAsyncDocStatusAsync (string id);
312312

313313
/// <summary>
314314
///
@@ -318,8 +318,8 @@ public interface IDocApi : IApiAccessor
318318
/// </remarks>
319319
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
320320
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
321-
/// <returns>Task of ApiResponse (AsyncDocStatus)</returns>
322-
System.Threading.Tasks.Task<ApiResponse<AsyncDocStatus>> GetAsyncDocStatusAsyncWithHttpInfo (string id);
321+
/// <returns>Task of ApiResponse (DocStatus)</returns>
322+
System.Threading.Tasks.Task<ApiResponse<DocStatus>> GetAsyncDocStatusAsyncWithHttpInfo (string id);
323323
#endregion Asynchronous Operations
324324
}
325325

@@ -1397,10 +1397,10 @@ public async System.Threading.Tasks.Task<ApiResponse<byte[]>> GetAsyncDocAsyncWi
13971397
/// </summary>
13981398
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
13991399
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
1400-
/// <returns>AsyncDocStatus</returns>
1401-
public AsyncDocStatus GetAsyncDocStatus (string id)
1400+
/// <returns>DocStatus</returns>
1401+
public DocStatus GetAsyncDocStatus (string id)
14021402
{
1403-
ApiResponse<AsyncDocStatus> localVarResponse = GetAsyncDocStatusWithHttpInfo(id);
1403+
ApiResponse<DocStatus> localVarResponse = GetAsyncDocStatusWithHttpInfo(id);
14041404
return localVarResponse.Data;
14051405
}
14061406

@@ -1409,8 +1409,8 @@ public AsyncDocStatus GetAsyncDocStatus (string id)
14091409
/// </summary>
14101410
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
14111411
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
1412-
/// <returns>ApiResponse of AsyncDocStatus</returns>
1413-
public ApiResponse< AsyncDocStatus > GetAsyncDocStatusWithHttpInfo (string id)
1412+
/// <returns>ApiResponse of DocStatus</returns>
1413+
public ApiResponse< DocStatus > GetAsyncDocStatusWithHttpInfo (string id)
14141414
{
14151415
// verify the required parameter 'id' is set
14161416
if (id == null)
@@ -1463,20 +1463,20 @@ public ApiResponse< AsyncDocStatus > GetAsyncDocStatusWithHttpInfo (string id)
14631463
if (exception != null) throw exception;
14641464
}
14651465

1466-
return new ApiResponse<AsyncDocStatus>(localVarStatusCode,
1466+
return new ApiResponse<DocStatus>(localVarStatusCode,
14671467
localVarResponse.Headers.ToDictionary(x => x.Name, x => x.Value.ToString()),
1468-
(AsyncDocStatus) this.Configuration.ApiClient.Deserialize(localVarResponse, typeof(AsyncDocStatus)));
1468+
(DocStatus) this.Configuration.ApiClient.Deserialize(localVarResponse, typeof(DocStatus)));
14691469
}
14701470

14711471
/// <summary>
14721472
/// Check on the status of an asynchronously created document.
14731473
/// </summary>
14741474
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
14751475
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
1476-
/// <returns>Task of AsyncDocStatus</returns>
1477-
public async System.Threading.Tasks.Task<AsyncDocStatus> GetAsyncDocStatusAsync (string id)
1476+
/// <returns>Task of DocStatus</returns>
1477+
public async System.Threading.Tasks.Task<DocStatus> GetAsyncDocStatusAsync (string id)
14781478
{
1479-
ApiResponse<AsyncDocStatus> localVarResponse = await GetAsyncDocStatusAsyncWithHttpInfo(id);
1479+
ApiResponse<DocStatus> localVarResponse = await GetAsyncDocStatusAsyncWithHttpInfo(id);
14801480
return localVarResponse.Data;
14811481

14821482
}
@@ -1486,8 +1486,8 @@ public async System.Threading.Tasks.Task<AsyncDocStatus> GetAsyncDocStatusAsync
14861486
/// </summary>
14871487
/// <exception cref="DocRaptor.Client.ApiException">Thrown when fails to make API call</exception>
14881488
/// <param name="id">The status_id returned when creating an asynchronous document.</param>
1489-
/// <returns>Task of ApiResponse (AsyncDocStatus)</returns>
1490-
public async System.Threading.Tasks.Task<ApiResponse<AsyncDocStatus>> GetAsyncDocStatusAsyncWithHttpInfo (string id)
1489+
/// <returns>Task of ApiResponse (DocStatus)</returns>
1490+
public async System.Threading.Tasks.Task<ApiResponse<DocStatus>> GetAsyncDocStatusAsyncWithHttpInfo (string id)
14911491
{
14921492
// verify the required parameter 'id' is set
14931493
if (id == null)
@@ -1540,9 +1540,9 @@ public async System.Threading.Tasks.Task<ApiResponse<AsyncDocStatus>> GetAsyncDo
15401540
if (exception != null) throw exception;
15411541
}
15421542

1543-
return new ApiResponse<AsyncDocStatus>(localVarStatusCode,
1543+
return new ApiResponse<DocStatus>(localVarStatusCode,
15441544
localVarResponse.Headers.ToDictionary(x => x.Name, x => x.Value.ToString()),
1545-
(AsyncDocStatus) this.Configuration.ApiClient.Deserialize(localVarResponse, typeof(AsyncDocStatus)));
1545+
(DocStatus) this.Configuration.ApiClient.Deserialize(localVarResponse, typeof(DocStatus)));
15461546
}
15471547

15481548
}

src/DocRaptor/Model/AsyncDocStatus.cs

Lines changed: 0 additions & 210 deletions
This file was deleted.

test/async.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ static void Main(string[] args) {
2121

2222
AsyncDoc response = docraptor.CreateAsyncDoc(doc);
2323

24-
AsyncDocStatus status_response;
24+
DocStatus status_response;
2525
while(true) {
2626
status_response = docraptor.GetAsyncDocStatus(response.StatusId);
2727
if (status_response.Status == "completed") {

test/hosted_async.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ static void Main(string[] args) {
2525

2626
AsyncDoc response = docraptor.CreateHostedAsyncDoc(doc);
2727

28-
AsyncDocStatus status_response;
28+
DocStatus status_response;
2929
while(true) {
3030
status_response = docraptor.GetAsyncDocStatus(response.StatusId);
3131
if (status_response.Status == "completed") {

0 commit comments

Comments
 (0)