Versioner
| API | Rolle | I produktion | I specifikation | Reference |
|---|---|---|---|---|
| Provider API | Indgang | v0.6.5 | v0.6.6 | Provider API v0.6.5 |
| Search API | Profil af Provider API 8 af 54 operationer | v0.6.5 | — | Search API v0.6.5 |
| Content API | Profil af Provider API 4 af 54 operationer | v0.6.5 | — | Content API v0.6.5 |
| Vendor Consumer API | Indgang | v0.6.5 | — | Vendor API v0.6.5 |
Sådan læses tabellen
- I produktion er den version providere implementerer og klienter kan regne med i dag. Det er også den version referencen på dette site er genereret ud af.
- I specifikation er den version PLAS-teamet arbejder på. Den er ikke udgivet, og felter kan ændre sig indtil den er.
- Reference peger på den genererede dokumentation af produktionsversionen.
Ændrer PLAS Status sig i Confluence, fornyes kopien i repoet som en bevidst handling, og tabellen følger med.
Ét versionsnummer, fire API’er. De fire API’er udgives på samme nummer, og det er målt frem for antaget: Search og Content gik fra 0.6.4 til 0.6.5 uden en eneste strukturel ændring — kun versionsnummeret er nyt — mens Vendor sprang 0.6.4 over og gik direkte fra 0.6.3 til 0.6.5, hvor dens ene nye operation er præcis den PLAS Status noterer under v0.6.5.
Ældre versioner
Kun produktionsversionen har genererede sider. Ældre udgaver er stadig i drift hos providere, men har ingen reference her endnu — deres identifikatorer står derfor uden link. En reference-URL der først er udgivet, bliver ved med at virke, så ældre versioner tilføjes når behovet er afklaret; de fjernes ikke igen.
Sådan læses en version
- Ifølge PLAS Status er kildens tekst. Hvor kilden selv skriver »(Added) Patron API«, står det som mærker foran linjen.
- Ændringer i specifikationen står som én blok pr. API. »Flyttet« betyder at en operation har skiftet metode eller sti med samme
operationId; har den fået nytoperationId, står den som fjernet og tilføjet — det er hvad specifikationen siger. - Nul ændringer er også et resultat. En blok der siger at intet ændrede sig, siger at API’et fik et nyt versionsnummer og ellers stod stille.
- Versioner uden en specifikation i kopien viser kun kildens tekst og siger det.
Filteret over listen viser ét API ad gangen. Uden JavaScript står alle fire.
Ændringer pr. version
v0.6.6 I specifikation
Ifølge PLAS Status
Ingen changelog-tekst i PLAS Status for denne version.
Ingen specifikation i kopien for denne version — kun PLAS Status’ tekst.
v0.6.5 I produktion
Ifølge PLAS Status
- updated Patron API Replace GET /patron/authentication/identity-provider with POST /patron/authentication/identity-provider, and changed the return object
- added Patron API Added GET /patron/authentication/authenticate-token
- added Vendor API Added GET /callbacks/patron/auth
Ændringer i specifikationen — Provider API (fra v0.6.4)
Operationer
2 tilføjet
- POST
/patron/authentication/authenticate-tokenAuthenticatePatronByCodeAndCodeVerifier - POST
/patron/authentication/identity-providerGetPatronAuthenticationUrlByIdentityProvider
1 fjernet
- GET
/patron/authentication/identity-providerAuthenticatePatronByIdentityProvider
Skemaer
2 tilføjet
1 ændret
-
PatronAuthenticationIdentityProviderResponseBody- felt url (string (uri)) tilføjet
- felt patron fjernet
Ændringer i specifikationen — Search API (fra v0.6.4)
Ingen strukturelle ændringer mellem de to specifikationer.
Ændringer i specifikationen — Content API (fra v0.6.4)
Ingen strukturelle ændringer mellem de to specifikationer.
Ændringer i specifikationen — Vendor API (fra v0.6.3)
v0.6.4 I produktion
Ifølge PLAS Status
- added Content Added the Content Events API
Ændringer i specifikationen — Provider API (fra v0.6.3)
Operationer
3 tilføjet
- GET
/configuration/contentGetContentConfiguration - GET
/content/eventGetContentEvents - GET
/content/event/series/{seriesId}GetContentEventsInSeries
Skemaer
43 tilføjet
AddressAllDaySchedulingConfigurationContentApiConfigurationContentResponseBodyConfigurationContentWithApiContactInfoEventEventAdmissionEventAudienceEventBranchEventCategoryEventLocationEventLocationAtBranchEventLocationExternalEventOrganizerEventPriceCategoryEventPricingEventPricingPriceCategoriesEventPricingSimpleEventSchedulingEventSeriesEventStateGetContentEventsInSeriesResponseBodyGetContentEventsResponseBodyImageAltImageCreditImageFocalPointImageFocalPointHotspotImageOriginalImageTypeContentOpenAdmissionPromotedPromotedTypePromotedTypeEnumPromotedTypeLiteralQueryRelevantWorksRegistrationAdmissionRelatedEventsRelevantWorksTicketAdmissionTicketStateTimeSpanSchedulingWorksRelevantWorks
4 ændret
-
ConfigurationResponseBody- felt content (ConfigurationContentWithApi) tilføjet
-
LocationBranch- felt pickup (object) tilføjet
-
LocationsResponseBody- felt mainBranch er nu valgfrit
-
PatronAddress- form: object → Address
- felt city fjernet
- felt country fjernet
- felt postalCode fjernet
- felt street fjernet
Ændringer i specifikationen — Search API
Første vendorede udgave — ingen ældre at sammenligne med.
Ændringer i specifikationen — Content API
Første vendorede udgave — ingen ældre at sammenligne med.
v0.6.3 I produktion
Ifølge PLAS Status
Note fra PLAS Status: Expected release to production: Week 19
- Added mainBranch to /locations
- Added that it is recommended to use UUIDs as patron IDs
- Added suggestions on ways of controlling customers and vendors
- Added a security recommendation for patron authentication
- Added error code for "Consent has not been given for 'loan history'"
- Bugfix in GET /holdings, change explode from true to false, for the two parameters publicationId and showTo
- Added a general description of the response structure for endpoints that takes an array of ids
- Bugfix ensuring all query parameters are in snake case
- Added patron_id to /holdings
- Added pickupBranches to /locations, and removed branches[]->pickup->allow
- Added GET /patron/{patronId}/configuration containing reservation limits and pickupBranches so that pickup branches can differ between patrons.
- Added pickupBranches to /holdings, so that titles and items can overwrite pickup branches settings from /patron/{patronId}/configuration and /locations.
- Added "fulfillmentBy" to reservation and removed "isInterlibraryLoan"
- Added "acquiredFrom" to loan and removed "isInterlibraryLoan"
- Added "acquiredFrom" to checkout and removed "isInterlibraryLoan"
- Added "acquiredFrom" to checkin and removed "isInterlibraryLoan"
- Added "acquiredFrom" to fee and removed "isInterlibraryLoan"
- Added "acquiredFrom" to loan history and removed "isInterlibraryLoan", for both get loan history and add to loan history.
Ændringer i specifikationen — Provider API
Første vendorede udgave — ingen ældre at sammenligne med.
Ændringer i specifikationen — Vendor API
Første vendorede udgave — ingen ældre at sammenligne med.
v0.6.2 I produktion
Ifølge PLAS Status
- Bug fix in the description of AudienceTypeAgeGroupCode
- Added 'verified' to PatronEmail and PatronPhoneNumber
- Added 'fields' to ConfigurationPatron, including ConfigurationPatronFieldEmails, ConfigurationPatronFieldPhoneNumbers and ConfigurationPatronFieldPickupLocation
- Added errors code for if maxNumberOfEmailAddresses or maxNumberOfPhoneNumbers is exceeded
- Bug fix, change section to an array in PickupLocation, CheckOutOrInLocationWithoutNames and PickupLocationWithoutNames
- Added default patron list id
- Added minimum patron list id length
- Replaced PatronListItemWork and PatronListItemPublication with PatronListItemWorkAndPublication
Ingen specifikation i kopien for denne version — kun PLAS Status’ tekst.