openstack
/
os-service-types
Code Issues Proposed changes
A library to handle official service types for OpenStack and their historical aliases.
3 Commits 1 Branch 8 Tags 792 KiB
Python 100%
Go to file
Monty Taylor 48a94e00a7
Implement fetching and accessor methods 
The ServiceTypes class is the main entry point for python programmers.
It should allow them to answer the questions they have about the data
without necessarily walking the structure. It can also return the raw
structure if people want to get at it.

We need to know the project codename for services for doing API doc
publication validation and also for being able to send legacy
microversion headers. The information is in the data, use it.

In order to construct and send microversion headers for projects with
aliases, we need to know ALL of the aliases plus the official name,
because we don't know which one of the values will be the correct name
the service is looking for for a given version. The microversion spec,
however, requires that consumers be able to handle a header that
contains a list of services and to ignore the ones it isn't looking for.

By providing a a list of all the possible values we make it easy to
construct a header for a service given a service_type that should work
for all known identifiers of the service and that is future compatible
with the service-type and microversion specifyier aligning.

Co-Authored-By: Doug Hellmann <doug@doughellmann.com>
Change-Id: I57641c9e3c27688b6d7709b1bb07292740d26659
 		2017-07-19 13:18:14 +09:00
doc/source Implement fetching and accessor methods 2017-07-19 13:18:14 +09:00
os_service_types Implement fetching and accessor methods 2017-07-19 13:18:14 +09:00
releasenotes Implement fetching and accessor methods 2017-07-19 13:18:14 +09:00
.coveragerc Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
.gitignore Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
.gitreview Added .gitreview 2017-07-07 09:49:43 +00:00
.mailmap Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
.testr.conf Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
CONTRIBUTING.rst Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
HACKING.rst Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
LICENSE Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
README.rst Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
requirements.txt Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
setup.cfg Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
setup.py Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00
test-requirements.txt Implement fetching and accessor methods 2017-07-19 13:18:14 +09:00
tox.ini Add cookiecutter boilerplate 2017-07-14 13:43:28 -04:00

README.rst

os-service-types

Python library for consuming OpenStack sevice-types-authority data

The OpenStack Service Types Authority contains information about official OpenStack services and their historical service-type aliases.

The data is in JSON and the latest data should always be used. This simple library exists to allow for easy consumption of the data, along with a built-in version of the data to use in case network access is for some reason not possible and local caching of the fetched data.