API documentation doesn't list when /users and /zones API calls were introduced.
Bug #1270857 reported by
Adam Stokes
This bug affects 2 people
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| MAAS |
Won't Fix
|
High
|
Unassigned | ||
Bug Description
This is a documentation feature request to have the api list the revision of MAAS that supports the API calls. For example,
GET /users was introduced in revision 1722
GET /zones was introduced in revision 1782
Revision history for this message
| Raphaël Badin (rvb) wrote | #1 |
| Changed in maas: | |
| importance: | Undecided → High |
| status: | New → Triaged |
| tags: | added: doc |
| summary: |
- API documentation should list when a REST call was introduced + API documentation doesn't list when an API call was introduced. |
| summary: |
- API documentation doesn't list when an API call was introduced. + API documentation doesn't list when /users and /zones API calls were + introduced. |
| Changed in maas: | |
| status: | Triaged → Won't Fix |
To post a comment you must log in.
Thanks for filing this bug.
This relates to a discussion we had on the mailing list about how in the documentation we should refer to MAAS versions. The thing is that MAAS versions are created for each release and we were a bit wary that it might be to slow a cadence. In any case, I suggest we use both the MAAS version and the revision and say things like (for a new feature available in Trusty): "Available in MAAS 1.5 (revision 1782)".