Project

General

Profile

Actions

Feature #1516

closed

API: implement Google JSON style

Added by Christoph Hoffmann about 3 years ago. Updated almost 3 years ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Start date:
2021-05-17
Estimated time:

Description

We shortly talked about it initially but never made it explicit, however for ease of use in consuming applications I propose to use the Google JSON Style for the API output.

This specifically concerns the Property Naming which is a precondition to implement the linting/naming conventions in the current OpenAtlasDiscovery (origin) implementation.

Changed properties:

/api/0.2/type_tree/
  • type_tree -> typeTree
/api/0.2/content/
  • legal-notice -> legalNotice
  • site-name -> siteName
/api/0.2/usage/
  • system_class -> systemClass
  • node_entities -> nodeEntities
  • node_entities_all -> nodeEntitiesAll
  • subunit_hierarchy -> subunitHierarchy
Linked Place output
  • reference_system -> referenceSystem
  • system_class -> systemClass
Everything with pagination and results
  • result -> results
  • start_id -> startID
  • entity_per_page -> entitiesPerPage
  • total_pages -> totalPages

Updated the swagger file: https://app.swaggerhub.com/apis/ctot-nondef/OpenAtlas/0.2-develop

Actions

Also available in: Atom PDF