Skip to content

Commit

Permalink
docs: add public-beta docs address search
Browse files Browse the repository at this point in the history
  • Loading branch information
ArneD committed Jan 24, 2025
1 parent 76ca321 commit df6b028
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/Public.Api/Address/Oslo/AddressController-Search.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ namespace Public.Api.Address.Oslo
using Microsoft.AspNetCore.Mvc.Infrastructure;
using Microsoft.Extensions.Options;
using RestSharp;
using Swashbuckle.AspNetCore.Annotations;
using Swashbuckle.AspNetCore.Filters;
using ProblemDetails = Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails;

Expand All @@ -26,7 +27,7 @@ public partial class AddressOsloController
private const int DefaultSearchLimit = 10;

/// <summary>
/// Zoeken naar adressen of straatnamen via een query.
/// Zoeken naar adressen of straatnamen via een query. (PUBLIC BETA)
/// </summary>
/// <param name="query">De zoek query.</param>
/// <param name="municipalityName">Filter op de gemeentenaam van de zoek query (exact) (optioneel).</param>
Expand Down Expand Up @@ -66,6 +67,9 @@ public partial class AddressOsloController
[HttpCacheValidation(NoCache = true, MustRevalidate = true, ProxyRevalidate = true)]
[HttpCacheExpiration(CacheLocation = CacheLocation.Private, MaxAge = DefaultListCaching, NoStore = true, NoTransform = true)]
[HttpGet("adressen/zoeken", Name = nameof(SearchAddresses))]
[SwaggerOperation(Description = "Zoek naar een straatnaam of adres met/zonder busnummer(s) binnen een gemeente of heel Vlaanderen.<br/>" +
"Autocompletion bevindt zich in public beta. Tijdens de public beta kan de functionaliteit nog veranderen en kunnen er onverwachte fouten of problemen optreden.<br/>" +
"Prestaties kunnen variëren en kunnen in de toekomst wijzigen naarmate updates en aanpassingen worden doorgevoerd.")]
public async Task<IActionResult> SearchAddresses(
[FromQuery(Name = "q")] string? query,
[FromQuery(Name="gemeenteNaam")] string? municipalityName,
Expand Down

0 comments on commit df6b028

Please sign in to comment.