-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
122 lines (122 loc) · 3.02 KB
/
swagger.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
openapi: 3.0.3
info:
title: Regon Rest API
description: Regon Rest API standalone service
version: 1.0.0
servers:
- url: 'http://localhost:8080'
tags:
- name: Regon
paths:
/api/search/{nip}:
get:
tags:
- Regon
operationId: searchByNip
summary: Search company in REGON database by VAT identifying number
description: Search company in REGON database by VAT identifying number
parameters:
- name: nip
in: path
required: true
description: Unique identifier of the customer to retrieve
schema:
type: string
maxLength: 10
pattern: '^\d{10}$'
- name: X-REGON-API-KEY
in: header
schema:
type: string
maxLength: 20
minLength: 20
responses:
200:
description: Customer data
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerDTO'
400:
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
401:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
404:
description: When given NIP is not available in Regon database
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
500:
description: Internal server error
503:
description: When Regon service returns error other than "No data found for the specified search criteria"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
components:
schemas:
CustomerDTO:
type: object
properties:
nip:
type: string
maxLength: 10
pattern: '^\d{10}$'
regon:
type: string
maxLength: 14
nipStatus:
type: string
name:
type: string
maxLength: 2000
province:
type: string
maxLength: 200
district:
type: string
maxLength: 200
municipality:
type: string
maxLength: 200
city:
type: string
maxLength: 200
postCode:
type: string
maxLength: 12
street:
type: string
maxLength: 200
buildingNumber:
type: string
maxLength: 20
apartmentNumber:
type: string
maxLength: 10
type:
type: string
maxLength: 2
postOffice:
type: string
maxLength: 200
businessClosureDate:
type: string
format: date
ErrorDTO:
type: object
properties:
message:
type: string
code:
type: integer