Eduterm:Releases: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(uitfasering)
k (Admin heeft pagina OBKAPI:Releases hernoemd naar Eduterm:Releases)
 
(7 tussenliggende versies door een andere gebruiker niet weergegeven)
Regel 1: Regel 1:
 
Een overzicht van alle software releases. Voor de releases van het OBK is er een [[OBK:Releases|andere pagina]].
 
Een overzicht van alle software releases. Voor de releases van het OBK is er een [[OBK:Releases|andere pagina]].
   
== 0.8 ==
+
== v1.0 ~1 ==
  +
Deze 1.0 update verbeterd het gebruik van de ListQueries.
  +
{{ReleaseItem|improvement|ListQueries html view|In de browser wordt de ListQueries uitvoer als html getoond.}}
  +
{{ReleaseItem|improvement|ListQueries voorbeeldwaarden|Voor elke query kunnen voorbeeldwaarden worden meegegeven aan de ListQueries uitvoer.}}
  +
{{ReleaseItem|improvement|ListQueries query link|Op basis van de voorbeeldwaarden wordt in de html uitvoer van ListQueries een voorbeeld link gegeven.}}
  +
{{ReleaseItem|bugfix|http accept header|Een aantal bugs bij http accept request/responses zijn opgelost.}}
  +
  +
== v1.0 ==
  +
Deze release is voornamelijk een overgang van beta status naar productiedienst.
  +
{{ReleaseItem|improvement|http accept header ondersteuning|Het is nu mogelijk om de meeste uitvoerformaten te specificeren via een HTTP Accept Header.}}
  +
  +
=== changes ===
  +
Er zijn een aantal API wijzigingen die van belang kunnen zijn bij het migreren naar de 1.0.
  +
  +
==== format ====
  +
* Bij format=xml wordt het xml bestand in de browser ter download aangeboden, in 0.8 werd deze als xml bestand door de browser getoond.
  +
  +
==== endpoint ====
  +
* Het endpoint OBK is gewijzigd naar OBKProductie, dit is alleen van belang als het endpoint expliciet wordt meegegeven in queries. Default veranderd er niets.
  +
  +
==== foutmeldingen ====
  +
De 0.8 geeft of een error json terug (zie voorbeeld), of een HTTP status code (bijvoorbeeld 401 voor een niet-geauthentiseerde api key en alleen headers opvragen geeft altijd een 405).
  +
  +
<syntaxhighlight lang="javascript">
  +
{
  +
"Message": "An error has occurred.",
  +
"ExceptionMessage": "Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
  +
"ExceptionType": "System.FormatException",
  +
"StackTrace": " at System.Web.Http.ApiController.<InvokeActionWithExceptionFilters>d__1.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__0.MoveNext()"
  +
}
  +
</syntaxhighlight>
  +
  +
== v0.8 ==
 
Deze release bevat de volgende punten voor eindgebruikers. Versie 0.7 wordt uitgefaseerd als iedereen over is, maar uiterlijk op 1 december 2015.
 
Deze release bevat de volgende punten voor eindgebruikers. Versie 0.7 wordt uitgefaseerd als iedereen over is, maar uiterlijk op 1 december 2015.
 
{{ReleaseItem|improvement|stabieler backend|De RDF Store backend is dubbel uitgevoerd zodat we downtime kunnen minimaliseren bij OBK updates.}}
 
{{ReleaseItem|improvement|stabieler backend|De RDF Store backend is dubbel uitgevoerd zodat we downtime kunnen minimaliseren bij OBK updates.}}
Regel 9: Regel 41:
   
   
[[Categorie:OBK-API]]
+
[[Categorie:Eduterm]]

Huidige versie van 25 jun 2018 om 09:05

Een overzicht van alle software releases. Voor de releases van het OBK is er een andere pagina.

v1.0 ~1

Deze 1.0 update verbeterd het gebruik van de ListQueries.

Bullet wrench.png ListQueries html view
In de browser wordt de ListQueries uitvoer als html getoond.
Bullet wrench.png ListQueries voorbeeldwaarden
Voor elke query kunnen voorbeeldwaarden worden meegegeven aan de ListQueries uitvoer.
Bullet wrench.png ListQueries query link
Op basis van de voorbeeldwaarden wordt in de html uitvoer van ListQueries een voorbeeld link gegeven.
Bug.png http accept header
Een aantal bugs bij http accept request/responses zijn opgelost.

v1.0

Deze release is voornamelijk een overgang van beta status naar productiedienst.

Bullet wrench.png http accept header ondersteuning
Het is nu mogelijk om de meeste uitvoerformaten te specificeren via een HTTP Accept Header.

changes

Er zijn een aantal API wijzigingen die van belang kunnen zijn bij het migreren naar de 1.0.

format

  • Bij format=xml wordt het xml bestand in de browser ter download aangeboden, in 0.8 werd deze als xml bestand door de browser getoond.

endpoint

  • Het endpoint OBK is gewijzigd naar OBKProductie, dit is alleen van belang als het endpoint expliciet wordt meegegeven in queries. Default veranderd er niets.

foutmeldingen

De 0.8 geeft of een error json terug (zie voorbeeld), of een HTTP status code (bijvoorbeeld 401 voor een niet-geauthentiseerde api key en alleen headers opvragen geeft altijd een 405).

{
    "Message": "An error has occurred.",
    "ExceptionMessage": "Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
    "ExceptionType": "System.FormatException",
    "StackTrace": " at System.Web.Http.ApiController.<InvokeActionWithExceptionFilters>d__1.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__0.MoveNext()"
}

v0.8

Deze release bevat de volgende punten voor eindgebruikers. Versie 0.7 wordt uitgefaseerd als iedereen over is, maar uiterlijk op 1 december 2015.

Bullet wrench.png stabieler backend
De RDF Store backend is dubbel uitgevoerd zodat we downtime kunnen minimaliseren bij OBK updates.
Bullet wrench.png queries case sensitive
Vanaf 0.8 zijn de queries case-sensitive geworden.
Bullet wrench.png gui verbeteringen
Diverse verbeteringen in de gebruikersinterface, tbv. eindgebruikers maar ook query development.