openstack/service-types-authority
Code Issues Proposed changes

docs: Clarify required vs optional keys

Browse Source 
Change-Id: I67559fe54ac91c39f67bf51a63deed927c0386e6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane
2025-06-27 10:16:32 +01:00
parent 4a9c58b1f1
commit 35600d5507
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/index.rst
View File

@@ -25,33 +25,33 @@ The information is also transformed into a JSON format and published to
https://service-types.openstack.org/service-types.json for ease of machine
interactions. The published format is different than the source format.
The published format contains five keys.
The published format contains the following keys.
version
``version`` (required)
An ISO Format Date Time string of the build time in UTC.
sha
``sha`` (required)
The git sha from which the file was built.
service_types
``services`` (required)
A list of all of the official service types.
forward
``forward`` (required)
A mapping of official service type to aliases. Only contains entries for
services that have aliaes.
reverse
``reverse`` (required)
A mapping of aliases to official service type.
primary_service_by_project
``primary_service_by_project`` (optional)
A mapping of project names to the primary service associated with that
project. Every project has only one primary service.
all_types_by_service_type
``all_types_by_service_type`` (optional)
A mapping of service type to a list containing the official service type
and all of its aliases. Contains an entry for every service.
service_types_by_project
``service_types_by_project`` (optional)
A mapping of project name to a list of all service types associated with
that project.