Skip to content

Commit df8d8af

Browse files
Merge pull request #78641 from KingdomOfEnds/dt-refresh
swagger doc refreshed
2 parents 2e95e89 + ab1f71b commit df8d8af

File tree

6 files changed

+16
-25
lines changed

6 files changed

+16
-25
lines changed

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

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: alinast
66
ms.service: digital-twins
77
services: digital-twins
88
ms.topic: conceptual
9-
ms.date: 12/31/2018
9+
ms.date: 06/03/2019
1010
ms.author: v-adgera
1111
ms.custom: seodec18
1212
---
@@ -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][1]
40+
[![Swagger top](media/how-to-use-swagger/swagger_management_top.PNG)](media/how-to-use-swagger/swagger_management_top.PNG#lightbox)
4141

4242
Management API object models are also listed.
4343

44-
![Swagger models][2]
44+
[![Swagger models](media/how-to-use-swagger/swagger_management_models.PNG)](media/how-to-use-swagger/swagger_management_models.PNG#lightbox)
4545

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

48-
![Swagger model][3]
48+
[![Swagger model](media/how-to-use-swagger/swagger_management_model.PNG)](media/how-to-use-swagger/swagger_management_model.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][4]
62+
[![Swagger endpoints](media/how-to-use-swagger/swagger_management_endpoints.PNG)](media/how-to-use-swagger/swagger_management_endpoints.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][5]
72+
[![Swagger try](media/how-to-use-swagger/swagger_management_try.PNG)](media/how-to-use-swagger/swagger_management_try.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][6]
76+
[![Swagger tried](media/how-to-use-swagger/swagger_management_tried.PNG)](media/how-to-use-swagger/swagger_management_tried.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][7]
84+
[![Swagger response](media/how-to-use-swagger/swagger_management_response.PNG)](media/how-to-use-swagger/swagger_management_response.PNG#lightbox)
8585

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

@@ -113,31 +113,22 @@ To learn more about interactively testing requests protected by OAuth 2.0, see t
113113
114114
5. Copy the ID of your Azure AD app.
115115
116-
6. Click the Authorize button on your swagger page.
116+
After completing the Azure Active Directory registration:
117117
118-
![Swagger authorize button](../../includes/media/digital-twins-permissions/swagger-select-authorize-btn.png)
118+
6. Click the **Authorize** button on your swagger page.
119119
120-
7. Paste the application ID into the client_id field.
120+
[![Click the Swagger authorize button](media/how-to-use-swagger/swagger-select-authorize-btn.png)](media/how-to-use-swagger/swagger-select-authorize-btn.png#lightbox)
121121
122-
![Swagger client_id field](../../includes/media/digital-twins-permissions/swagger-auth-form.png)
122+
7. Paste the application ID into the **client_id** field.
123123
124-
![Swagger grant application permissions](../../includes/media/digital-twins-permissions/swagger-grant-application-permissions.png)
124+
[![Swagger client_id field](media/how-to-use-swagger/swagger-auth-form.png)](media/how-to-use-swagger/swagger-auth-form.png#lightbox)
125125
126-
8. You should now see the Bearer authentication token passed in the authorization header and the identity of the logged in user displayed in the result.
126+
8. You will then be redirected to the following success modal.
127127
128-
![Swagger token result](../../includes/media/digital-twins-permissions/swagger-token-example.png)
128+
[![Swagger redirect modal](media/how-to-use-swagger/swagger_auth_redirect.PNG)](media/how-to-use-swagger/swagger_auth_redirect.PNG#lightbox)
129129
130130
## Next steps
131131
132132
- To read more about Azure Digital Twins object models and the spatial intelligence graph, read [Understand Azure Digital Twins object models](./concepts-objectmodel-spatialgraph.md).
133133
134-
- To learn how to authenticate with your Management API, read [Authenticate with APIs](./security-authenticating-apis.md).
135-
136-
<!-- Images -->
137-
[1]: media/how-to-use-swagger/swagger_management_top.PNG
138-
[2]: media/how-to-use-swagger/swagger_management_models.PNG
139-
[3]: media/how-to-use-swagger/swagger_management_model.PNG
140-
[4]: media/how-to-use-swagger/swagger_management_endpoints.PNG
141-
[5]: media/how-to-use-swagger/swagger_management_try.PNG
142-
[6]: media/how-to-use-swagger/swagger_management_tried.PNG
143-
[7]: media/how-to-use-swagger/swagger_management_response.PNG
134+
- To learn how to authenticate with your Management API, read [Authenticate with APIs](./security-authenticating-apis.md).
Loading
46.8 KB
Loading
Binary file not shown.

0 commit comments

Comments
 (0)