{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-registry-overview","__idx":0},"children":["API registry overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API registry serves as a single-source of truth for API definitions."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n API ||--|{ Versions : has\n Versions ||--|{ Branches : has\n Branches }|..|| Primary-branch : contains\n Branches ||..|{ Snapshots : has\n","diagramHtml":"

has

has

contains

has

API

Versions

Branches

Primary-branch

Snapshots

","diagramHtmlDark":"

has

has

contains

has

API

Versions

Branches

Primary-branch

Snapshots

"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api","__idx":1},"children":["API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add an API."," ","An API is represented by a \"name\" and is a concept that represents the set of use cases the underlying API will offer."," ","An API will have one or more versions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"versions","__idx":2},"children":["Versions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An API version maps to a specific OpenAPI definition."," ","A version may have more than one branch."," ","A branch loosely mimics a branch in git, where you may prepare a change."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A version will be connected to a source (such as GitHub)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A version has history. The version history logs and bundled versions are available."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"primary-branch","__idx":3},"children":["Primary branch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each version must specify the primary branch."," ","The primary branch maps to the production build."," ","Other branches map to preview builds."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a change occurs in the primary branch, it will trigger the validation, bundling, and then subsequent building of any connected OpenAPI definitions, API docs, and developer portal projects to production."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a change occurs in another active branch, it will trigger the validation, bundling, and then subsequent building of any connected OpenAPI definitions, API docs, and developer portal projects to a preview location."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When an active branch is deleted from the connected source, it will be removed from the active branches list."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"change-primary-branch","__idx":4},"children":["Change primary branch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may change the primary branch at any time from the version settings page."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"snapshots","__idx":5},"children":["Snapshots"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A snapshot refers to a bundled OpenAPI definition."," ","There may be many snapshots for any given branch."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-registry-links","__idx":6},"children":["API registry links"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Link to your bundled API definition (snapshot) from the registry in other API definitions or developer portals."," ","This helps to use your API definitions as a single-source-of-truth."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may link to a branch's latest snapshot, or a specific point-in-time snapshot."," ","Doing this will register the usage and dependency linkage."," ","That will automate previews and deployments upon changes to the dependency."," ","A specific \"point-in-time\" snapshot will not change, and therefore will not trigger further updates as a dependency."," ","A \"latest\" branch snapshot may change, and will trigger updates as a dependency."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"access-controls","__idx":7},"children":["Access controls"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API registry links to snapshots may be protected by access controls or available to the public."," ","Control access to your API registry links for each specific version from the settings."]}]},"frontmatter":{"excludeFromSearch":true,"seo":{"title":"Understanding the API registry basics"}},"tagList":[],"title":"Understanding the API registry basics","lastModified":"2025-08-10T02:58:02.000Z"}