Jump to: navigation, search

NovaSearchAPI

  • Launchpad Entry: NovaSpec:search-api
  • Created: 9 June 2011
  • Contributors: GlenCampbell

Summary

Proposed extension to the /servers resource to selectively query servers by wildcard match on the name or by IP address.

Release Note

This section should include a paragraph describing the end-user impact of this change. It is meant to be included in the release notes of the first release in which it is implemented. (Not all of these will actually be included in the release notes, at the release manager's discretion; but writing them is a useful exercise.)

It is mandatory.

Rationale

Support personnel often have incomplete information and need to find servers with partially-complete names.

User stories

Assumptions

Design

This extension adds three query parameters to the /servers resource

query
ip=
ip6=
name=

Use of two or more of these parameters should result in an error

Search results are restricted to servers owned by the specified user (or the entity specified in the URL, if performed by an administrator).

Implementation

Test/Demo Plan

This need not be added or completed until the specification is nearing beta.

Unresolved issues

(dabo): Is there a reason why the first two extensions describe what is being matched, while the last is simply "match", which describes nothing? Shouldn't it be something like "name" or "server_name"?

BoF agenda and discussion

Use this section to take notes during the BoF; if you keep it in the approved spec, use it for summarising what was discussed and note any options that were rejected.