Note Onion - 4 - API - NoteControllerSwashbuckeExamples

Here is the source code for NoteControllerSwashbuckleExamples.cs This is placed in the root folder of the Note.Api project

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
using Swashbuckle.AspNetCore.Filters;
using Note.Application.DTOs;
using Note.Shared;

namespace Notes.API
{
public class NoteControllerSwashbuckleExamples
{

public class NoteGetAllNotesAsync : IExamplesProvider<Result<List<NoteDto>>>
{
public Result<List<NoteDto>> GetExamples()
{
return new Result<List<NoteDto>> // Task<IActionResult>()
{
Model = new List<NoteDto>
{

new NoteDto {
CompanyKey = "0",
ApplicationKey="Vendor",
ApplicationSubKey = "1",
Dt = DateTime.Parse("2014-02-07"),
// Dt = new DateTime(2023, 01, 12), //"2023-01-12T08:00:00",
Note= "First Note",
NoteTypeEntity= new NoteTypeDto {
CompanyKey="0",
Id= 4,
NoteType= "NewsFlash",
ShowOnNew = true
},
Who= "maw",
Id= 1
},
new NoteDto {
CompanyKey = "0",
ApplicationKey="Vendor",
ApplicationSubKey = "1",
Dt = new DateTime(2023, 01, 12),
Note = "Jan 15 - they came into the office for the first visit.",
NoteTypeEntity = new NoteTypeDto {
NoteType = "Timeline",
ShowOnNew = false,
Id = 3
},
Who = "maw",
Id = 2
}
},
WasSuccessful = true,
Message = new StatusMessage
{
CorrelationId = Guid.NewGuid(),
Exception = null,
FriendlyMessage = "Retrieved all Notes records successfully",
DetailedMessage = "Retrieved all Notes records successfully",
MessageId = null,
Level = MessageLevel.Info
},
ResultId = 0,
StatusMessages = null,
CustomData = null
};
}
}


public class NoteGetOneExample : IExamplesProvider<Result<NoteDto>>
{
public Result<NoteDto> GetExamples()
{
return new Result<NoteDto>()
{
Model = new NoteDto
{
CompanyKey = "0",
ApplicationKey = "Vendor",
ApplicationSubKey = "1",
Dt = DateTime.Parse("2014-02-07"),
// Dt = new DateTime(2023, 01, 12), //"2023-01-12T08:00:00",
Note = "First Note",
NoteTypeEntity = new NoteTypeDto
{
CompanyKey = "0",
Id = 4,
NoteType = "NewsFlash",
ShowOnNew = true
},
Who = "maw",
Id = 1
},
WasSuccessful = true,
Message = new StatusMessage
{
CorrelationId = Guid.NewGuid(),
Exception = null,
FriendlyMessage = "Obtained Note record",
DetailedMessage = "Obtained Note record",
MessageId = null,
Level = MessageLevel.Info
},
ResultId = 0,
StatusMessages = null,
CustomData = null
};
}
}

public class NotePostExample : IExamplesProvider<NoteDto>
{
public NoteDto GetExamples()
{
return new NoteDto()
{
ApplicationKey = "Vendor",
ApplicationSubKey = "1",
Dt = DateTime.Parse("2014-02-07"),
// Dt = new DateTime(2023, 01, 12), //"2023-01-12T08:00:00",
Note = "A new Note added from Swashbuckle",
NoteTypeEntity = new NoteTypeDto
{
CompanyKey = "0",
Id = 4,
NoteType = "NewsFlash",
ShowOnNew = true
},
Who = "maw"
};
}
}


public class NotePostResultsExampleSuccess : IExamplesProvider<Result>
{
public Result GetExamples()
{
return new Result()
{
WasSuccessful = true,
Message = new StatusMessage
{
CorrelationId = Guid.NewGuid(),
Exception = null,
FriendlyMessage = "Note added Successfully",
DetailedMessage = "Note added Successfully",
MessageId = null,
Level = MessageLevel.Info
},
ResultId = 0,
StatusMessages = null,
CustomData = null
};
}
}

public struct packet400
{
public packet400(string type, string title, int status, string traceId, Dictionary<string, string[]> errors)
{
Type = type; Title = title; Status = status; TraceId = traceId; Errors = errors;
}
public string Type { get; }
public string Title { get; }
public int Status { get; }
public string TraceId { get; }
public Dictionary<string, string[]> Errors { get; }
}

public class NotePostResultsExampleError400 : IExamplesProvider<packet400>
{

public packet400 GetExamples()
{
// Create a sample error dictionary
var errorDictionary = new Dictionary<string, string[]>
{
{ "NoteType.ApplicationKey", new string[] { "NoteTypeViewModel.Application key is Required" } }
};

// Create a packet400 instance
var myPacket = new packet400(
type: "https://tools.ietf.org/html/rfc9110#section-15.5.1",
title: "One or more validation errors occurred.",
status: 400,
traceId: "00-0f5890f5048650b7b1abdaaddd81fe1f-58f831c1312ac1e1-00",
errors: errorDictionary
);

return myPacket;

}
}


public class NotePutExample : IExamplesProvider<NoteDto>
{
public NoteDto GetExamples()
{
return new NoteDto()
{
CompanyKey = "0",
ApplicationKey = "Vendor",
ApplicationSubKey = "1",
Dt = DateTime.Parse("2014-02-07"),
// Dt = new DateTime(2023, 01, 12), //"2023-01-12T08:00:00",
Note = "A new Note added from Swashbuckle, and then updated",
NoteTypeEntity = new NoteTypeDto
{
CompanyKey = "0",
Id = 4,
NoteType = "NewsFlash",
ShowOnNew = true
},
Who = "maw",
Id = 3
};
}
}

public class NoteDeleteResultsExampleSuccess : IExamplesProvider<Result>
{
public Result GetExamples()
{
return new Result()
{
WasSuccessful = true,
Message = new StatusMessage
{
CorrelationId = Guid.NewGuid(),
Exception = null,
FriendlyMessage = "Deleted Note record",
DetailedMessage = "Deleted Note record",
MessageId = null,
Level = MessageLevel.Info
},
ResultId = 0,
StatusMessages = null,
CustomData = null
};
}
}
}
}