diff --git a/doc/source/index.rst b/doc/source/index.rst index 7f7d07b..8edee5e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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.