Mark optional parameters in the Swagger API

This commit is contained in:
Eugene Burmakin 2024-08-28 20:36:56 +02:00
parent 932c9016d7
commit bd9fc7d30e
3 changed files with 15 additions and 2 deletions

View file

@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Map settings moved to the map itself and are available in the top right corner of the map under the gear icon.
## [0.12.1] — 2024-08-25
### Fixed

View file

@ -12,8 +12,8 @@ describe 'Points API', type: :request do
description: 'Start date (i.e. 2024-02-03T13:00:03Z or 2024-02-03)'
parameter name: :end_at, in: :query, type: :string,
description: 'End date (i.e. 2024-02-03T13:00:03Z or 2024-02-03)'
parameter name: :page, in: :query, type: :integer, description: 'Page number'
parameter name: :per_page, in: :query, type: :integer, description: 'Number of points per page'
parameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'
parameter name: :per_page, in: :query, type: :integer, required: false, description: 'Number of points per page'
response '200', 'points found' do
schema type: :array,
items: {

View file

@ -326,6 +326,18 @@ paths:
description: End date (i.e. 2024-02-03T13:00:03Z or 2024-02-03)
schema:
type: string
- name: page
in: query
required: false
description: Page number
schema:
type: integer
- name: per_page
in: query
required: false
description: Number of points per page
schema:
type: integer
responses:
'200':
description: points found