Project

General

Profile

GX-Bug #69324

Adding more details about enums in REST API documentation

Added by Mirko Janssen about 1 year ago. Updated about 1 year ago.

Status:
Erledigt
Priority:
Normal
Category:
Dokumentation
Target version:
% Done:

0%

Estimated time:
Steps to reproduce:
Betroffene Versionen:
Unbestimmt
Release Notes Langtext:

Fehlende Beschreibungen für Auswahlwerte wurden der v3 API Dokumentation hinzugefügt.


Description

In the new developers' documentation for the REST API some endpoints are referencing enums but without a lot of information. In most cases only the allowed values are listed there but not what these values represent. Therefore, we should add additional information there so that external developers can better understand the enums and their allowed values.

History

#1

Updated by Mirko Janssen about 1 year ago

  • Status changed from In Bearbeitung to Testing
  • Assignee deleted (Mirko Janssen)
  • Target version set to 4.5.1.0
#3

Updated by Ahmed Hamouda about 1 year ago

  • Assignee set to Ahmed Hamouda
#4

Updated by Ahmed Hamouda about 1 year ago

  • Assignee deleted (Ahmed Hamouda)
#5

Updated by Alexandre Ataides about 1 year ago

  • Assignee set to Alexandre Ataides
#6

Updated by Alexandre Ataides about 1 year ago

  • Status changed from Testing to Erledigt
#7

Updated by Marvin Muxfeld about 1 year ago

  • Release Notes Langtext updated (diff)

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 5 MB)