Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Forbedringer OpenAPI-spec #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Forbedringer OpenAPI-spec #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 183 additions & 10 deletions specs/enhetsregisteret.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
}
],
"info": {
"description": "Teknisk beskrivelse av REST-tjenestene i Åpne Data fra Enhetsregisteret - Work in progress\n---\n\n## Ordbok\n### Enhetsregisteret\nRegister over grunndata om juridiske personer og andre enheter. Enhetsregisteret tildeler organisasjonsnummer for entydig identifisering av enheter.\n\n### Organisasjonsnummer\nNisifret nummer som entydig identifiserer enheter i Enhetsregisteret.\n\n### Enhet\nEnhet på øverste nivå i registreringsstrukturen i Enhetsregisteret. Eksempelvis enkeltpersonforetak, foreninger, selskap, sameier og andre som er registrert i Enhetsregisteret. Identifiseres med organisasjonsnummer.\n\n### Underenhet\nEnhet på laveste nivå i registreringsstrukturen i Enhetsregisteret. En underenhet kan ikke eksistere alene og har alltid knytning til en hovedenhet. Identifiseres med organisasjonsnummer.\n\n### Organisasjonsform\nOrganisasjonsform er virksomhetens formelle organisering og gir retningslinjer overfor blant annet ansvarsforhold, skatt, revisjonsplikt, rettigheter og plikter.\n\n### Næringskode\n[Næringskoder]: https://www.brreg.no/bedrift/naeringskoder/\n[Næringskoder] på brreg.no\n\n[Standard for næringsgruppering]: https://www.ssb.no/klass/klassifikasjoner/6\n[Standard for næringsgruppering]\n---\n\n## Versjonering\nDu kan velge major versjon ved å spesifisere HTTP Accept-headeren. Bruk headeren spesifisert i tabellen under. Hvis versjon ikke spesifiseres, vil man få siste versjon.\n<table>\n <thead>\n <tr>\n <th>API</th>\n <th>Header</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>/</td>\n <td>application/vnd.enhetsregisteret.v1+json</td>\n </tr>\n <tr>\n <td>/organisasjonsformer</td>\n <td>application/vnd.enhetsregisteret.organisasjonsform.v1+json</td>\n </tr>\n </tbody>\n</table>\n\n\n### Strategi\nVi skal normalt ikke bryte bakoverkompabiliteten med våre brukere. Likevel kan det være nødvendig i enkelte situasjoner, av for eksempel juridiske årsaker eller vedlikehold, å gjøre endringer som medfører et slikt brudd. Vi vil i dette tilfellet versjonere tjenesten slik at nyeste versjon vil være tilgjengelig sammen med forrige versjon.\n\n#### Dersom man ikke benytter versjonering i accept header, vil man få siste versjon.\n\nEldre versjon vil anses som utdatert/deprecated, og vil på sikt bli tatt bort. Ved behov for denne typen endringer vil vi forsøke å gi bruker god tid, og varsle om endringen i forkant. Se punkt om varsling.\n\n### Når innføres ny versjon\nVi vil innføre en ny versjon når vi introduserer en endring som påvirker bakoverkompabiliteten. Mindre endringer og patcher vil ikke medføre versjonsendring i header.\n\n### Når fjernes en versjon\nVi vil legge ut varsel/driftsmeldinger i god tid på følgende steder:\n- [Driftsmeldinger]: https://www.brreg.no/om-oss/driftsmeldinger/\n[Driftsmeldinger]\n- [RSS-feed]: https://www.brreg.no/produkter-og-tjenester/rss-feed/\n[RSS-feed].\n\nEksempel på endring som medfører versjonering:\n\n- Fjerne eller endre navn på et attributt i HTTP-responsen.\n\n- Fjerne eller endre navn på et REST endepunkt.\n\n---\n\n## Endringslogg\n<table>\n <thead>\n <tr>\n <th>Versjon</th>\n <th>Dato</th>\n <th>Endring</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>1.1.0</td>\n <td>14. august 2018</td>\n <td>Ny tjeneste /oppdateringer/enheter og /oppdateringer/underenheter</td>\n </tr>\n <tr>\n <td>1.0.0</td>\n <td>6. april 2018</td>\n <td>Produksjonssetting av ny åpne data tjeneste for Enhetsregisteret</td>\n </tr>\n </tbody>\n</table>\n",
"description": "Teknisk beskrivelse av REST-tjenestene i Åpne Data fra Enhetsregisteret - Work in progress\n---\n\n## Ordbok\n### Enhetsregisteret\nRegister over grunndata om juridiske personer og andre enheter. Enhetsregisteret tildeler organisasjonsnummer for entydig identifisering av enheter.\n\n### Organisasjonsnummer\nNisifret nummer som entydig identifiserer enheter i Enhetsregisteret.\n\n### Enhet\nEnhet på øverste nivå i registreringsstrukturen i Enhetsregisteret. Eksempelvis enkeltpersonforetak, foreninger, selskap, sameier og andre som er registrert i Enhetsregisteret. Identifiseres med organisasjonsnummer.\n\n### Underenhet\nEnhet på laveste nivå i registreringsstrukturen i Enhetsregisteret. En underenhet kan ikke eksistere alene og har alltid knytning til en hovedenhet. Identifiseres med organisasjonsnummer.\n\n### Organisasjonsform\nOrganisasjonsform er virksomhetens formelle organisering og gir retningslinjer overfor blant annet ansvarsforhold, skatt, revisjonsplikt, rettigheter og plikter.\n\n### Næringskode\n[Næringskoder]: https://www.brreg.no/bedrift/naeringskoder/\n[Næringskoder] på brreg.no\n\n[Standard for næringsgruppering]: https://www.ssb.no/klass/klassifikasjoner/6\n[Standard for næringsgruppering]\n---\n\n## Versjonering\nDu kan velge major versjon ved å spesifisere HTTP Accept-headeren. Bruk headeren spesifisert i tabellen under. Hvis versjon ikke spesifiseres, vil man få siste versjon.\n<table>\n <thead>\n <tr>\n <th>API</th>\n <th>Header</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>/</td>\n <td>application/vnd.enhetsregisteret.v1+json</td>\n </tr>\n <tr>\n <td>/organisasjonsformer</td>\n <td>application/vnd.brreg.enhetsregisteret.organisasjonsform.v1+json</td>\n </tr>\n </tbody>\n</table>\n\n\n### Strategi\nVi skal normalt ikke bryte bakoverkompabiliteten med våre brukere. Likevel kan det være nødvendig i enkelte situasjoner, av for eksempel juridiske årsaker eller vedlikehold, å gjøre endringer som medfører et slikt brudd. Vi vil i dette tilfellet versjonere tjenesten slik at nyeste versjon vil være tilgjengelig sammen med forrige versjon.\n\n#### Dersom man ikke benytter versjonering i accept header, vil man få siste versjon.\n\nEldre versjon vil anses som utdatert/deprecated, og vil på sikt bli tatt bort. Ved behov for denne typen endringer vil vi forsøke å gi bruker god tid, og varsle om endringen i forkant. Se punkt om varsling.\n\n### Når innføres ny versjon\nVi vil innføre en ny versjon når vi introduserer en endring som påvirker bakoverkompabiliteten. Mindre endringer og patcher vil ikke medføre versjonsendring i header.\n\n### Når fjernes en versjon\nVi vil legge ut varsel/driftsmeldinger i god tid på følgende steder:\n- [Driftsmeldinger]: https://www.brreg.no/om-oss/driftsmeldinger/\n[Driftsmeldinger]\n- [RSS-feed]: https://www.brreg.no/produkter-og-tjenester/rss-feed/\n[RSS-feed].\n\nEksempel på endring som medfører versjonering:\n\n- Fjerne eller endre navn på et attributt i HTTP-responsen.\n\n- Fjerne eller endre navn på et REST endepunkt.\n\n---\n",
"version": "1.0.0",
"title": "Åpne Data fra Enhetsregisteret - API Dokumentasjon",
"contact": {
Expand All @@ -32,6 +32,11 @@
"schema": {
"type": "string"
}
},
"application/vnd.brreg.enhetsregisteret.v1+json": {
"schema": {
"type": "string"
}
}
}
},
Expand Down Expand Up @@ -370,7 +375,12 @@
"content": {
"application/json": {
"schema": {
"type": "string"
"$ref": "#/components/schemas/_Enheter"
}
},
"application/vnd.brreg.enhetsregisteret.enhet.v1+json": {
"schema": {
"$ref": "#/components/schemas/_Enheter"
}
}
}
Expand Down Expand Up @@ -408,7 +418,7 @@
"$ref": "#/components/schemas/Enhet"
}
},
"application/vnd.enhetsregisteret.enhet.v1+json": {
"application/vnd.brreg.enhetsregisteret.enhet.v1+json": {
"schema": {
"$ref": "#/components/schemas/Enhet"
}
Expand Down Expand Up @@ -715,7 +725,12 @@
"content": {
"application/json": {
"schema": {
"type": "string"
"$ref": "#/components/schemas/_Underenheter"
}
},
"application/vnd.brreg.enhetsregisteret.underenhet.v1+json": {
"schema": {
"$ref": "#/components/schemas/_Underenheter"
}
}
}
Expand Down Expand Up @@ -747,7 +762,12 @@
"content": {
"application/json": {
"schema": {
"type": "string"
"$ref": "#/components/schemas/Underenhet"
}
},
"application/vnd.brreg.enhetsregisteret.underenhet.v1+json": {
"schema": {
"$ref": "#/components/schemas/Underenhet"
}
}
}
Expand Down Expand Up @@ -802,6 +822,11 @@
"description": "Oppdateringer på enheter fra Enhetsregisteret",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Enhet"
}
},
"application/vnd.brreg.enhetsregisteret.oppdatering.enhet.v1+json": {
"schema": {
"type": "string"
}
Expand Down Expand Up @@ -852,6 +877,11 @@
"description": "Oppdateringer på underenheter fra Enhetsregisteret",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Enhet"
}
},
"application/vnd.brreg.enhetsregisteret.oppdatering.underenhet.v1+json": {
"schema": {
"type": "string"
}
Expand All @@ -877,7 +907,7 @@
"$ref": "#/components/schemas/_Organisasjonsformer"
}
},
"application/vnd.enhetsregisteret.organisasjonsform.v1+json": {
"application/vnd.brreg.enhetsregisteret.organisasjonsform.v1+json": {
"schema": {
"$ref": "#/components/schemas/_Organisasjonsformer"
}
Expand Down Expand Up @@ -920,7 +950,7 @@
"$ref": "#/components/schemas/Organisasjonsform"
}
},
"application/vnd.enhetsregisteret.organisasjonsform.v1+json": {
"application/vnd.brreg.enhetsregisteret.organisasjonsform.v1+json": {
"schema": {
"$ref": "#/components/schemas/Organisasjonsform"
}
Expand All @@ -946,7 +976,12 @@
"content": {
"application/json": {
"schema": {
"type": "string"
"$ref": "#/components/schemas/_Organisasjonsformer"
}
},
"application/vnd.brreg.enhetsregisteret.organisasjonsform.v1+json": {
"schema": {
"$ref": "#/components/schemas/_Organisasjonsformer"
}
}
}
Expand All @@ -967,7 +1002,12 @@
"content": {
"application/json": {
"schema": {
"type": "string"
"$ref": "#/components/schemas/_Organisasjonsformer"
}
},
"application/vnd.brreg.enhetsregisteret.organisasjonsform.v1+json": {
"schema": {
"$ref": "#/components/schemas/_Organisasjonsformer"
}
}
}
Expand All @@ -981,6 +1021,52 @@
},
"components": {
"schemas": {
"Underenhet": {
"properties": {
"organisasjonsnummer": {
"type": "string"
},
"navn": {
"type": "string"
},
"organisasjonsform": {
"$ref": "#/components/schemas/Organisasjonsform"
},
"postadresse": {
"$ref": "#/components/schemas/Adresse"
},
"registreringsdatoEnhetsregisteret": {
"type": "string"
},
"registrertIMvaregisteret": {
"type": "boolean"
},
"naeringskode1": {
"$ref": "#/components/schemas/Naeringskode"
},
"naeringskode2": {
"$ref": "#/components/schemas/Naeringskode"
},
"naeringskode3": {
"$ref": "#/components/schemas/Naeringskode"
},
"antallAnsatte": {
"type": "integer"
},
"overordnetEnhet": {
"type": "string"
},
"oppstartsdato": {
"type": "string"
},
"beliggenhetsadresse": {
"$ref": "#/components/schemas/Adresse"
},
"_links": {
"$ref": "#/components/schemas/_Links"
}
}
},
"Enhet": {
"properties": {
"organisasjonsnummer": {
Expand All @@ -992,12 +1078,24 @@
"organisasjonsform": {
"$ref": "#/components/schemas/Organisasjonsform"
},
"hjemmeside": {
"type": "string"
},
"postadresse": {
"$ref": "#/components/schemas/Adresse"
},
"registreringsdatoEnhetsregisteret": {
"type": "string"
},
"registrertIMvaregisteret": {
"type": "boolean"
},
"frivilligMvaRegistrertBeskrivelser": {
"type": "array",
"items": {
"type": "string"
}
},
"naeringskode1": {
"$ref": "#/components/schemas/Naeringskode"
},
Expand All @@ -1010,6 +1108,9 @@
"antallAnsatte": {
"type": "integer"
},
"forretningsadresse": {
"$ref": "#/components/schemas/Adresse"
},
"stiftelsedato": {
"type": "string"
},
Expand Down Expand Up @@ -1041,7 +1142,35 @@
"type": "string"
},
"_links": {
"$ref": "#/components/schemas/Self"
"$ref": "#/components/schemas/_Links"
}
}
},
"Adresse": {
"properties": {
"land": {
"type": "string"
},
"landkode": {
"type": "string"
},
"postnummer": {
"type": "string"
},
"poststed": {
"type": "string"
},
"adresse": {
"type": "array",
"items": {
"type": "string"
}
},
"kommune": {
"type": "string"
},
"kommunenummer": {
"type": "string"
}
}
},
Expand All @@ -1065,6 +1194,40 @@
}
}
},
"_Enheter": {
"properties": {
"embedded": {
"$ref": "#/components/schemas/Enheter"
}
}
},
"Enheter": {
"properties": {
"enheter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Enhet"
}
}
}
},
"_Underenheter": {
"properties": {
"embedded": {
"$ref": "#/components/schemas/Underenheter"
}
}
},
"Underenheter": {
"properties": {
"enheter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Underenhet"
}
}
}
},
"_Organisasjonsformer": {
"properties": {
"embedded": {
Expand Down Expand Up @@ -1102,6 +1265,16 @@
}
}
},
"_Links": {
"properties": {
"self": {
"$ref": "#/components/schemas/Href"
},
"overordnetEnhet": {
"$ref": "#/components/schemas/Href"
}
}
},
"Href": {
"properties": {
"href": {
Expand Down
Loading