https://github.com/kkgthb/openapispec-sitecorecms

OpenAPI / Swagger example schemas for some Sitecore CMS APIs
https://github.com/kkgthb/openapispec-sitecorecms

Last synced: about 1 month ago
JSON representation

OpenAPI / Swagger example schemas for some Sitecore CMS APIs

• Host: GitHub
• URL: https://github.com/kkgthb/openapispec-sitecorecms
• Owner: kkgthb
• Created: 2024-09-12T12:22:54.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-31T10:22:20.000Z (about 2 months ago)
• Last Synced: 2024-10-31T10:31:14.935Z (about 2 months ago)
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Sitecore CMS doesn't provide OpenAPI/Swagger specification files for some of their most important REST APIs.

This repository contains some handwritten ones that do not reflect the full level of detail that _can_ be provided by these APIs.

However, they can be used to learn the most common request structure expectations of the most common API endpoints.

They also provide minimalist example responses that can be used to drive a mock server.

Endpoints documented:

1. Sitecore [XP Layout Service](https://doc.sitecore.com/xp/en/developers/hd/latest/sitecore-headless-development/layout-service.html) / [XM Cloud Layout Service](https://doc.sitecore.com/xmc/en/developers/xm-cloud/layout-service.html) ([see file in repo](layoutservice.yml), [see raw file](layoutservice.yml?raw=1), [see SwaggerUI](https://editor.swagger.io/?url=https://raw.githubusercontent.com/kkgthb/openapispec-sitecorecms/main/layoutservice.yml))