Project

General

Profile

Actions

Feature #1981

closed

Manual: API

Added by Bernhard Koschiček-Krombholz over 1 year ago. Updated 10 months ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
Start date:
2023-03-03
Estimated time:

Description

The API section in the manual needs improvements. Please feel free to add something to that list or write a comment.

Done
  • Remove Linked Art example. Make instead a list of links to examples.
  • Parameter definitions are not useable in current table format
  • Some parameter, e.g. search (API_03), need an exhaustive description, that users know how to use them. Use old documentation API_03 for that
  • Make a section with examples
Actions #1

Updated by Bernhard Koschiček-Krombholz over 1 year ago

  • Description updated (diff)
Actions #2

Updated by Bernhard Koschiček-Krombholz over 1 year ago

  • Category changed from API to Documentation
Actions #3

Updated by Bernhard Koschiček-Krombholz over 1 year ago

  • Status changed from Acknowledged to Assigned
  • Assignee set to Bernhard Koschiček-Krombholz
Actions #4

Updated by Bernhard Koschiček-Krombholz 10 months ago

  • Description updated (diff)
  • Status changed from Assigned to In Progress
Actions #5

Updated by Bernhard Koschiček-Krombholz 10 months ago

  • Description updated (diff)
Actions #6

Updated by Bernhard Koschiček-Krombholz 10 months ago

  • Description updated (diff)

All suggestions are included. I will proofread everything and then it is done.

Actions #7

Updated by Bernhard Koschiček-Krombholz 10 months ago

  • Status changed from In Progress to Closed
Actions #8

Updated by Bernhard Koschiček-Krombholz 10 months ago

  • Description updated (diff)
Actions #9

Updated by Alexander Watzinger 10 months ago

Thank you for this. I compiled changes in the develop branch and uploaded it to the development demo: https://demo-dev.openatlas.eu/static/manual/technical/api.html

Actions

Also available in: Atom PDF