{"id":20111559,"url":"https://github.com/openstack/service-types-authority","last_synced_at":"2025-05-06T11:30:53.282Z","repository":{"id":66174864,"uuid":"51774620","full_name":"openstack/service-types-authority","owner":"openstack","description":"OpenStack Service Types Authority. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-05-08T19:25:16.000Z","size":76,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-09T19:41:33.974Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/service-types-authority","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openstack.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-15T18:01:29.000Z","updated_at":"2024-05-09T19:41:33.975Z","dependencies_parsed_at":"2023-02-21T06:01:19.204Z","dependency_job_id":null,"html_url":"https://github.com/openstack/service-types-authority","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fservice-types-authority","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fservice-types-authority/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fservice-types-authority/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fservice-types-authority/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/service-types-authority/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224499851,"owners_count":17321605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T18:16:31.172Z","updated_at":"2024-11-13T18:16:32.721Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=======================\nService Types Authority\n=======================\n\nThe following is a central authority for handing out service types to\nprojects for their services.\n\nEach OpenStack service with a REST API must have a well known service type.\nThe well known service type guarantees a documented API is available\nfor that service. Users of this service can trust that it will be the\nsame between different OpenStack environments.\n\nAttributes\n==========\n\nThe following attributes are required for a service type registration:\n\nservice-type (required)\n-----------------------\n\nThe unique identifier for the service to be used in the service catalog.\n\nproject (required)\n------------------\n\nThe name of the OpenStack project that contains the definition of the API\nclaimed by this service type. OpenStack project source code is found in\n`https://opendev.org/openstack/{project}`. If the API reference docs are\nnot found in the project repository, the `api_reference_project` field can be\nused to indicate the repository in which they are found.\n\napi_reference (required)\n------------------------\n\nA published API reference document for the API identified by this\nservice type. If not specified in the source yaml file, it will be generated\nas `https://docs.openstack.org/api-ref/{service-type}/`.\n\napi_reference_project (optional)\n--------------------------------\n\nAn OpenStack git project holding the source code for the project's API\nreference.\n\ndescription (optional)\n----------------------\n\nA short description about the service in question. It helps people\nreading only this document.\n\naliases (optional)\n------------------\n\nAn ordered list of historical aliases for this service type.\n\n.. note:: The list of aliases is **only** for communicating the existing\n          set of other names that services have gone by from the time before\n          this list existed. Changing a ``service-type`` is **VERY BAD** and\n          breaks users. It's important to list them so that everyone can\n          share in the knowledge of what to do with the clouds that are out\n          there, but seriously, putting things here is only for documenting\n          history, not for making new changes.\n\nA service must have one and only one known service type. However,\nthere are older names that have been commonly used for some services. In\norder for API consumers to be able to count on the Service Types Authority\nservice-type as an inbound interface they expect, ``aliases`` provides a\nordered list of known fallback names. If an API consumer cannot find a given\n``service-type`` in the ``service-catalog``, they are directed to try the\nlist of ``aliases`` here, in the order they are given, in order to find\nthe requested endpoint.\n\nsecondary (optional)\n--------------------\n\nIf secondary is set and is true, the project is not the primary service people\nassociate with the project codename. For instance, the ``nova`` project has\ntwo services, ``compute`` and ``placement``. ``compute`` is the primary\nproject. ``placement`` is secondary.\n\nNaming\n======\n\n.. note:: Established service types need not be forcefully retrofitted\n          to conform to these guidelines. For this reason you may see\n          entries such as ``ec2-api`` (contains a digit) or\n          ``clustering`` (an action, not a thing).\n\nNew service type names should:\n\n- Be English words\n- Match the regex ``^[a-z][a-z-]*[a-z]$``.\n- Be meaningful\n- Not use terms which are incredibly overloaded in OpenStack space\n  (e.g. policy)\n- Be a thing, not an action (e.g. load-balancer, not load-balancing)\n- Be singular instead of plural (e.g. image, not images)\n- Be unversioned (e.g. volume, not volumev2)\n\nNon Official Types in Service Catalog\n=====================================\n\nThe OpenStack Service Catalog can be used for listing services outside\nof the standardized service types. There will be no official registry\nof these types, so conflicts are possible. As such, the types should\ninclude an org prefix '$org:' where $org is something recognizable to\na particular organization and not part of the OpenStack ecosystem.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fservice-types-authority","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fservice-types-authority","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fservice-types-authority/lists"}