openapi-soekapi.json

{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://testdata.api.skatteetaten.no","description":"Generated server url"}],"security":[{"maskinporten":["skatteetaten:testnorge/testdata.read"]}],"paths":{"/soek/{kilde}/uthenting":{"get":{"tags":["soek-api"],"operationId":"uthenting","parameters":[{"name":"kilde","in":"path","required":true,"schema":{"type":"string"}},{"name":"kql","in":"query","description":"Spørring i Kibana Query Language format (https://www.elastic.co/guide/en/kibana/master/kuery-query.html)","required":false,"schema":{"type":"string"},"examples":{"To felter (and)":{"description":"To felter (and)","value":"felt1:verdi and felt2:verdi"},"To felter (or)":{"description":"To felter (or)","value":"felt1:verdi or felt2:verdi"},"Verdi i felt":{"description":"Verdi i felt","value":"felt:verdi"}}},{"name":"antall","in":"query","description":"Antall dokumenter returnert","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"side","in":"query","description":"Bla i resultat (bruk i kombinasjon med seed parameter for konsistent resultat","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"seed","in":"query","description":"Bruk i kombinasjon med side parameter for konsistent resultat (bruk seed returnert ved første sidevisning)","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resultat"}}}}}}},"/soek/{kilde}":{"get":{"tags":["soek-api"],"operationId":"soek_1","parameters":[{"name":"kilde","in":"path","required":true,"schema":{"type":"string"}},{"name":"vis","in":"query","description":"Angi hvilke felt som skal returneres","required":false,"schema":{"type":"array","items":{"type":"string"}},"examples":{"Vis alt":{"description":"Vis alt","value":"*"},"Vis felt":{"description":"Vis felt","value":"id"},"Vis felt i hierarki":{"description":"Vis felt i hierarki","value":"objekt.felt"}}},{"name":"skjul","in":"query","description":"Angi hvilke felt som skal skjules","required":false,"schema":{"type":"array","items":{"type":"string"}},"examples":{"Skjul felt i hierarki":{"description":"Skjul felt i hierarki","value":"objekt.felt"},"Skjul felt":{"description":"Skjul felt","value":"id"},"Skjul alt":{"description":"Skjul alt","value":"*"}}},{"name":"nokkelinformasjon","in":"query","description":"Shortcut for å vise samme felt som i nøkkelinformasjon i GUI. Overstyrer skjul/vis","required":false,"schema":{"type":"boolean"}},{"name":"kql","in":"query","description":"Spørring i Kibana Query Language format (https://www.elastic.co/guide/en/kibana/master/kuery-query.html)","required":false,"schema":{"type":"string"},"examples":{"To felter (and)":{"description":"To felter (and)","value":"felt1:verdi and felt2:verdi"},"To felter (or)":{"description":"To felter (or)","value":"felt1:verdi or felt2:verdi"},"Verdi i felt":{"description":"Verdi i felt","value":"felt:verdi"}}},{"name":"antall","in":"query","description":"Antall dokumenter returnert","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"side","in":"query","description":"Bla i resultat (bruk i kombinasjon med seed parameter for konsistent resultat","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"seed","in":"query","description":"Bruk i kombinasjon med side parameter for konsistent resultat (bruk seed returnert ved første sidevisning)","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resultat"}},"text/plain":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"Fasett":{"type":"object","properties":{"felt":{"type":"string"},"antall":{"type":"integer","format":"int64"},"ikkeAntall":{"type":"integer","format":"int64"},"fra":{"type":"object"},"til":{"type":"object"},"buckets":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}}},"Resultat":{"type":"object","properties":{"treff":{"type":"integer","format":"int64"},"rader":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"nesteSide":{"type":"integer","format":"int32"},"seed":{"type":"integer","format":"int32"},"dokumentListe":{"type":"array","items":{"type":"object"}},"fasetter":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Fasett"}}}}},"securitySchemes":{"maskinporten":{"type":"http","description":"Tilgang via maskinporten (oauth2) med scope skatteetaten:testnorge/testdata.read","scheme":"bearer","bearerFormat":"JWT"}}}}