Skip to content

Commit dbffe5b

Browse files
Add docs for "Play Request" feature in Software Catalog (#32006)
* Add docs for "Play Request" feature in Software Catalog * Update file name for image * Add files via upload * Accepting suggestion from review Co-authored-by: Heston Hoffman <[email protected]> * Accepting suggestion from review Co-authored-by: Heston Hoffman <[email protected]> --------- Co-authored-by: Heston Hoffman <[email protected]>
1 parent 59b1f3c commit dbffe5b

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

content/en/internal_developer_portal/software_catalog/entity_model/entity_types.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,6 @@ Add the OpenAPI definition under the spec field using `type: openapi`.
187187
{{< /code-block >}}
188188

189189
**File reference:**
190-
191190
Point to an OpenAPI file stored in GitHub using the `fileref` field.
192191

193192
{{< code-block lang="yaml" filename="entity.datadog.yaml" collapsible="true" >}}
@@ -219,9 +218,29 @@ The user-defined API appears in Software Catalog as shown:
219218

220219
This page holds relationship data of how the API interacts with dependencies, the API components, an OpenAPI preview, and logs and events aggregated across all endpoints.
221220

221+
**Test API Endpoints**
222+
223+
You can use the **Play Request** feature in Software Catalog to send test HTTP requests to your endpoints and inspect the responses.
224+
225+
To send a test request:
226+
227+
1. Navigate to an endpoint in Software Catalog.
228+
2. Click an endpoint to open its details in the side panel.
229+
3. Click **Play Request** to configure and send the request.
230+
231+
{{< img src="/tracing/software_catalog/play-request.png" alt="Play Request modal to test API requests in Software Catalog" style="width:90%;" >}}
232+
233+
Before sending the request, you can configure the following:
234+
- **Inputs**: Provide values for any required query parameters, path variables, or request body fields.
235+
- **Authentication**: Select an authentication method if required by the endpoint.
236+
- **Location**: Choose where the request should be sent from:
237+
- Public Location (default)
238+
- Private Location, for APIs accessible only within your private network. These must be configured using [Synthetics Private Locations][2]. Any Private Locations you've already set up appear automatically in the dropdown.
239+
222240
**Note**: Software Catalog contains HTTP endpoints that are automatically discovered by APM. The concept of endpoints correspond to [APM resources][1] for an APM web service.
223241

224242
[1]: /tracing/glossary/#resources
243+
[2]: /synthetics/platform/private_locations
225244

226245
{{% /tab %}}
227246

491 KB
Loading

0 commit comments

Comments
 (0)