Skip to content

Commit 51692c6

Browse files
committed
updated step and images swagger
1 parent 8a0c0e6 commit 51692c6

File tree

5 files changed

+11
-9
lines changed

5 files changed

+11
-9
lines changed

articles/digital-twins/how-to-use-swagger.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ The automatically generated Swagger reference material supplies a quick overview
3737

3838
A concise summary describes the API.
3939

40-
[![Swagger top](media/how-to-use-swagger/swagger-management-top-img.png)](media/how-to-use-swagger/swagger-management-top-img.png#lightbox)
40+
[![Swagger summary and API overview information](media/how-to-use-swagger/swagger-management-top-img.png)](media/how-to-use-swagger/swagger-management-top-img.png#lightbox)
4141

4242
Management API object models are also listed.
4343

44-
[![Swagger models](media/how-to-use-swagger/swagger-management-models-img.png)](media/how-to-use-swagger/swagger-management-models-img.png#lightbox)
44+
[![Swagger models listed at bottom of Swagger UI](media/how-to-use-swagger/swagger-management-models-img.png)](media/how-to-use-swagger/swagger-management-models-img.png#lightbox)
4545

4646
You can select each listed object model for a more detailed summary of key attributes.
4747

48-
[![Swagger model](media/how-to-use-swagger/swagger-management-model-img.png)](media/how-to-use-swagger/swagger-management-model-img.png#lightbox)
48+
[![Swagger models expanded to see contents of models](media/how-to-use-swagger/swagger-management-model-img.png)](media/how-to-use-swagger/swagger-management-model-img.png#lightbox)
4949

5050
The generated Swagger object models are convenient to see all available Azure Digital Twins [objects and APIs](./concepts-objectmodel-spatialgraph.md). Developers can use this resource when they build solutions on Azure Digital Twins.
5151

@@ -59,7 +59,7 @@ Each listed endpoint also includes the required request information, such as the
5959
* Required parameter data types.
6060
* HTTP method to access the resource.
6161

62-
[![Swagger endpoints](media/how-to-use-swagger/swagger-management-endpoints-img.png)](media/how-to-use-swagger/swagger-management-endpoints-img.png#lightbox)
62+
[![Swagger endpoints displayed in Swagger UI](media/how-to-use-swagger/swagger-management-endpoints-img.png)](media/how-to-use-swagger/swagger-management-endpoints-img.png#lightbox)
6363

6464
To see a more detailed overview, select each resource.
6565

@@ -69,19 +69,19 @@ One of the powerful functionalities Swagger provides is the ability to test an A
6969

7070
After you select a specific endpoint, you see **Try it out**.
7171

72-
[![Swagger try](media/how-to-use-swagger/swagger-management-try-img.png)](media/how-to-use-swagger/swagger-management-try-img.png#lightbox)
72+
[![Swagger Try it out button](media/how-to-use-swagger/swagger-management-try-img.png)](media/how-to-use-swagger/swagger-management-try-img.png#lightbox)
7373

7474
Expand that section to bring up input fields for each required and optional parameter. Enter the correct values, and select **Execute**.
7575

76-
[![Swagger tried](media/how-to-use-swagger/swagger-management-tried-img.png)](media/how-to-use-swagger/swagger-management-tried-img.png#lightbox)
76+
[![Swagger Try it out result example](media/how-to-use-swagger/swagger-management-tried-img.png)](media/how-to-use-swagger/swagger-management-tried-img.png#lightbox)
7777

7878
After you execute the test, you can validate the response data.
7979

8080
## Swagger response data
8181

8282
Each listed endpoint also includes response body data to validate your development and tests. These examples include the status codes and JSON you want to see for successful HTTP requests.
8383

84-
[![Swagger response](media/how-to-use-swagger/swagger-management-response-img.png)](media/how-to-use-swagger/swagger-management-response-img.png#lightbox)
84+
[![Swagger JSON response example](media/how-to-use-swagger/swagger-management-response-img.png)](media/how-to-use-swagger/swagger-management-response-img.png#lightbox)
8585

8686
The examples also include error codes to help debug or improve failing tests.
8787

@@ -92,7 +92,9 @@ The examples also include error codes to help debug or improve failing tests.
9292
9393
1. Follow the steps in [this quickstart](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v1-integrate-apps-with-azure-ad) to create and configure an Azure AD application. Alternatively, you can reuse an existing app registration.
9494

95-
1. Add the following reply url to the app registration:
95+
1. Add the following **Redirect url** to your Azure AD app registration:
96+
97+
[![Register Swagger redirect url in AAD](media/how-to-use-swagger/swagger-aad-redirect-url-registration.png)](media/how-to-use-swagger/swagger-aad-redirect-url-registration.png#lightbox)
9698

9799
```plaintext
98100
https://YOUR_SWAGGER_URL/ui/oauth2-redirect-html
@@ -101,7 +103,7 @@ The examples also include error codes to help debug or improve failing tests.
101103
|---------|---------|---------|
102104
| YOUR_SWAGGER_URL | Your Management REST API documentation URL found in the portal | `https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swagger` |
103105
104-
1. Copy the ID of your Azure AD app.
106+
1. Copy the **Client ID** of your Azure AD app.
105107
106108
After completing the Azure Active Directory registration:
107109
240 KB
Loading
28.8 KB
Loading
35.6 KB
Loading
-75.1 KB
Loading

0 commit comments

Comments
 (0)