Skip to content
This repository was archived by the owner on Nov 13, 2021. It is now read-only.

Commit 9fd5481

Browse files
MassimoCtomkerkhove
authored andcommitted
update guidelines - typo (#77)
remarks updated. line removed
1 parent 1b3d8a4 commit 9fd5481

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

maturity-level-one/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -148,23 +148,21 @@ OpenAPI tooling, such as [AutoRest](https://github.com/Azure/autorest) & [NSwag]
148148
### Generating OpenAPI Documentation
149149
Every API should have documentation in the OpenAPI format. If you want to generate those based on your code you can use tools like [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle) & [NSwag](https://github.com/RSuter/NSwag).
150150

151-
Naming convention for **OperationId** is composed of `{Controller}_{OperationName}`
152-
153151
Here is an example on how to generate them with Swashbuckle
154152
```csharp
155153
/// <summary>
156154
/// Get Player Profiles
157155
/// </summary>
158156
/// <param name="topPlayersOnly">Indicates whether to return the top players only</param>
159-
/// <remarks>Operation description here</remarks>
157+
/// <remarks>Provides a profile for all known players</remarks>
160158
/// <returns>Return a list of Players</returns>
161159
[HttpGet(Name = "Players_GetPlayers")]
162160
[SwaggerResponse((int)HttpStatusCode.OK, "List of players")]
163161
[SwaggerResponse((int)HttpStatusCode.InternalServerError, "API is not available")]
164-
public IHttpActionResult GetPlayers(bool topPlayersOnly)
165-
{
166-
return Ok();
167-
}
162+
public IHttpActionResult GetPlayers(bool topPlayersOnly)
163+
{
164+
return Ok();
165+
}
168166

169167
```
170168
How xml comments and attributes are mapping to the OpenApi output

0 commit comments

Comments
 (0)