Properties of @schema/WebAPI | Expected Type | Description |
---|---|---|
@schema/documentation | or | Further documentation describing the Web API in more detail. |
Properties inherited from @schema/Service | Expected Type | Description |
---|---|---|
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/areaServed | , , or | The geographic area where a service or offered item is provided. |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/availableChannel | A means of accessing the service (e.g. a phone bank, a web site, a location, etc.). | |
@schema/award | An award won by or for this item. | |
@schema/brand | or | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
@schema/broker | or | An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. |
@schema/category | , , or | A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
@schema/hasOfferCatalog | Indicates an OfferCatalog listing for this Organization, Person, or Service. | |
@schema/hoursAvailable | The hours during which this service or contact is available. | |
@schema/isRelatedTo | or | A pointer to another, somehow related product (or multiple products). |
@schema/isSimilarTo | or | A pointer to another, functionally similar product (or multiple products). |
@schema/logo | or | An associated logo. |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/produces | The tangible thing generated by the service, e.g. a passport, permit, etc. | |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/providerMobility | Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). | |
@schema/review | A review of the item. | |
@schema/serviceArea | , or | The geographic area where the service is provided. |
@schema/serviceAudience | The audience eligible for this service. | |
@schema/serviceOutput | The tangible thing generated by the service, e.g. a passport, permit, etc. | |
@schema/serviceType | or | The type of service being offered, e.g. veterans' benefits, emergency relief, etc. |
@schema/slogan | A slogan or motto associated with the item. | |
@schema/termsOfService | or | Human-readable terms of service documentation. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. | |
@schema/identifier | , or | The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |