Prefer "OpenAPI document" to "specification"

README.md

@@ -1,28 +1,26 @@
-# aep-explorer
+# AEP Explorer
 
-aep-explorer is a web interface used to interact with [aep-compliant](https://aep.dev) APIs.
+AEP Explorer is a web interface for exploring and interacting with [AEP-compliant](https://aep.dev) APIs.
 
-aep-explorer:
+AEP Explorer:
 
-- Provides a way to view the resources exposed by an API.
+- Provides a way to view the resources exposed by an API described by an OpenAPI document.
 - Enables exploration of the objects stored within a collection, including filtering.
 
 ## Live Demo
 
-aep-explorer is available at `https://ui.aep.dev/`.
+AEP Explorer is available at [ui.aep.dev](https://ui.aep.dev).
 
 ## User Guide
 
-The tool can be run online or deployed locally depending on
-[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS) settings.
-
-### Using ui.aep.dev
-
-For many users, visiting `https://ui.aep.dev` and entering the URL to an
-aep-compliant API of your choice is sufficient.
+The [online demo](https://ui.aep.dev) is the easiest way to try the project. 
+Simply use the form to enter the URL of an AEP-compliant.
 
 ### Running Locally
 
+For advanced users, the project can be deployed locally depending on
+[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS) settings.
+
 ```bash
 npm install
 npm run dev

src/components/oas-selector.tsx

@@ -20,7 +20,7 @@ interface SpecSpecifier {
   prefix?: string;
 }
 
-// A form to select an OpenAPI spec URL and set it in the application state.
+// A form to select an OpenAPI document URL and set it in the application state.
 export function OASSelector() {
   const [state, setState] = useState<SpecSpecifier>({ url: "", prefix: "" });
   const dispatch = useAppDispatch();
@@ -35,7 +35,7 @@ export function OASSelector() {
       );
       dispatch(setSchema(new OpenAPI(apiClient)));
     } catch (error) {
-      toast({description: `Failed to fetch OpenAPI spec: ${error}`})
+      toast({description: `Failed to fetch OpenAPI document: ${error}`})
     }
   };
 
@@ -66,14 +66,14 @@ export function OASSelector() {
             <li>Explore resource relationships and custom methods</li>
           </ul>
           <p className="pt-2">
-            Enter your AEP-compliant OpenAPI Spec URL below to get started.
+            Enter a URL for your AEP-compliant, OpenAPI document to get started.
           </p>
         </CardDescription>
       </CardHeader>
       <CardContent>
         <div className="grid gap-4">
           <div className="grid gap-2">
-            <Label htmlFor="spec">OpenAPI Spec URL</Label>
+            <Label htmlFor="spec">OpenAPI document URL</Label>
             <Input
               id="spec"
               type="url"
@@ -82,7 +82,7 @@ export function OASSelector() {
               required
             />
             <p className="text-xs text-muted-foreground">
-              The URL should point to a valid OpenAPI 3.0+ specification for an AEP-compliant API.
+              The URL should point to a valid OpenAPI 3.0+ document for an AEP-compliant API.
             </p>
           </div>
           <div className="grid gap-2">