Glossary
Commonly used terms and business domain language used in the Guides
API Specification Terminology
Throughout the Guides, we maintain consistent terminology by adopting the standard terms defined in the OpenAPI Specification.
| Term | Definition | Example | Additional Resources |
|---|---|---|---|
| Operation | A single API endpoint method (e.g., GET, POST) that performs a specific action. | GET /users — Retrieves a list of users. | OpenAPI Spec - Operations |
| Path | The relative URL endpoint on which operations are defined. | /listings/{listingId}/menus | OpenAPI Spec - Paths |
| Schema | A data model that defines the structure of request or response payloads. | JSON Schema defining a MenuItem object | OpenAPI Spec - Schema |
| Components | Reusable objects for schemas, parameters, responses, and more, defined globally. | Defining a reusable Error response used by multiple endpoints | OpenAPI Spec - Components |
| Response | The expected output from an operation, including status codes and payload schemas. | 200 OK with a JSON body containing user details | OpenAPI Spec - Responses |
| Request | The data sent to an API endpoint, including headers, body, and parameters. | POST body with a new Request_Body_MenuItem object | OpenAPI Spec - Request Body |
| Parameter | Inputs to operations that modify behavior or data returned; can be in path, query, header, or cookie. | Query parameter ?limit=10 to limit results | OpenAPI Spec - Parameters |
| Security Scheme | Defines authentication methods (e.g., API key, OAuth2) used by the API. | API key passed in header Authorization: Bearer <token> | OpenAPI Spec - Security |
| Tag | A label used to group operations logically, often for documentation organization. | Tagging all taxonomy-related endpoints as Taxonomy | OpenAPI Spec - Tags |
| Server | Specifies the base URL for API requests, which can vary by environment (production, staging, etc.). | https://api.example.com/v1 | OpenAPI Spec - Server |
| Example | Sample data provided to illustrate expected request or response payloads. | JSON example showing a valid MenuItem payload | OpenAPI Spec - Example |
| Callback | Defines asynchronous, out-of-band requests triggered by an API operation. | A webhook callback to notify client of status changes | OpenAPI Spec - Callback |
Weedmaps Domain Language
The core entities of the Menu API each have dedicated Guide Pages that provide context and detailed instructions on how to interact with them via the API. Additionally, we reference important terms that may not represent standalone entities or have their own operations but are essential for understanding the overall API structure.
Listing
Define what it is in context, and what it means to the Menu API and business domain.
We use the term listing but the visual display on the website is the Menu - the Listing represents the identifier on the Map and other retail location details.
Organization
Define what it is in context, and how to leverage the Menu operations to filter by and retrieve all Menus for an Organization.
Updated 4 days ago