Støtte beskrivelse av operasjoner for DataService

[sskagemo]

Det finnes ulike API-teknologier/typer (REST, SOAP, GraphQL, gRPC osv), og tilsvarende ulike spesifikasjonsspråk. DCAT DataService fanger opp mye av det som er felles for dem (title, description endpointURL, licence osv). Men en annen fellesnevner er at gjerne tilbyr en serie "operasjoner". Felles for disse igjen er at de har en inngang, noe data på vei inn og noe data på vei ut. Schema.org har elementer som er egnet for å beskrive operasjoner.

Se mer her:
https://www.linkedin.com/pulse/schemaorg-%25C3%25A5-beskrive-operasjoner-i-api-er-steinar-skagemo/

[sskagemo]

En mulighet er å ha lage en separat spesifikasjon, slik det allerede er separat spesifikasjon for kvalitetsbeskrivelse og informasjonsmodeller. Da trengs det ingen endring i selve DCAT-AP-NO-beskrivelsen, men vi kan raskt etablere støtte for operasjoner i katalogen.

:grunndata_ws # identifikator for DataService som det skal spesifiseres operasjoner for
  schema:potentialAction :hentBasisdata .

:hentBasisdata 
  a schema:Action;
  schema:name "Basisdata";
  schema:description "Inneholder organisasjonsnummer med registreringsdato, navn, forretningsadresse, postadresse, organisasjonsform, virksomhetens art eller bransje, vedtektsfestet formål, stiftelsesdato, målform, kontaktperson, daglig leder, forretningsfører, innehaver og informasjon om hovedforetak for Norskregistrert utenlandsk foretak (NUF)."@nb;
  schema:target [
    a schema:EntryPoint;
    schema:httpMethod "POST";
    schema:encodingType "application/xml"; # request
    schema:contentType "application/xml" # response    
  ]
.

For REST-tjenester kan target (av typen EntryPoint) også ha med egenskapen urlTemplate, så får vi tilsvarende visning av operasjoner som for OAS-filer idag, f.eks. GET /enheter/{orgnr}, se https://schema.org/urlTemplate