Skip to content

Update API docs in IDP #31381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 29, 2025
Merged

Update API docs in IDP #31381

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c67cc28
Update API docs in IDP
amlakhanpal Aug 29, 2025
307bdce
Apply suggestions from docs review
amlakhanpal Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion content/en/internal_developer_portal/software_catalog/entity_model/entity_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,11 @@ In Software Catalog, an API (`kind:API`) refers to a collection of endpoints tha

To define components within an API, you can specify values for the `components` key in the `spec` field of the entity's v3 definition.

Example YAML for `kind:api`:
You can also include an OpenAPI spec in your entity definition in two ways: inline, or through a file reference.

**Inline:**
Add the OpenAPI definition under the spec field using `type: openapi`.

{{< code-block lang="yaml" filename="entity.datadog.yaml" collapsible="true" >}}
{
"apiVersion": "v3",
Expand Down Expand Up @@ -182,6 +186,34 @@ Example YAML for `kind:api`:
}
{{< /code-block >}}

**File reference:**

Point to an OpenAPI file stored in GitHub using the `fileref` field.

{{< code-block lang="yaml" filename="entity.datadog.yaml" collapsible="true" >}}
{
"apiVersion": "v3",
"kind": "api",
"metadata": {
"name": "payments",
"displayName": "Payments",
"owner": "Payments Team",
},
"spec": {
"type": "openapi",
"implementedBy": [
"service:payment",
"service:payments-go"
],
"interface": {
fileRef: https://github.com/openapi.yaml
},
"lifecycle": "production",
"tier": "Tier 0"
}
}
{{< /code-block >}}

The user-defined API appears in Software Catalog as shown:
{{< img src="/tracing/software_catalog/api-page-v3.png" alt="API page for Payments API in Software Catalog" style="width:90%;" >}}

Expand Down
Loading