Skip to content

docs: update info.description and x-sap-shortText for 37 swagger files#1853

Open
CelesteCasali wants to merge 4 commits into
SAP-docs:mainfrom
CelesteCasali:swagger-desc-update-20260720
Open

docs: update info.description and x-sap-shortText for 37 swagger files#1853
CelesteCasali wants to merge 4 commits into
SAP-docs:mainfrom
CelesteCasali:swagger-desc-update-20260720

Conversation

@CelesteCasali

Copy link
Copy Markdown
Member

Summary

Updates `info.description` and `x-sap-shortText` for 37 public API Swagger files in `src/api-explorer/`.

What changed

  • `x-sap-shortText`: rewritten to start with a third-person singular verb, max 180 chars, no colons, no trailing period, does not repeat the description
  • `info.description`: rewritten in CommonMark, includes usage scenarios, no time references, follows SAP Concur branding rules (SAP Concur platform/solutions/ecosystem; Concur Expense, Concur Request, Concur Travel, Concur Invoice as product names)
  • `InvoicePay.swagger2.json`: `x-sap-shortText` added — was missing entirely

APIs skipped

  • ExpenseGroupConfigurations (v3-0) — deprecated as of 06/26/2025

What did NOT change

  • No endpoints, schemas, parameters, or auth definitions modified
  • No formatting changes — only `info.description` and `x-sap-shortText` fields touched
  • No files outside `src/api-explorer/` touched

Updates description and shortText only. No formatting, schema,
endpoint, or auth changes.
Remove JWT references, fix empty descriptions, replace generic placeholder
text, and align shortText and description to be complementary without
repetition across all 29 api-explorer swagger files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant