Project

General

Profile

Bug #1874

API: Outdated Swagger File

Added by Andreas Olschnögger 3 months ago. Updated 2 months ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Start date:
2022-11-15
Estimated time:
Found in version:

Description

The current swagger documentation seems to be not up to date.
https://app.swaggerhub.com/apis/ctot-nondef/OpenAtlas/0.3#/Entities/get_api_0_3_query_

For example the available values of of the column attribute are not correct:
According to the swagger documentation possible values are: 'id', 'classCode', 'name', 'description', 'created', 'modified', 'systemClass', 'beginFrom', 'beginTo', 'endFrom', 'endTo'
but only 'id', 'name', 'cidoc_class', 'system_class'.

It would be great if the swagger documentation would be updated.

Updated swagger:
https://app.swaggerhub.com/apis/ctot-nondef/OpenAtlas/0.4.1


Related issues

Related to OpenAtlas - Feature #1820: API: use existing GeoJSON definitions for swaggerClosed2022-09-28Actions
Blocks OpenAtlas - Feature #1749: API: Testsystems for API Acknowledged2022-06-14Actions

History

#1

Updated by Bernhard Koschiček-Krombholz 3 months ago

  • Tracker changed from Question to Feature
  • Target version set to 7.9.0

It is outdated and I wanted to redo it after the documentation was done. Was on my todo list but thank you for creating a ticket!

#2

Updated by Bernhard Koschiček-Krombholz 3 months ago

  • Status changed from Assigned to In Progress
#3

Updated by Bernhard Koschiček-Krombholz 3 months ago

  • Assignee changed from Bernhard Koschiček-Krombholz to Andreas Olschnögger

https://app.swaggerhub.com/apis/ctot-nondef/OpenAtlas/0.4.1

New file, completely rewritten. Structure changed, but hopefully to the better. Please test it, if everything is in order for Discovery.

#4

Updated by Bernhard Koschiček-Krombholz 3 months ago

#5

Updated by Bernhard Koschiček-Krombholz 3 months ago

  • Related to Feature #1820: API: use existing GeoJSON definitions for swagger added
#6

Updated by Bernhard Koschiček-Krombholz 3 months ago

  • Description updated (diff)
#7

Updated by Andreas Olschnögger 2 months ago

  • Status changed from In Progress to Closed

Thanks a lot for updating the swagger file.

I've implemented the new file to Discovery and it seems to work fine.

#8

Updated by Alexander Watzinger 2 months ago

  • Tracker changed from Feature to Bug
  • Found in version set to 7.8.0

Also available in: Atom PDF