openapi: 3.0.3
info:
  title: Adresseoplysninger-API
  description: Api til at hente adresseoplysninger om DAR adgangsadresser.
  version: 3.1.4
servers:
- url: http://localhost:8080
paths:
  /adresse/{adresseId}:
    parameters:
    - $ref: '#/components/parameters/adresseId'
    get:
      deprecated: true
      tags:
      - adresse
      operationId: getAdresse
      responses:
        '200':
          description: Hent dansk adresse med DAR id. Dette endpoint er deprecated
            og v2 bør benyttes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/darAdresse'
  /adresse/v2/{adresseId}:
    parameters:
    - $ref: '#/components/parameters/adresseId'
    get:
      tags:
      - adresse
      operationId: getAdresseV2
      responses:
        '200':
          description: Hent dansk adresse med DAR id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/struktureretDanskAdresse'
  /adresse/{adresseId}/detaljer:
    parameters:
    - $ref: '#/components/parameters/adresseId'
    get:
      tags:
      - adresse
      operationId: getDetaljeretAdresse
      responses:
        '200':
          description: Hent adresse med subset af originale felter direkte fra dawa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/detaljeretAdresse'
security:
- bearerAuth: [
    ]
components:
  parameters:
    adresseId:
      name: adresseId
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    detaljeretAdresse:
      properties:
        id:
          $ref: '#/components/schemas/id'
        vejnavn:
          type: string
        husnummer:
          type: string
        etage:
          type: string
        doer:
          type: string
        postnummer:
          type: string
        postnummerNavn:
          type: string
        supplerendeBynavn:
          type: string
    darAdresse:
      deprecated: true
      x-namespace: dk.domstol.oas.common
      description: Repræsentation af adresse fra Dansk Adresse Register (DAR).
      required:
      - id
      - adresselinje
      - postnummer
      - by
      properties:
        id:
          $ref: '#/components/schemas/id'
        adresselinje:
          type: string
        postnummer:
          type: string
        by:
          type: string
        retskredsId:
          $ref: '#/components/schemas/retskredsId'
    struktureretDanskAdresse:
      description: Dansk struktureret adresse.
      x-namespace: dk.domstol.oas.common.adressev2
      required:
      - adresselinje
      - postnummer
      - postdistrikt
      properties:
        darId:
          $ref: '#/components/schemas/id'
        adresselinje:
          type: string
        postnummer:
          type: string
        postdistrikt:
          description: Navnet på postnummeret. Dette fremstilles typisk som sidste
            led, fx 2630 Taastrup.
          type: string
        supplerendeBynavn:
          description: 'Optionelt felt - typisk landsbyens navn eller andet lokalt
            stednavn der er fastsat af kommunen for at præcisere adressens beliggenhed
            indenfor postnummeret. Indgår som en del af den officielle adressebetegnelse.
            Indtil 34 tegn. Eksempel: ”Sønderholm”.'
          type: string
          maxLength: 34
    directionEnum:
      x-namespace: dk.domstol.oas.common
      type: string
      enum:
      - ASC
      - DESC
    id:
      type: string
      format: uuid
    retskredsId:
      description: Unikt ID for en given retskreds, der kan anvendes til identificering
        af en specifik retskreds i retskreds-service.
      type: string
      pattern: ^\d{4}$
    apiError:
      x-namespace: dk.domstol.oas.common
      required:
      - code
      - status
      - message
      - path
      - timestamp
      properties:
        code:
          description: Human readable HTTP status message.
          type: string
        status:
          description: HTTP status code.
          type: integer
        message:
          description: Message describing the error.
          type: string
        path:
          description: The path of the error.
          type: string
        timestamp:
          description: Date and time of the error.
          type: string
          format: date-time
        details:
          description: Detailed description of the error(s).
          type: array
          items:
            $ref: '#/components/schemas/details'
    details:
      type: string
  headers: {
    }
  responses: {
    }
  requestBodies: {
    }
