Skip to content

Commit dac4c2f

Browse files
committed
Update from SAP DITA CMS (squashed):
commit 2ac266bfb26f228cc27cf011118f941a0645b189 Author: REDACTED Date: Wed Apr 20 12:39:47 2022 +0200 adding reuse badge commit 58a97b84ee9171a424a2aa83fc137484447eb541 Author: REDACTED Date: Thu Mar 17 00:25:16 2022 +0100 Update from SAP DITA CMS ( 2022-03-17_00:25:16 ) Project: loio1fc7083d86ec42b8b3fa2f32c5710ff8 (got1547457104944.project) * Project map: loio1fc7083d86ec42b8b3fa2f32c5710ff8 (emz1547456479853.ditamap) * Output: loiobdf0b7d671494b509f070328ade95558 * Buildable map: loioc85183ec55c34af38a018bd96438f273 (lyu1548852231569.ditamap) * Language: en-US commit 9b2b6aee498ae1ef0e7cf6a6a5fe941b64059913 Author: REDACTED Date: Sun Mar 13 21:48:43 2022 +0100 Update from SAP DITA CMS ( 2022-03-13_21:48:42 ) Project: loio1fc7083d86ec42b8b3fa2f32c5710ff8 (got1547457104944.project) * Project map: loio1fc7083d86ec42b8b3fa2f32c5710ff8 (emz1547456479853.ditamap) ################################################## [Remaining squash message was removed before commit...]
1 parent b04d5ab commit dac4c2f

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![REUSE status]()]()
1+
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-docs/api-style-guide)](https://api.reuse.software/info/github.com/SAP-docs/api-style-guide)
22

33
# Contributions to SAP API Style Guide
44

docs/30-rest-and-odata-api-documentation/api-details-3edef50.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Description
4343
</td>
4444
<td valign="top">
4545

46-
The name of the API. Must not exceed 80 characters.
46+
The name of the API. The length of the name must not exceed 80 characters.
4747

4848

4949

docs/30-rest-and-odata-api-documentation/operations-8f57974.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ An explanation of what the operation does, and its usage specifics, if any. It a
6666
> ### Note:
6767
> Avoid starting the description with "this operation/method"; rather start directly with a verb in the third-person form: adds, creates, updates, sets, saves, reads, represents, gets, returns, deletes, and so on.
6868
69+
Do not repeat or start the description with the summary description. This description continues the explanation of what the operation does . If you do not need to provide more information, do not add a description.
70+
6971

7072

7173
</td>

docs/api-deprecation-policy-65a10e3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ The UA developer reflects the product owner's decision in the UA deliverables.
271271
**In the SAP API Business Hub \(REST APIs\)**
272272

273273
- Review the language in the `notes` property of the change log.
274-
- Remove the documentation of the decommissioned version from the SAP API Business Hub and archive it on the SAP Help Portal.
274+
- Remove the link to the Help Portal documentation of the decommissioned version from the SAP API Business Hub, add *Decommissioned* to the title of your topic, and archive the topic somewhere in your documentation set.
275275

276276
**In an API Reference \(other APIs\)**
277277

0 commit comments

Comments
 (0)