Opened at 2021-05-02T19:12:48Z

Last modified at 2021-05-11T15:25:47Z

#3690 closed defect

Document new API — at Version 3

Reported by: maylee Owned by: maylee
Priority: normal Milestone: User Documentation Goals
Component: documentation Version: n/a
Keywords: Cc:
Launchpad Bug:

Description (last modified by maylee)

The documentation at /docs/frontends/webapi.rst needs to be deleted or rewritten after we replace the current API.

Change History (3)

comment:1 Changed at 2021-05-02T19:13:13Z by maylee

  • Owner set to maylee
  • Status changed from new to assigned

comment:2 Changed at 2021-05-02T23:32:38Z by exarkun

What problem would this rewrite address?

Also, the API it describes is bad and we should replace it with a new, different one.

comment:3 Changed at 2021-05-03T08:49:24Z by maylee

  • Description modified (diff)
  • Summary changed from Edit Web API documentation to Document new API

With that in mind, this rewrite can hold off until the API is replaced, and it would really be documentation for the new API. At any rate, whatever's at /docs/frontends/webapi.rst needs to be changed.

Ticket has been changed to reflect this perspective.

Note: See TracTickets for help on using tickets.