{"note":"OpenAPI conversion -- returning structured metadata","name":"vtex-local-headless-cms-api","description":"VTEX Headless CMS","version":"0.31.2","base_url":"https://storeframework.myvtex.com","endpoints":3,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api VTEX Headless CMS\n@base https://storeframework.myvtex.com\n@version 0.31.2\n@endpoints 3\n@toc _v(3)\n\n@endpoint GET /_v/cms/api/{projectId}\n@desc Get all content types\n@required {projectId: str # Project ID specified in the settings of the CMS (alpha) app.}\n@returns(200) {contentTypes: [map]} # OK\n@errors {404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /_v/cms/api/{projectId}/{content-type}\n@desc Get all CMS pages by content type\n@required {projectId: str # Project ID specified in the settings of the CMS (alpha) app., content-type: str # Content type identifier defined in the FastStore project.}\n@optional {page: str # The page number to retrieve in a paginated list of results. If not specified, the default return is 10 items per page., versionId: str # Version ID presented in the URL path of a CMS preview., releaseId: str # Release ID presented in the URL path of a CMS preview., filters[{field}]: str # Filter results by a property of the page (e.g., `filters[status]`) or by a nested custom field of the `parameters` object (e.g., `filters[parameters.collection.sort]`). *Replace {field} with the desired property.*}\n@returns(200) {hasNextPage: bool, totalItems: int, data: [map]} # OK\n@errors {404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /_v/cms/api/{projectId}/{content-type}/{document-id}\n@desc Get CMS page\n@required {projectId: str # Project ID specified in the settings of the CMS (alpha) app., content-type: str # Content type ID defined in the FastStore project., document-id: str # Document ID presented in the URL path of a CMS preview.}\n@optional {versionId: str # Version ID presented in the URL path of a CMS preview., releaseId: str # Release ID presented in the URL path of a CMS preview.}\n@returns(200) {id: str, name: str, type: str, status: str, versionId: str, versionStatus: str, sections: [map]} # OK\n@errors {404: Not Found, 500: Internal Server Error}\n\n@end\n"}