Copyright © 2015 the Linux Foundation. This specification is licensed under the The Apache License, Version 2.0. You may not use it except in accordance with that license. The source-of-truth for the specification is the GitHub markdown file referenced above.
1. (fka Swagger RESTful API Documentation Specification)
1.1. Version 2.0
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [!rfc2119].
The Swagger specification is licensed under The Apache License, Version 2.0.
2. Introductions
Swagger™ is a project used to describe and document RESTful APIs.
The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.
3. Revision History
| Version | Date | Notes |
|---|---|---|
| 2.0 | 2014-09-08 | Release of Swagger 2.0 |
| 1.2 | 2014-03-14 | Initial release of the formal document. |
| 1.1 | 2012-08-22 | Release of Swagger 1.1 |
| 1.0 | 2011-08-10 | First release of the Swagger Specification |
4. Definitions
4.1. Path Templating
Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters.4.2. Mime Types
Mime type definitions are spread across several resources. The mime type definitions should be in compliance with [rfc6838].Some examples of possible mime type definitions:
text/plain; charset=utf-8
application/json
application/vnd.github+json
application/vnd.github.v3+json
application/vnd.github.v3.raw+json
application/vnd.github.v3.text+json
application/vnd.github.v3.html+json
application/vnd.github.v3.full+json
application/vnd.github.v3.diff
application/vnd.github.v3.patch
4.3. HTTP Status Codes
The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are described by [rfc7231]section-6) and in the IANA Status Code Registry.5. Specification
5.1. Format
The files describing the RESTful API in accordance with the Swagger specification are represented as JSON objects and conform to the JSON standards. YAML, being a superset of JSON, can be used as well to represent a Swagger specification file.
For example, if a field is said to have an array value, the JSON array representation will be used:
{
"field" : [...]
}
While the API is described using JSON it does not impose a JSON input/output to the API itself.
All field names in the specification are case sensitive.
The schema exposes two types of fields. Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name. Patterned fields can have multiple occurrences as long as each has a unique name.
5.2. File Structure
The Swagger representation of the API is made of a single file. However, parts of the definitions can be split into separate files, at the discretion of the user. This is applicable for $ref
fields in the specification as follows from the JSON Schema definitions.
By convention, the Swagger specification file is named swagger.json
.
5.3. Data Types
Primitive data types in the Swagger Specification are based on the types supported by the JSON-Schema Draft 4. Models are described using the Schema Object which is a subset of JSON Schema Draft 4.
An additional primitive data type "file"
is used by the Parameter Object and the Response Object to set the parameter type or the response as being a file.
Primitives have an optional modifier property format
. Swagger uses several known formats to more finely define the data type being used. However, the format
property is an open string
-valued property, and can have any value to support documentation needs. Formats such as "email"
, "uuid"
, etc., can be used even though they are not defined by this specification. Types that are not accompanied by a format
property follow their definition from the JSON Schema (except for file
type which is defined above). The formats defined by the Swagger Specification are:
| Common Name | type
| format
| Comments |
|---|---|---|---|
| integer | integer
| int32
| signed 32 bits |
| long | integer
| int64
| signed 64 bits |
| float | number
| float
| |
| double | number
| double
| |
| string | string
| ||
| byte | string
| byte
| base64 encoded characters |
| binary | string
| binary
| any sequence of octets |
| boolean | boolean
| ||
| date | string
| date
| As defined by full-date - [!rfc3339]
|
| dateTime | string
| date-time
| As defined by date-time - [!rfc3339]
|
| password | string
| password
| Used to hint UIs the input needs to be obscured. |
5.4. Schema
5.4.1. Swagger Object
This is the root document object for the API specification. It combines what previously was the Resource Listing and API Declaration (version 1.2 and earlier) together into one document.
5.4.2. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| swagger | string
| Required. Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be "2.0" .
|
| info | Info Object | Required. Provides metadata about the API. The metadata can be used by the clients if needed. |
| host | string
| The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.
|
| basePath | string
| The base path on which the API is served, which is relative to the host . If it is not included, the API is served directly under the host . The value MUST start with a leading slash (/ ). The basePath does not support path templating.
|
| schemes | [string ]
| The transfer protocol of the API. Values MUST be from the list: "http" , "https" , "ws" , "wss" . If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
|
| consumes | [string ]
| A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types. |
| produces | [string ]
| A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types. |
| paths | Paths Object | Required. The available paths and operations for the API. |
| definitions | Definitions Object | An object to hold data types produced and consumed by operations. |
| parameters | Parameters Definitions Object | An object to hold parameters that can be used across operations. This property does not define global parameters for all operations. |
| responses | Responses Definitions Object | An object to hold responses that can be used across operations. This property does not define global responses for all operations. |
| securityDefinitions | Security Definitions Object | Security scheme definitions that can be used across the specification. |
| security | [Security Requirement Object] | A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition. |
| tags | [Tag Object] | A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared may be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique. |
| externalDocs | External Documentation Object | Additional external documentation. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
5.4.3. Info Object
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| title | string
| Required. The title of the application. |
| description | string
| A short description of the application. GFM syntax can be used for rich text representation. |
| termsOfService | string
| The Terms of Service for the API. |
| contact | Contact Object | The contact information for the exposed API. |
| license | License Object | The license information for the exposed API. |
| version | string
| Required Provides the version of the application API (not to be confused with the specification version). |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Info Object Example:
{
"title": "Swagger Sample App",
"description": "This is a sample server Petstore server.",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "API Support",
"url": "http://www.swagger.io/support",
"email"<EMAIL_ADDRESS>},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.1"
}
title: Swagger Sample App
description: This is a sample server Petstore server.
termsOfService: http://swagger.io/terms/
contact:
name: API Support
url: http://www.swagger.io/support
email<EMAIL_ADDRESS>license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.1
5.4.4. Contact Object
Contact information for the exposed API.
<IP_ADDRESS>. Fixed Fields
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Contact Object Example:
{
"name": "API Support",
"url": "http://www.swagger.io/support",
"email"<EMAIL_ADDRESS>}
name: API Support
url: http://www.swagger.io/support
email<EMAIL_ADDRESS>5.4.5. License Object
License information for the exposed API.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| name | string
| Required. The license name used for the API. |
| url | string
| A URL to the license used for the API. MUST be in the format of a URL. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. License Object Example:
{
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
5.4.6. Paths Object
Holds the relative paths to the individual endpoints. The path is appended to the basePath
in order to construct the full URL.
The Paths may be empty, due to ACL constraints.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| /{path} | Path Item Object | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the basePath in order to construct the full URL. Path templating is allowed.
|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Paths Object Example
{
"/pets": {
"get": {
"description": "Returns all pets from the system that the user has access to",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of pets.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/pet"
}
}
}
}
}
}
}
/pets:
get:
description: Returns all pets from the system that the user has access to
produces:
- application/json
responses:
'200':
description: A list of pets.
schema:
type: array
items:
$ref: '#/definitions/pet'
5.4.7. Path Item Object
Describes the operations available on a single path. A Path Item may be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| $ref | string
| Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. If there are conflicts between the referenced definition and this Path Item’s definition, the behavior is undefined. |
| get | Operation Object | A definition of a GET operation on this path. |
| put | Operation Object | A definition of a PUT operation on this path. |
| post | Operation Object | A definition of a POST operation on this path. |
| delete | Operation Object | A definition of a DELETE operation on this path. |
| options | Operation Object | A definition of a OPTIONS operation on this path. |
| head | Operation Object | A definition of a HEAD operation on this path. |
| patch | Operation Object | A definition of a PATCH operation on this path. |
| parameters | [Parameter Object | Reference Object] | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the Swagger Object’s parameters. There can be one “body” parameter at most. |
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Path Item Object Example
{
"get": {
"description": "Returns pets based on ID",
"summary": "Find pets by ID",
"operationId": "getPetsById",
"produces": [
"application/json",
"text/html"
],
"responses": {
"200": {
"description": "pet response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Pet"
}
}
},
"default": {
"description": "error payload",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of pet to use",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
]
}
get:
description: Returns pets based on ID
summary: Find pets by ID
operationId: getPetsById
produces:
- application/json
- text/html
responses:
'200':
description: pet response
schema:
type: array
items:
$ref: '#/definitions/Pet'
default:
description: error payload
schema:
$ref: '#/definitions/ErrorModel'
parameters:
- name: id
in: path
description: ID of pet to use
required: true
type: array
items:
type: string
collectionFormat: csv
5.4.8. Operation Object
Describes a single API operation on a path.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| tags | [string ]
| A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. |
| summary | string
| A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters. |
| description | string
| A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation. |
| externalDocs | External Documentation Object | Additional external documentation for this operation. |
| operationId | string
| Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions. |
| consumes | [string ]
| A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
|
| produces | [string ]
| A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
|
| parameters | [Parameter Object | Reference Object] | A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the Swagger Object’s parameters. There can be one “body” parameter at most. |
| responses | Responses Object | Required. The list of possible responses as they are returned from executing this operation. |
| schemes | [string ]
| The transfer protocol for the operation. Values MUST be from the list: "http" , "https" , "ws" , "wss" . The value overrides the Swagger Object schemes definition.
|
| deprecated | boolean
| Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false .
|
| security | [Security Requirement Object] | A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security . To remove a top-level security declaration, an empty array can be used.
|
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Operation Object Example
{
"tags": [
"pet"
],
"summary": "Updates a pet in the store with form data",
"description": "",
"operationId": "updatePetWithForm",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet that needs to be updated",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "formData",
"description": "Updated name of the pet",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "formData",
"description": "Updated status of the pet",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Pet updated."
},
"405": {
"description": "Invalid input"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
tags:
- pet
summary: Updates a pet in the store with form data
description: ""
operationId: updatePetWithForm
consumes:
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
parameters:
- name: petId
in: path
description: ID of pet that needs to be updated
required: true
type: string
- name: name
in: formData
description: Updated name of the pet
required: false
type: string
- name: status
in: formData
description: Updated status of the pet
required: false
type: string
responses:
'200':
description: Pet updated.
'405':
description: Invalid input
security:
- petstore_auth:
- write:pets
- read:pets
5.4.9. External Documentation Object
Allows referencing an external resource for extended documentation.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| description | string
| A short description of the target documentation. GFM syntax can be used for rich text representation. |
| url | string
| Required. The URL for the target documentation. Value MUST be in the format of a URL. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. External Documentation Object Example
{
"description": "Find more info here",
"url": "https://swagger.io"
}
description: Find more info here
url: https://swagger.io
5.4.10. Parameter Object
Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
There are five possible parameter types.
- Path - Used together with Path Templating, where the parameter value is actually part of the operation’s URL. This does not include the host or base path of the API. For example, in
/items/{itemId}
, the path parameter isitemId
. - Query - Parameters that are appended to the URL. For example, in
/items?id=###
, the query parameter isid
. - Header - Custom headers that are expected as part of the request.
- Body - The payload that’s appended to the HTTP request. Since there can only be one payload, there can only be one body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation.
-
Form - Used to describe the payload of an HTTP request when either
application/x-www-form-urlencoded
,multipart/form-data
or both are used as the content type of the request (in Swagger’s definition, theconsumes
property of an operation). This is the only parameter type that can be used to send files, thus supporting thefile
type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form parameters have a different format based on the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):application/x-www-form-urlencoded
- Similar to the format of Query parameters but as a payload. For example,foo=1&bar=swagger
- bothfoo
andbar
are form parameters. This is normally used for simple parameters that are being transferred.multipart/form-data
- each parameter takes a section in the payload with an internal header. For example, for the headerContent-Disposition: form-data; name="submit-name"
the name of the parameter issubmit-name
. This type of form parameters is more commonly used for file transfers.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| name | string
|
Required. The name of the parameter. Parameter names are case sensitive.
|
| in | string
| Required. The location of the parameter. Possible values are “query”, “header”, “path”, “formData” or “body”. |
| description | string
| A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation. |
| required | boolean
| Determines whether this parameter is mandatory. If the parameter is in “path”, this property is required and its value MUST be true . Otherwise, the property MAY be included and its default value is false .
|
If in
is "body"
:
| Field Name | Type | Description |
|---|---|---|
| schema | Schema Object | Required. The schema defining the type used for the body parameter. |
If in
is any value other than "body"
:
| Field Name | Type | Description |
|---|---|---|
| type | string
| Required. The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of "string" , "number" , "integer" , "boolean" , "array" or "file" . If type is "file" , the consumes MUST be either "multipart/form-data" , " application/x-www-form-urlencoded" or both and the parameter MUST be in "formData" .
|
| format | string
| The extending format for the previously mentioned type . See Data Type Formats for further details.
|
| allowEmptyValue | boolean
| Sets the ability to pass empty-valued parameters. This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. Default value is false .
|
| items | Items Object | Required if type is “array”. Describes the type of items in the array.
|
| collectionFormat | string
|
Determines the format of the array if type array is used. Possible values are:
csv .
|
| default | * | Declares the value of the parameter that the server will use if none is provided, for example a “count” to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: “default” has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for this parameter.
|
| maximum | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. |
| exclusiveMaximum | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. |
| minimum | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. |
| exclusiveMinimum | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. |
| maxLength | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. |
| minLength | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. |
| pattern | string
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. |
| maxItems | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. |
| minItems | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. |
| uniqueItems | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. |
| enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. |
| multipleOf | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. |
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Parameter Object Examples
<IP_ADDRESS>.1. Body Parameters
A body parameter with a referenced schema definition (normally for a model definition):
{
"name": "user",
"in": "body",
"description": "user to add to the system",
"required": true,
"schema": {
"$ref": "#/definitions/User"
}
}
name: user
in: body
description: user to add to the system
required: true
schema:
$ref: '#/definitions/User'
A body parameter that is an array of string values:
{
"name": "user",
"in": "body",
"description": "user to add to the system",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
name: user
in: body
description: user to add to the system
required: true
schema:
type: array
items:
type: string
<IP_ADDRESS>.2. Other Parameters
A header parameter with an array of 64 bit integer numbers:
{
"name": "token",
"in": "header",
"description": "token to be passed as a header",
"required": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "csv"
}
name: token
in: header
description: token to be passed as a header
required: true
type: array
items:
type: integer
format: int64
collectionFormat: csv
A path parameter of a string value:
{
"name": "username",
"in": "path",
"description": "username to fetch",
"required": true,
"type": "string"
}
name: username
in: path
description: username to fetch
required: true
type: string
An optional query parameter of a string value, allowing multiple values by repeating the query parameter:
{
"name": "id",
"in": "query",
"description": "ID of the object to fetch",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
name: id
in: query
description: ID of the object to fetch
required: false
type: array
items:
type: string
collectionFormat: multi
A form data with file type for a file upload:
{
"name": "avatar",
"in": "formData",
"description": "The avatar of the user",
"required": true,
"type": "file"
}
name: avatar
in: formData
description: The avatar of the user
required: true
type: file
<IP_ADDRESS>. Items Object
A limited subset of JSON-Schema’s items object. It is used by parameter definitions that are not located in
"body"
.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| type | string
| Required. The internal type of the array. The value MUST be one of "string" , "number" , "integer" , "boolean" , or "array" . Files and models are not allowed.
|
| format | string
| The extending format for the previously mentioned type . See Data Type Formats for further details.
|
| items | Items Object | Required if type is “array”. Describes the type of items in the array.
|
| collectionFormat | string
|
Determines the format of the array if type array is used. Possible values are:
csv .
|
| default | * | Declares the value of the item that the server will use if none is provided. (Note: “default” has no meaning for required items.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the data type.
|
| maximum | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. |
| exclusiveMaximum | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. |
| minimum | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. |
| exclusiveMinimum | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. |
| maxLength | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. |
| minLength | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. |
| pattern | string
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. |
| maxItems | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. |
| minItems | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. |
| uniqueItems | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. |
| enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. |
| multipleOf | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Items Object Examples
Items must be of type string and have the minimum length of 2 characters:
{
"type": "string",
"minLength": 2
}
type: string
minLength: 2
An array of arrays, the internal array being of type integer, numbers must be between 0 and 63 (inclusive):
{
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 63
}
}
type: array
items:
type: integer
minimum: 0
maximum: 63
5.4.11. Responses Object
A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.
The default
can be used as the default response object for all HTTP codes that are not covered individually by the specification.
The Responses Object
MUST contain at least one response code, and it SHOULD be the response for a successful operation call.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| default | Response Object | Reference Object | The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. Reference Object can be used to link to a response that is defined at the Swagger Object’s responses section. |
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {HTTP Status Code} | Response Object | Reference Object | Any HTTP status code can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. Reference Object can be used to link to a response that is defined at the Swagger Object’s responses section. |
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Responses Object Example
A 200 response for successful operation and a default response for others (implying an error):
{
"200": {
"description": "a pet to be returned",
"schema": {
"$ref": "#/definitions/Pet"
}
},
"default": {
"description": "Unexpected error",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
'200':
description: a pet to be returned
schema:
$ref: '#/definitions/Pet'
default:
description: Unexpected error
schema:
$ref: '#/definitions/ErrorModel'
5.4.12. Response Object
Describes a single response from an API Operation.<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| description | string
| Required. A short description of the response. GFM syntax can be used for rich text representation. |
| schema | Schema Object | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be "file" . This SHOULD be accompanied by a relevant produces mime-type.
|
| headers | Headers Object | A list of headers that are sent with the response. |
| examples | Example Object | An example of the response message. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Response Object Examples
Response of an array of a complex type:
{
"description": "A complex object array response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VeryComplexType"
}
}
}
description: A complex object array response
schema:
type: array
items:
$ref: '#/definitions/VeryComplexType'
Response with a string type:
{
"description": "A simple string response",
"schema": {
"type": "string"
}
}
description: A simple string response
schema:
type: string
Response with headers:
{
"description": "A simple string response",
"schema": {
"type": "string"
},
"headers": {
"X-Rate-Limit-Limit": {
"description": "The number of allowed requests in the current period",
"type": "integer"
},
"X-Rate-Limit-Remaining": {
"description": "The number of remaining requests in the current period",
"type": "integer"
},
"X-Rate-Limit-Reset": {
"description": "The number of seconds left in the current period",
"type": "integer"
}
}
}
description: A simple string response
schema:
type: string
headers:
X-Rate-Limit-Limit:
description: The number of allowed requests in the current period
type: integer
X-Rate-Limit-Remaining:
description: The number of remaining requests in the current period
type: integer
X-Rate-Limit-Reset:
description: The number of seconds left in the current period
type: integer
Response with no return value:
{
"description": "object created"
}
description: object created
5.4.13. Headers Object
Lists the headers that can be sent as part of a response.<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | Header Object | The name of the property corresponds to the name of the header. The value describes the type of the header. |
<IP_ADDRESS>. Headers Object Example
Rate-limit headers:
{
"X-Rate-Limit-Limit": {
"description": "The number of allowed requests in the current period",
"type": "integer"
},
"X-Rate-Limit-Remaining": {
"description": "The number of remaining requests in the current period",
"type": "integer"
},
"X-Rate-Limit-Reset": {
"description": "The number of seconds left in the current period",
"type": "integer"
}
}
X-Rate-Limit-Limit:
description: The number of allowed requests in the current period
type: integer
X-Rate-Limit-Remaining:
description: The number of remaining requests in the current period
type: integer
X-Rate-Limit-Reset:
description: The number of seconds left in the current period
type: integer
5.4.14. Example Object
Allows sharing examples for operation responses.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {mime type} | Any | The name of the property MUST be one of the Operation produces values (either implicit or inherited). The value SHOULD be an example of what such a response would look like.
|
<IP_ADDRESS>. Example Object Example
Example response for application/json mimetype of a Pet data type:
{
"application/json": {
"name": "Puma",
"type": "Dog",
"color": "Black",
"gender": "Female",
"breed": "Mixed"
}
}
application/json:
name: Puma
type: Dog
color: Black
gender: Female
breed: Mixed
5.4.15. Header Object
| Field Name | Type | Description |
|---|---|---|
| description | string
| A short description of the header. |
| type | string
| Required. The type of the object. The value MUST be one of "string" , "number" , "integer" , "boolean" , or "array" .
|
| format | string
| The extending format for the previously mentioned type . See Data Type Formats for further details.
|
| items | Items Object | Required if type is “array”. Describes the type of items in the array.
|
| collectionFormat | string
|
Determines the format of the array if type array is used. Possible values are:
csv .
|
| default | * | Declares the value of the header that the server will use if none is provided. (Note: “default” has no meaning for required headers.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.
|
| maximum | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. |
| exclusiveMaximum | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. |
| minimum | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. |
| exclusiveMinimum | boolean
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. |
| maxLength | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. |
| minLength | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. |
| pattern | string
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. |
| maxItems | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. |
| minItems | integer
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. |
| uniqueItems | boolean
| https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. |
| enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. |
| multipleOf | number
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Header Object Example
A simple header with of an integer type:
{
"description": "The number of allowed requests in the current period",
"type": "integer"
}
description: The number of allowed requests in the current period
type: integer
5.4.16. Tag Object
Allows adding meta data to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag used there.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| name | string
| Required. The name of the tag. |
| description | string
| A short description for the tag. GFM syntax can be used for rich text representation. |
| externalDocs | External Documentation Object | Additional external documentation for this tag. |
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Tag Object Example
{
"name": "pet",
"description": "Pets operations"
}
name: pet
description: Pets operations
5.4.17. Reference Object
A simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse.
The Reference Object is a JSON Reference that uses a [JSON Pointer] as its value. For this specification, only canonical dereferencing is supported.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| $ref | string
| Required. The reference string. |
<IP_ADDRESS>. Reference Object Example
{
"$ref": "#/definitions/Pet"
}
$ref: '#/definitions/Pet'
<IP_ADDRESS>. Relative Schema File Example
{
"$ref": "Pet.json"
}
$ref: 'Pet.yaml'
<IP_ADDRESS>. Relative Files With Embedded Schema Example
{
"$ref": "definitions.json#/Pet"
}
$ref: 'definitions.yaml#/Pet'
5.4.18. Schema Object
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
Further information about the properties can be found in JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
The following properties are taken directly from the JSON Schema definition and follow the same specifications:
- $ref - As a JSON Reference
- format (See Data Type Formats for further details)
- title
- description (GFM syntax can be used for rich text representation)
- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object)
- multipleOf
- maximum
- exclusiveMaximum
- minimum
- exclusiveMinimum
- maxLength
- minLength
- pattern
- maxItems
- minItems
- uniqueItems
- maxProperties
- minProperties
- required
- enum
- type
The following properties are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification. Their definition is the same as the one from JSON Schema, only where the original definition references the JSON Schema definition, the Schema Object definition is used instead.
- items
- allOf
- properties
- additionalProperties
Other than the JSON Schema subset fields, the following fields may be used for further schema documentation.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| discriminator | string
| Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.
|
| readOnly | boolean
| Relevant only for Schema "properties" definitions. Declares the property as “read only”. This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false .
|
| xml | XML Object | This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property. |
| externalDocs | External Documentation Object | Additional external documentation for this schema. |
| example | Any | A free-form property to include an example of an instance for this schema. |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>.1. Composition and Inheritance (Polymorphism)
Swagger allows combining and extending model definitions using the allOf
property of JSON Schema, in effect offering model composition. allOf
takes in an array of object definitions that are validated independently but together compose a single object.
While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, Swagger adds the support of the discriminator
field. When used, the discriminator
will be the name of the property used to decide which schema definition is used to validate the structure of the model. As such, the discriminator
field MUST be a required field. The value of the chosen property has to be the friendly name given to the model under the definitions
property. As such, inline schema definitions, which do not have a given id, cannot be used in polymorphism.
<IP_ADDRESS>.2. XML Modeling
The xml property allows extra definitions when translating the JSON definition to XML. The XML Object contains additional information about the available options.
<IP_ADDRESS>. Schema Object Examples
<IP_ADDRESS>.1. Primitive Sample
Unlike previous versions of Swagger, Schema definitions can be used to describe primitive and arrays as well.
{
"type": "string",
"format": "email"
}
type: string
format: email
<IP_ADDRESS>.2. Simple Model
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
},
"age": {
"type": "integer",
"format": "int32",
"minimum": 0
}
}
}
type: object
required:
- name
properties:
name:
type: string
address:
$ref: '#/definitions/Address'
age:
type: integer
format: int32
minimum: 0
<IP_ADDRESS>.3. Model with Map/Dictionary Properties
For a simple string to string mapping:
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
type: object
additionalProperties:
type: string
For a string to model mapping:
{
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ComplexModel"
}
}
type: object
additionalProperties:
$ref: '#/definitions/ComplexModel'
<IP_ADDRESS>.4. Model with Example
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"example": {
"name": "Puma",
"id": 1
}
}
type: object
properties:
id:
type: integer
format: int64
name:
type: string
required:
- name
example:
name: Puma
id: 1
<IP_ADDRESS>.5. Models with Composition
{
"definitions": {
"ErrorModel": {
"type": "object",
"required": [
"message",
"code"
],
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "integer",
"minimum": 100,
"maximum": 600
}
}
},
"ExtendedErrorModel": {
"allOf": [
{
"$ref": "#/definitions/ErrorModel"
},
{
"type": "object",
"required": [
"rootCause"
],
"properties": {
"rootCause": {
"type": "string"
}
}
}
]
}
}
}
definitions:
ErrorModel:
type: object
required:
- message
- code
properties:
message:
type: string
code:
type: integer
minimum: 100
maximum: 600
ExtendedErrorModel:
allOf:
- $ref: '#/definitions/ErrorModel'
- type: object
required:
- rootCause
properties:
rootCause:
type: string
<IP_ADDRESS>.6. Models with Polymorphism Support
{
"definitions": {
"Pet": {
"type": "object",
"discriminator": "petType",
"properties": {
"name": {
"type": "string"
},
"petType": {
"type": "string"
}
},
"required": [
"name",
"petType"
]
},
"Cat": {
"description": "A representation of a cat",
"allOf": [
{
"$ref": "#/definitions/Pet"
},
{
"type": "object",
"properties": {
"huntingSkill": {
"type": "string",
"description": "The measured skill for hunting",
"default": "lazy",
"enum": [
"clueless",
"lazy",
"adventurous",
"aggressive"
]
}
},
"required": [
"huntingSkill"
]
}
]
},
"Dog": {
"description": "A representation of a dog",
"allOf": [
{
"$ref": "#/definitions/Pet"
},
{
"type": "object",
"properties": {
"packSize": {
"type": "integer",
"format": "int32",
"description": "the size of the pack the dog is from",
"default": 0,
"minimum": 0
}
},
"required": [
"packSize"
]
}
]
}
}
}
definitions:
Pet:
type: object
discriminator: petType
properties:
name:
type: string
petType:
type: string
required:
- name
- petType
Cat:
description: A representation of a cat
allOf:
- $ref: '#/definitions/Pet'
- type: object
properties:
huntingSkill:
type: string
description: The measured skill for hunting
default: lazy
enum:
- clueless
- lazy
- adventurous
- aggressive
required:
- huntingSkill
Dog:
description: A representation of a dog
allOf:
- $ref: '#/definitions/Pet'
- type: object
properties:
packSize:
type: integer
format: int32
description: the size of the pack the dog is from
default: 0
minimum: 0
required:
- packSize
<IP_ADDRESS>. XML Object
A metadata object that allows for more fine-tuned XML model definitions.
When using arrays, XML element names are not inferred (for singular/plural forms) and the name
property should be used to add that information. See examples for expected behavior.
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Description |
|---|---|---|
| name | string
| Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items ), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items ), it will affect the wrapping element and only if wrapped is true . If wrapped is false , it will be ignored.
|
| namespace | string
| The URL of the namespace definition. Value SHOULD be in the form of a URL. |
| prefix | string
| The prefix to be used for the name. |
| attribute | boolean
| Declares whether the property definition translates to an attribute instead of an element. Default value is false .
|
| wrapped | boolean
| MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books> ) or unwrapped (<book/><book/> ). Default value is false . The definition takes effect only when defined alongside type being array (outside the items ).
|
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. XML Object Examples
The examples of the XML object definitions are included inside a property definition of a Schema Object with a sample of the XML representation of it.
<IP_ADDRESS>.1. No XML Element
Basic string property:
{
"animals": {
"type": "string"
}
}
animals:
type: string
<animals>...</animals>
Basic string array property (wrapped
is false
by default):
{
"animals": {
"type": "array",
"items": {
"type": "string"
}
}
}
animals:
type: array
items:
type: string
<animals>...</animals>
<animals>...</animals>
<animals>...</animals>
<IP_ADDRESS>.2. XML Name Replacement
{
"animals": {
"type": "string",
"xml": {
"name": "animal"
}
}
}
animals:
type: string
xml:
name: animal
<animal>...</animal>
<IP_ADDRESS>.3. XML Attribute, Prefix and Namespace
In this example, a full model definition is shown.
{
"Person": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"name": {
"type": "string",
"xml": {
"namespace": "http://swagger.io/schema/sample",
"prefix": "sample"
}
}
}
}
}
Person:
type: object
properties:
id:
type: integer
format: int32
xml:
attribute: true
name:
type: string
xml:
namespace: http://swagger.io/schema/sample
prefix: sample
<Person id="123">
<sample:name xmlns:sample="http://swagger.io/schema/sample">example</sample:name>
</Person>
<IP_ADDRESS>.4. XML Arrays
Changing the element names:
{
"animals": {
"type": "array",
"items": {
"type": "string",
"xml": {
"name": "animal"
}
}
}
}
animals:
type: array
items:
type: string
xml:
name: animal
<animal>value</animal>
<animal>value</animal>
The external name
property has no effect on the XML:
{
"animals": {
"type": "array",
"items": {
"type": "string",
"xml": {
"name": "animal"
}
},
"xml": {
"name": "aliens"
}
}
}
animals:
type: array
items:
type: string
xml:
name: animal
xml:
name: aliens
<animal>value</animal>
<animal>value</animal>
Even when the array is wrapped, if no name is explicitly defined, the same name will be used both internally and externally:
{
"animals": {
"type": "array",
"items": {
"type": "string"
},
"xml": {
"wrapped": true
}
}
}
animals:
type: array
items:
type: string
xml:
wrapped: true
<animals>
<animals>value</animals>
<animals>value</animals>
</animals>
To overcome the above example, the following definition can be used:
{
"animals": {
"type": "array",
"items": {
"type": "string",
"xml": {
"name": "animal"
}
},
"xml": {
"wrapped": true
}
}
}
animals:
type: array
items:
type: string
xml:
name: animal
xml:
wrapped: true
<animals>
<animal>value</animal>
<animal>value</animal>
</animals>
Affecting both internal and external names:
{
"animals": {
"type": "array",
"items": {
"type": "string",
"xml": {
"name": "animal"
}
},
"xml": {
"name": "aliens",
"wrapped": true
}
}
}
animals:
type: array
items:
type: string
xml:
name: animal
xml:
name: aliens
wrapped: true
<aliens>
<animal>value</animal>
<animal>value</animal>
</aliens>
If we change the external element but not the internal ones:
{
"animals": {
"type": "array",
"items": {
"type": "string"
},
"xml": {
"name": "aliens",
"wrapped": true
}
}
}
animals:
type: array
items:
type: string
xml:
name: aliens
wrapped: true
<aliens>
<aliens>value</aliens>
<aliens>value</aliens>
</aliens>
<IP_ADDRESS>. Definitions Object
An object to hold data types that can be consumed and produced by operations. These data types can be primitives, arrays or models.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | Schema Object | A single definition, mapping a “name” to the schema it defines. |
<IP_ADDRESS>. Definitions Object Example
{
"Category": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
},
"Tag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
}
}
Category:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
Tag:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
5.4.19. Parameters Definitions Object
An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here.
This does not define global operation parameters.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | Parameter Object | A single parameter definition, mapping a “name” to the parameter it defines. |
<IP_ADDRESS>. Parameters Definition Object Example
{
"skipParam": {
"name": "skip",
"in": "query",
"description": "number of items to skip",
"required": true,
"type": "integer",
"format": "int32"
},
"limitParam": {
"name": "limit",
"in": "query",
"description": "max records to return",
"required": true,
"type": "integer",
"format": "int32"
}
}
skipParam:
name: skip
in: query
description: number of items to skip
required: true
type: integer
format: int32
limitParam:
name: limit
in: query
description: max records to return
required: true
type: integer
format: int32
5.4.20. Responses Definitions Object
An object to hold responses to be reused across operations. Response definitions can be referenced to the ones defined here.
This does not define global operation responses.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | Response Object | A single response definition, mapping a “name” to the response it defines. |
<IP_ADDRESS>. Responses Definitions Object Example
{
"NotFound": {
"description": "Entity not found."
},
"IllegalInput": {
"description": "Illegal input for operation."
},
"GeneralError": {
"description": "General Error",
"schema": {
"$ref": "#/definitions/GeneralError"
}
}
}
NotFound:
description: Entity not found.
IllegalInput:
description: Illegal input for operation.
GeneralError:
description: General Error
schema:
$ref: '#/definitions/GeneralError'
5.4.21. Security Definitions Object
A declaration of the security schemes available to be used in the specification. This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | Security Scheme Object | A single security scheme definition, mapping a “name” to the scheme it defines. |
<IP_ADDRESS>.  Security Scheme Object
Allows the definition of a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2’s common flows (implicit, password, application and access code).
<IP_ADDRESS>. Fixed Fields
| Field Name | Type | Validity | Description |
|---|---|---|---|
| type | string
| Any | Required. The type of the security scheme. Valid values are "basic" , "apiKey" or "oauth2" .
|
| description | string
| Any | A short description for security scheme. |
| name | string
| apiKey
| Required. The name of the header or query parameter to be used. |
| in | string
| apiKey
| Required The location of the API key. Valid values are "query" or "header" .
|
| flow | string
| oauth2
| Required. The flow used by the OAuth2 security scheme. Valid values are "implicit" , "password" , "application" or "accessCode" .
|
| authorizationUrl | string
| oauth2 ("implicit" , "accessCode" )
| Required. The authorization URL to be used for this flow. This SHOULD be in the form of a URL. |
| tokenUrl | string
| oauth2 ("password" , "application" , "accessCode" )
| Required. The token URL to be used for this flow. This SHOULD be in the form of a URL. |
| scopes | Scopes Object | oauth2
| Required. The available scopes for the OAuth2 security scheme. |
<IP_ADDRESS>. Patterned Fields
| Field Name | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>. Security Scheme Object Example
<IP_ADDRESS>.1. Basic Authentication Sample
{
"type": "basic"
}
type: basic
<IP_ADDRESS>.2. API Key Sample
{
"type": "apiKey",
"name": "api_key",
"in": "header"
}
type: apiKey
name: api_key
in: header
<IP_ADDRESS>.3.  Scopes Object
Lists the available scopes for an OAuth2 security scheme.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | string
| Maps between a name of a scope to a short description of it (as the value of the property). |
<IP_ADDRESS>. Patterned Objects
| Field Pattern | Type | Description |
|---|---|---|
| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with x- , for example, x-internal-id . The value can be null , a primitive, an array or an object. See Vendor Extensions for further details.
|
<IP_ADDRESS>.  Security Requirement Object
Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes).
The name used for each property MUST correspond to a security scheme declared in the Security Definitions.
<IP_ADDRESS>. Patterned Fields
| Field Pattern | Type | Description |
|---|---|---|
| {name} | [string ]
| Each name must correspond to a security scheme which is declared in the Security Definitions. If the security scheme is of type "oauth2" , then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.
|
<IP_ADDRESS>. Security Requirement Object Examples
<IP_ADDRESS>.1. Non-OAuth2 Security Requirement
{
"api_key": []
}
api_key: []
<IP_ADDRESS>.2. OAuth2 Security Requirement
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
petstore_auth:
- write:pets
- read:pets
<IP_ADDRESS>. Specification Extensions
While the Swagger Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
The extensions properties are always prefixed by "x-"
and can have any valid JSON format value.
The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced).
<IP_ADDRESS>. Security Filtering
Some objects in the Swagger specification may be declared and remain empty, or completely be removed, even though they are inherently the core of the API documentation.
The reasoning behind it is to allow an additional layer of access control over the documentation itself. While not part of the specification itself, certain libraries may choose to allow access to parts of the documentation based on some form of authentication/authorization.
Two examples for this:
- The Paths Object may be empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can’t access any documentation. They’d still have access to the Info Object which may contain additional information regarding authentication.
- The Path Item Object may be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different than hiding the path itself from the Paths Object so the user will not be aware of its existence. This allows the documentation provider a finer control over what the viewer can see.


Search Method
{% for st in sic_types %}
{{ st }}
{% endfor %}
Smoothed histogram
Raw histogram
Palette image
Back to
search by pallete
.
Matching images


--- name: playground.accordion title: Accordion Playground url: /accordion animationIn: fadeIn animationOut: fadeOut ---


virtual immersive learning ocean acidification participants experience knowledge people change participant climate underwater Study effects (e.g., Participants students study .]. physical world attitude effect environmental < Virtual species research min used data environment information total movement time {border-style education head suggests using NEP positive post-test px;} scores space #ffffff;} Ocean acidification. presence reality rotation science did environment. experiences gain levels max measures movements studies consequences different marine measure CNS Figure HMD University body field number potential questions relative reported .), Presence coral desktop issues social work *** Psychol. Table acidification, cognitive complex conditions feedback greater high scale technology change. example, experience, experience. experimental hand learn like psychological school significant snails subjects traveled (., .], Exp(β) New Therefore, based carbon change, collected compared content dioxide facilitate inquisitiveness learning. locomotion media predict prior processing zone United [., concern control current evaluate evidence feel interactivity lead left observed overall participants' pre- pre-test process provided psychologically responses scuba tracked use world. Environ. Finally, Learning States activity asked avatar called classroom difference distance environments evaluated hands important interact positively px; responded revealed suggest swim {font-family > (see .). .)] Bailenson Comput. First, Sci. Slater VR. affect arms associated causes condition, conditions. correlated dive experiment exploratory explore felt fish font-size future gains hardware henceforth increased individual level medium nature participant's participated phenomenon question questionnaire reef. right rocky scale, students' teaching temperature tested trips water world, zone. (A) (B) (Study .); CNS, Consistent Correlations Ecological Educ. Immersive NEP, Nature OAK Time Total VR, abstract action address allow answered condition consistent controlled does double; ecosystem embodiment explored exploring given higher however, idea included infrared is, items main outcomes outside p's parts perceived presence. rate received recent reef researcher sense separate significantly student went ./s--- Appendix Attitude Change Dede Distance Environmental Film High Inquisitiveness Lee, Mayer Medium Nat. Oculus Procedure Reality Scuba Stanford Students Studies Wiimote administered affected allows attitudes averaged border-color border-width brought changes comparing connected consent correlations count create demonstrated design discussion education. educational expected, experienced far feeling focus games general healthy highly impact informed innovative issue laboratory located mechanism methods mixed modeled models motion mouse moving objects paper participate patterns placed position possible post-hoc predicted provide public reliability report response results retention sample science. sea search sensory sickness solid; studies, study, swimming team test therapy tracking training user viewed visual weeks zone, zones {font-style {font-weight "strongly (C) (Figure (Table ./nclimate Bailenson, Casasanto Clim. Commun. Connectedness Coral Department Diver Gestures Institutional Items Materials Measures Mediterranean Method Nagelkerke OAK, Paradigm Pres. Res. Responses Results Review Rift River Simulator Sundar Teleoperat. Tribeca Worldviz's acidified answer arm article assigned audio average bold breaststroke changing class closer completed computed courier; created data. deeper degrees-of-freedom differences edited effective em; embodying engage engagement enhanced event example experiments exposure extend extremely final first-hand hand, haptic human including increasing information, instruction internalize investigate lab life look looking low mediated method mobile model narrative need null occurred one's open-water original paper, participants. pattern perform post-test, presence, present pt;} question, real referred relationship room room. scales, scientific scientists second, self-avatar sensor significant, similar size spatial standardized stereo strongly students, study's study. swam systems teachers technique terms told tool topic types understand unique variables vents wore −.,


Debating the best players and managers in the world is a timeless exercise that always sparks conversation.
So we've taken our ranking to a new level this year. Whether you're new to the sport or a die-hard fan, these are the best men's players and managers in football that you need to know. I know, some players are so versatile that they often defy classification, but I've tried to bring some order to the chaos that is modern football.
Developer`s name: Yaroslav Zemlianko Write to developer`s email: zema290613@gmail.com


| Manifest |
https://presley.glam-dev.org/iiif/customer/manifest?manifest_id=http://mattmcgrattan.github.io/LSE/uwt_d_1_1_22.json |
| Universal Viewer |
UV |
| Mirador |
Mirador |
| Number of pages |
1 |
| Link to detailed data |
Here |
| Subjects--Likely |
Equal pay for equal work.
Equal pay for equal work--Canada.
Equal pay for equal work--Australia.
|
| Subjects--Possible |
Equal pay for equal work.
Equal pay for equal work--Canada.
Equal pay for equal work--Australia.
Equal pay for equal work--United States.
Equal pay for equal work--Great Britain.
Europe--women--equal pay.
Night work.
National Council and Union of Women Workers of Great Britain and Ireland.
Bermuda Islands--suffrage movements--organisations--women's--Bermuda Woman Suffrage Societies.
Sudan--Politics and government.
|
Keywords--Document Only |
pay,
equal,
worker,
equal pay,
work,
woman,
wage,
government,
woman equal,
solve,
|
Keywords--Relative to Entire Corpus |
worker,
pay,
inflation,
indirectly,
directly indirectly,
|
Bigrams |
['equal pay', 5],
['woman equal', 2],
['pay work', 2],
['directly indirectly', 2],
['outl woman', 1],
['pay government', 1],
['government pledge', 1],
['pledge establish', 1],
['establish chancellor', 1],
['chancellor exchequer', 1],
|
Common terms |
['pay', 7],
['equal', 6],
['worker', 5],
['woman', 4],
['work', 4],
['government', 3],
['wage', 3],
['difference', 2],
['payment', 2],
['delay', 2],
|
Named entities |
- ORG
-
Equal Pay
Civil Servants
Labour
| 1/ 22
C. A. Brock& Co. Ltd.
the Trades Union Congress Conference
Government
the Labour Party
Equal Pay Demonstration Committee
Party Conference
Southern Row
T. U.
- DATE
-
June 11th, 1947
- PERSON
-
Popplewell
Jo
Kilspindie
Hon
Hugh Dalton
- GPE
-
London
Surrey
Wonersh Park
Nr
Guildford
|
Extractive summaries |
LSA: June 11th, 1947, the Chancellor of the Exchequer, Mr. Hugh Dalton said: " There should be no difference of payment for the same work in respect of sex. " fundamental principle of human equality, and claimed by the Labour Party as part of their foundation for a New World. 6 The cost of Equal Pay in the Civil Service and other employ ments for which the Government is directly or indirectly responsible could not possibly make the difference between national safety and bankruptcy. The Government estimate for Equal Pay for those directly or indirectly in their service is roughly 24 million pounds. TO AVOID INFLATION and solve the national financial crisis every section of the community must contribute to a common effort.
Luhn: Party Conference have passed resolutions calling for:" equal pay without delay.' fundamental principle of human equality, and claimed by the Labour Party as part of their foundation for a New World. 6 The cost of Equal Pay in the Civil Service and other employ ments for which the Government is directly or indirectly responsible could not possibly make the difference between national safety and bankruptcy. The Government estimate for Equal Pay for those directly or indirectly in their service is roughly 24 million pounds. It cannot be solved by delaying fair payment to women for equal work.
Reduction: WOMEN MUST HAVE EQUAL PAY BECAUSE .... The Government is pledged to establish Equal Pay. Party Conference have passed resolutions calling for:" equal pay without delay.' 6 The cost of Equal Pay in the Civil Service and other employ ments for which the Government is directly or indirectly responsible could not possibly make the difference between national safety and bankruptcy. The Government estimate for Equal Pay for those directly or indirectly in their service is roughly 24 million pounds.
KL: While the danger of inflation is grave and must be guarded Jo against it is not fair to use it as an argument against women having more money while a large percentage of workers, mainly men, have been receiving wage advances, including miners, agricultural workers, transport workers, catering employees, shop assistants, clerical and printing workers, etc. TO AVOID INFLATION and solve the national financial crisis every section of the community must contribute to a common effort. Why should women be the only workers to accept a sacrifice? Secretary: Mrs. Popplewell, " Kilspindie, " Wonersh Park, Nr. ), 79 Southern Row, London, W. 10.
TextRank: WOMEN MUST HAVE EQUAL PAY BECAUSE .... While the danger of inflation is grave and must be guarded Jo against it is not fair to use it as an argument against women having more money while a large percentage of workers, mainly men, have been receiving wage advances, including miners, agricultural workers, transport workers, catering employees, shop assistants, clerical and printing workers, etc. 6 The cost of Equal Pay in the Civil Service and other employ ments for which the Government is directly or indirectly responsible could not possibly make the difference between national safety and bankruptcy. The Government estimate for Equal Pay for those directly or indirectly in their service is roughly 24 million pounds. It cannot be solved by delaying fair payment to women for equal work.
LexRank: WOMEN MUST HAVE EQUAL PAY BECAUSE .... Party Conference have passed resolutions calling for:" equal pay without delay.' The Government estimate for Equal Pay for those directly or indirectly in their service is roughly 24 million pounds. It cannot be solved by delaying fair payment to women for equal work. Why should women be the only workers to accept a sacrifice?
|
Page level data |


Hide Image 1
Show Image 1
Hide Image 2
Show Image 2
Hide Image 3
Show Image 3
Hide Image 4
Show Image 4


Alberta RCMP remind all Albertans to always report suspicious activity
Third quarter results for 2019 continue to show an overall steady decrease in property-related crime
Alberta RCMP are pleased to report that the third quarter results for 2019 continue to show an overall steady decrease in property-related crime in Alberta since 2017.
This could not have been accomplished without the continued efforts of Albertans in securing their personal property and informing their local police of suspicious activity and criminal offences.
In the past, police say they heard that people say they’ve noticed an increase in crime, but that they aren’t reporting the incidents.
“We rely on the data and intelligence you provide in your reports to know where we are needed most,” noted a release.
“Reports of crime or suspicious activity helps police allocate their resources: the public’s reports tell them where to look, who to look for, and where to patrol in the future.
“Your calls for service to the RCMP matter. Being led by intelligence, like where and when crime is happening, is key to the crime reduction strategy for the Alberta RCMP. This intelligence weaves the different components of our crime reduction strategy into a shared goal of community safety: from finding the criminals that cause the most harm, finding the victims that need the most support, and collaborating with the right partners to keep Albertans safe,” said Supt. Peter Tewfik, officer-in-charge of “K” Division Crime Reduction Unit.
A report to the police is all information police can analyze and use. Times of the day, locations, and types of vehicles observed are all helpful to them.
They also share this information with community groups, such as Rural Crime Watch and Alberta Citizens on Patrol Associations, to help identify hotspots and vehicle they are searching for.
-Submitted


--- title: How Internet Long Tail Helped Me Fixing My Smartphone author: Enrico Spinielli date: '2015-01-30' tags: ["long tail", "smartphone", "samsung", "usb", "repair"] categories: [] header: caption: '' image: '' highlight: yes math: no ---
I am just more and more amazed by the opportunities offered by the current Internet connectivity: they call it the long tail.
It strikes me that just few years ago what I have done would have been extreemely difficult or very expensive … or both.
So here is the story of how I was able to fix my Samsung Galaxy S2, the steps I followed and the resources that helped me.
During summer 2014 my S2 started behaving erratically: it was suddenly switching off and back on, charging was giving sings of malfunctioning.
I initially thought this was due to the battery.
Andy, a friend and collegue of mine, gave me one of his spare batteries but the symptoms didn’t disappear. The situation was annoying but, to be frank, not frequent enough to push me to immediate action.
Then in November I decided to investigate whether anybody else had experienced similar problems.
A few searches showed that USB charging port could be the culprit and many youtube videos showed how to repair it
{{% youtube "sBtEz6sWzZY" %}}Then the next decision point was: do I try to fix it with the risk of destroying the phone or do I just hand it over to a repair shop?
No way to find a repair shop who is close enough and competent enough.
So I decided to give it a go and try to fix it: it is all about taking some screws away and unplug some connectors; no surface mounting soldering or the likes!
So once I decided to repair, where to find the parts? Brussels is not the paradise for electronics hobbists.
EBay to the rescue: one piece can cost as little as 0.30 EUR if bought in lots of thousands (but I need just one!), then I found a single piece at 3.29 CAD (shipping included), still a cheap enough option. The order date is Nov 27, 2014, shipped the day after.
Here we are! On 29th Dec 2015 I come home from holidays and it arrived! And the evening after while the kids play with Legos, Daddy repairs (and has fun with) the phone
All is good: USB is charging again, no shortcuts, no erratic shutdowns…Victory!
All seemed good, but the radio signal is very, very weak!
So weak that at times I have no gsm/data connection!
Hhuumm, maybe that is due to the fact that the replacement piece I bought was revision 2.3 …
… while the original one was 2.2 …
Back to basics, google search to the rescue: I found an
article by Rich O’Neil citing a
post on xda-developers
from a certain Serathian who simply cut the PCB in two.
Here is what he did:
The left part is responsible for the radio while the right part is the USB.
Ok, few days later I take a scissor and use the radio part from the old piece (rev 2.2) and the USB part from the new (rev 2.3): VICTORY !
Phone is now fixed! (It is 6th Jan 2015.)
Thanks all for sharing (and some huge company to let me find it)!


WITNESS LIST Pensions & Investments Committee May 5, 1999-8:00A HB 3178 On: Nail, William (ERS) HB 3219 Committee Substitute (Greenberg) On: Featherston, Patricia (TRS) SB 761 On: Nail, William (ERS)


In order for you to have the best experience, we will require some information. You can change these settings after completing signing up:
Please verify your email address to complete registration. Resend Email Confirmation. Email Confirmation Sent. Thank you for confirming your email.
Please verify your email address to complete registration. Resend Email Confirmation. Email Confirmation Sent.
Thank you for confirming your email.


{% extends 'base.html' %} {% block title %} {{ manufacturer.name }} {{ product.model }} {% endblock %} {% block main %}
{{ product.stock }} in stock.
Expect within 2-8 days.
{% else %} Delivery details forthcomingCheck back soon.
{% endif %}Guaranteed for {{ product.warranty }} years.


Add Allowed Components within Modal.
A Rich Text Editor component added to Modal.
The code and classes within the modal will be determined by the Allowed Components placed within.


An open-source app
for scanning mobile devices (e.g., Android and iOS devices) for apps that
can be used to spy on, track, or otherwise monitor a person.
{% if clients %}
{% else %}
There are no client forms in the database. Submit some, and then come back here!
{% endif %}


public class RuleExecutionResult
extends java.lang.Object
implements java.io.Serializable
| Modifier and Type | Field and Description |
|---|---|
static long |
serialVersionUID |
| Constructor and Description |
|---|
RuleExecutionResult(java.lang.String timestamp)
constructor including the timestamp of when the rule was executed
|
RuleExecutionResult(java.lang.String timestamp,
XmlRule rule,
java.lang.String objectLabel,
java.lang.String subgroupId)
constructor for this class using the timestamp, the rule and a label
for the rule used during output.
|
| Modifier and Type | Method and Description |
|---|---|
int |
getFailed()
returns if the rule that belongs to this result failed or passed
the test
|
java.lang.String |
getFailedAsString()
returns a string expression meaning [true] or [false]
depending if the rule that belongs to this result passed or failed.
|
java.lang.String |
getMessage()
a rule has a message - defined in the xml file - in case it fails and one message in case it passes.
|
java.lang.String |
getObjectLabel()
returns the object label that was assign for use
during output
|
java.lang.Object |
getResultObject1()
gets the first object that was constructed
|
java.lang.Object |
getResultObject2()
gets the second object that was executed
|
XmlRule |
getRule()
returns the rule that was executed
|
java.lang.String |
getSubgroupId()
get the id of the subgroup which the rule belongs to
|
java.lang.String |
getTimestamp()
returns the timestamp that was assign to rule execution result
|
boolean |
isFailed()
returns if the rule that belongs to this result failed or passed
the test
|
void |
setObjectLabel(java.lang.String objectLabel)
sets the object label that will be used
during output
|
void |
setResultObject1(java.lang.Object result)
sets the first object that was executed
|
void |
setResultObject2(java.lang.Object result)
sets the second object that was executed
|
void |
setRule(XmlRule rule)
sets the rule that was executed
|
void |
setSubgroupId(java.lang.String subgroupId)
set the id of the subgroup which the rule belongs to
|
public static final long serialVersionUID
public RuleExecutionResult(java.lang.String timestamp)
timestamp
- the timestamp for the execution resultpublic RuleExecutionResult(java.lang.String timestamp, XmlRule rule, java.lang.String objectLabel, java.lang.String subgroupId)
timestamp
- the timestamp for the execution resultrule
- the rule belonging to the execution resultobjectLabel
- the label for the objectsubgroupId
- the id of the subgrouppublic XmlRule getRule()
public void setRule(XmlRule rule)
rule
- the rule that was executedpublic java.lang.Object getResultObject1()
public void setResultObject1(java.lang.Object result)
result
- the first object that was constructedpublic java.lang.Object getResultObject2()
public void setResultObject2(java.lang.Object result)
result
- the second object that was constructedpublic java.lang.String getMessage()
public java.lang.String getObjectLabel()
public void setObjectLabel(java.lang.String objectLabel)
objectLabel
- the label of the objectpublic java.lang.String getTimestamp()
public int getFailed()
public boolean isFailed()
public java.lang.String getFailedAsString()
public java.lang.String getSubgroupId()
public void setSubgroupId(java.lang.String subgroupId)
subgroupId
- the id of the subgroup


WITNESS LIST Subcommittee on Higher Education Committee March 10, 2003 - 1:30P SB 28 ON: Smith, Mary E. (Texas Higher Education Coordinating Board), Austin, TX Registering, but not testifying: On: Blass, Casey (Texas Department of Health), Austin, TX SB 253 FOR: McDonald, Carol L. (Independent Colleges & Universities of Texas), Austin, TX ON: Briseno, Elias (Texas Department of Health), Austin, TX Registering, but not testifying: On: Brown, Martha (Texas Tech University), Lubbock, TX SB 437 Registering, but not testifying: On: Laughter, Ray (North Harris Montgomery Community College District), Houston, TX


--- title: Theme Pages category: General order: 2 --- The following page templates are included in {{site._theme.short_name}}:


The third example shows an alidated form; You must write the correct text in the fields, and the form must be sent. If the text is not correct, the form can not be sent.
Simple form
Simple inputs form
Your request was sent.
The request could be sent until all the fields are correct.
Nested objects
Nested and complex object in a form
Your request was sent.
The request could be sent until all the fields are correct.


Thanks for signing up. Please follow this link to activate your account:
click this link to confirm your email
Cheers!
the co-demos team


Decimalization
|
|
deb_lsd_l()
|
Conversion of pounds, shillings and pence to pounds |
|
deb_l_lsd()
|
Conversion of decimalized pounds to pounds, shillings, and pence |
|
deb_lsd_s()
|
Conversion of pounds, shillings and pence to shillings |
|
deb_s_lsd()
|
Conversion of decimalized shillings to pounds, shillings, and pence |
|
deb_lsd_d()
|
Conversion of pounds, shillings, and pence to pence |
|
deb_d_lsd()
|
Conversion of decimalized pence to pounds, shillings, and pence |