Verify Metadata and OpenAPI Specification Documents

1openapi: 3.0.0
2servers:
3 - url: /services/apexrest
4info:
5title: CaseManager
6 version: 1.0.0
7 description: This is an auto-generated OpenAPI v3 spec for CaseManager.
8paths:
9 /apex-rest-examples/v1/Cases/{caseId}:
10   description: Default description for the path.
11   get:
12     summary: Retrieve a case by its ID
13     description: Retrieve a case by its ID
14     operationId: getCaseById
15     parameters:
16       - name: caseId
17         in: path
18         required: true
19         description: The ID of the case to retrieve
20         schema:
21           type: string
22     responses:
23       "200":
24         description: Successful response
25         content:
26           application/json:
27             schema:
28               type: object
29               properties:
30                 CaseNumber:
31                   type: string
32                 Subject:
33                   type: string
34                 Status:
35                   type: string
36                 Origin:
37                   type: string
38                 Priority:
39                   type: string
40   delete:
41     summary: Delete a case
42     description: Deletes a case based on the provided case ID.
43     operationId: deleteCase
44     parameters:
45       - name: caseId
46         in: path
47         description: The ID of the case to delete
48         required: true
49         schema:
50           type: string
51     responses:
52       "204":
53         description: Case deleted successfully
54         content:
55           application/json:
56             schema:
57               type: object
58   patch:
59     summary: Update Case Fields
60     description: Update fields of a specific case identified by its ID.
61     operationId: updateCaseFields
62     parameters:
63       - name: caseId
64         in: path
65         description: The ID of the case to update
66         required: true
67         schema:
68           type: string
69     requestBody:
70       description: JSON object containing field names and their new values
71       required: true
72       content:
73         application/json:
74           schema:
75             type: object
76             properties:
77               subject:
78                 type: string
79               status:
80                 type: string
81               origin:
82                 type: string
83               priority:
84                 type: string
85     responses:
86       "200":
87         description: Successful update of the case
88         content:
89           application/json:
90             schema:
91               type: string
92 /apex-rest-examples/v1/Cases:
93   description: Default description for the path.
94   post:
95     summary: Create a new case
96     description: Creates a new case with the provided details.
97     operationId: createCase
98     requestBody:
99       description: Default description for the requestBody.
100       required: true
101       content:
102         application/json:
103           schema:
104             type: object
105             properties:
106               subject:
107                 type: string
108               status:
109                 type: string
110               origin:
111                 type: string
112               priority:
113                 type: string
114             required:
115               - subject
116               - status
117               - origin
118               - priority
119           description: Case creation details
120     responses:
121       "200":
122         description: Successfully created case
123         content:
124           application/json:
125             schema:
126               type: string
127   put:
128     summary: Upsert a case
129     description: Upsert a case based on the provided details.
130     operationId: upsertCase
131     requestBody:
132       description: Default description for the requestBody.
133       required: true
134       content:
135         application/json:
136           schema:
137             type: object
138             properties:
139               id:
140                 type: string
141               subject:
142                 type: string
143               status:
144                 type: string
145               origin:
146                 type: string
147               priority:
148                 type: string
149           description: Case details for upserting.
150     responses:
151       "200":
152         description: Successful operation
153         content:
154           application/json:
155             schema:
156               type: string

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalServiceRegistration xmlns="http://soap.sforce.com/2006/04/metadata">
3  <description>This is the ideal OpenAPI v3 specification for CaseManager.cls.</description>
4  <label>CaseManager</label>
5  <schemaType>OpenApi3</schemaType>
6  <schemaUploadFileExtension>yaml</schemaUploadFileExtension>
7  <schemaUploadFileName>casemanager_openapi</schemaUploadFileName>
8  <status>Complete</status>
9  <systemVersion>3</systemVersion>
10  <operations>
11    <name>getCaseById</name>
12    <active>true</active>
13  </operations>
14  <operations>
15    <name>createCase</name>
16    <active>true</active>
17  </operations>
18  <operations>
19    <name>deleteCase</name>
20    <active>true</active>
21  </operations>
22  <operations>
23    <name>upsertCase</name>
24    <active>true</active>
25  </operations>
26  <operations>
27    <name>updateCaseFields</name>
28    <active>true</active>
29  </operations>
30  <registrationProvider>CaseManager</registrationProvider>
31  <registrationProviderType>Custom</registrationProviderType>
32  <namedCredentialReference>null</namedCredentialReference>
33</ExternalServiceRegistration>

1...
2components:
3  schemas:
4    Pet:
5      x-sfdc:
6        agent:
7            action:
8                isDisplayable: true
9...