Project

Profile

Help

Issue #7355

closed

Add meanigful endpoint descriptions to the REST API docs

Added by quba42 about 2 years ago. Updated over 1 year ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version - Debian:
Platform Release:
Target Release - Debian:
OS:
Triaged:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:

Description

Currently the endpoint descriptions in the (auto generated) REST API documentation mostly read: "A ViewSet for <class_name>."

I believe meaningful descriptions, at least for the endpoints themselves, would be very beneficial to users.


Related issues

Related to Debian Support - Task #7318: Add a feature overview to the documentationCLOSED - CURRENTRELEASEquba42

Actions
Actions #1

Updated by quba42 about 2 years ago

  • Related to Task #7318: Add a feature overview to the documentation added
Actions #2

Updated by pulpbot about 2 years ago

  • Status changed from NEW to POST

Added by quba42 about 2 years ago

Revision 1d710e43

Add meaningful REST API endpoint descriptions

fixes #7355 https://pulp.plan.io/issues/7355

Actions #3

Updated by quba42 about 2 years ago

  • Status changed from POST to MODIFIED
Actions #4

Updated by quba42 about 2 years ago

  • Sprint/Milestone set to 2.6.0b1
Actions #5

Updated by quba42 over 1 year ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF