Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10,323 changes: 3,932 additions & 6,391 deletions spec/data/large.yaml

Large diffs are not rendered by default.

27 changes: 27 additions & 0 deletions spec/data/large/AddCustomFieldSettingRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
AddCustomFieldSettingRequest:
properties:
custom_field:
description: The custom field to associate with this container.
example: '14916'
type: string
insert_after:
description: A gid of a Custom Field Setting on this container, after which
the new Custom Field Setting will be added. `insert_before` and `insert_after`
parameters cannot both be specified.
example: '1331'
type: string
insert_before:
description: A gid of a Custom Field Setting on this container, before which
the new Custom Field Setting will be added. `insert_before` and `insert_after`
parameters cannot both be specified.
example: '1331'
type: string
is_important:
description: Whether this field should be considered important to this container
(for instance, to display in the list view of items in the container).
example: true
type: boolean
required:
- custom_field
type: object
11 changes: 11 additions & 0 deletions spec/data/large/AddFollowersRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
AddFollowersRequest:
properties:
followers:
description: An array of strings identifying users. These can either be the
string "me", an email, or the gid of a user.
example: 521621621373
type: string
required:
- followers
type: object
11 changes: 11 additions & 0 deletions spec/data/large/AddMembersRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
AddMembersRequest:
properties:
members:
description: An array of strings identifying users. These can either be the
string "me", an email, or the gid of a user.
example: 521621621373
type: string
required:
- members
type: object
10 changes: 10 additions & 0 deletions spec/data/large/AsanaNamedResource.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
AsanaNamedResource:
allOf:
- "$ref": "#/components/schemas/AsanaResource"
- properties:
name:
description: The name of the object.
example: Bug Task
type: string
type: object
17 changes: 17 additions & 0 deletions spec/data/large/AsanaResource.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
AsanaResource:
description: A generic Asana Resource, containing a globally unique identifier.
properties:
gid:
description: Globally unique identifier of the resource, as a string.
example: '12345'
readOnly: true
type: string
x-insert-after: false
resource_type:
description: The base type of this resource.
example: task
readOnly: true
type: string
x-insert-after: gid
type: object
3 changes: 3 additions & 0 deletions spec/data/large/AttachmentBase.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
AttachmentBase:
"$ref": "#/components/schemas/AttachmentCompact"
20 changes: 20 additions & 0 deletions spec/data/large/AttachmentCompact.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
AttachmentCompact:
allOf:
- "$ref": "#/components/schemas/AsanaResource"
- description: An *attachment* object represents any file attached to a task in
Asana, whether it’s an uploaded file or one associated via a third-party service
such as Dropbox or Google Drive.
properties:
name:
description: The name of the file.
example: Screenshot.png
readOnly: true
type: string
resource_subtype:
description: |-
The service hosting the attachment. Valid values are `asana`, `dropbox`, `gdrive`, `onedrive`, `box`, and `external`.
`external` attachments are a beta feature currently limited to specific integrations.
type: object
x-docs-overrides:
properties.resource_type.example: attachment
33 changes: 33 additions & 0 deletions spec/data/large/AttachmentRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
AttachmentRequest:
properties:
file:
description: 'Required for file attachments.

'
format: binary
type: string
name:
description: 'The name of the external resource being attached. Required for
attachments of type ''external''.

'
type: string
resource_subtype:
description: 'The type of the attachment. Must be one of the given values. If
not specified, a file attachment of type `asana_file_attachments` will be
assumed.

'
enum:
- asana_file_attachments
- external
example: text
type: string
url:
description: 'The URL of the external resource being attached. Required for
attachments of type ''external''.

'
type: string
type: object
42 changes: 42 additions & 0 deletions spec/data/large/AttachmentResponse.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
AttachmentResponse:
allOf:
- "$ref": "#/components/schemas/AttachmentBase"
- properties:
created_at:
description: The time at which this resource was created.
example: 2012-02-22 02:06:58.147000000 Z
format: date-time
readOnly: true
type: string
download_url:
description: |-
The URL containing the content of the attachment.
*Note:* May be null if the attachment is hosted by [Box](https://www.box.com/). If present, this URL may only be valid for two minutes from the time of retrieval. You should avoid persisting this URL somewhere and just refresh it on demand to ensure you do not keep stale URLs.
example: https://s3.amazonaws.com/assets/123/Screenshot.png
format: uri
nullable: true
readOnly: true
type: string
host:
description: The service hosting the attachment. Valid values are `asana`,
`dropbox`, `gdrive` and `box`.
example: dropbox
readOnly: true
type: string
parent:
allOf:
- "$ref": "#/components/schemas/TaskCompact"
- description: The task this attachment is attached to.
readOnly: true
type: object
view_url:
description: The URL where the attachment can be viewed, which may be friendlier
to users in a browser than just directing them to a raw file. May be null
if no view URL exists for the service.
example: https://www.dropbox.com/s/123/Screenshot.png
format: uri
nullable: true
readOnly: true
type: string
type: object
9 changes: 9 additions & 0 deletions spec/data/large/BatchRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
BatchRequest:
description: A request object for use in a batch request.
properties:
actions:
items:
"$ref": "#/components/schemas/BatchRequestAction"
type: array
type: object
65 changes: 65 additions & 0 deletions spec/data/large/BatchRequestAction.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
BatchRequestAction:
description: An action object for use in a batch request.
properties:
data:
description: For `GET` requests, this should be a map of query parameters you
would have normally passed in the URL. Options and pagination are not accepted
here; put them in `options` instead. For `POST`, `PATCH`, and `PUT` methods,
this should be the content you would have normally put in the data field of
the body.
example:
assignee: me
workspace: '1337'
type: object
method:
description: The HTTP method you wish to emulate for the action.
enum:
- get
- post
- put
- delete
- patch
- head
example: get
type: string
options:
description: Pagination (`limit` and `offset`) and output options (`fields`
or `expand`) for the action. “Pretty” JSON output is not an available option
on individual actions; if you want pretty output, specify that option on the
parent request.
example:
fields:
- name
- notes
- completed
limit: 3
properties:
fields:
description: The fields to retrieve in the request.
example:
- name
- gid
- notes
- completed
items:
type: string
type: array
limit:
description: Pagination limit for the request.
example: 50
type: integer
offset:
description: Pagination offset for the request.
example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
type: integer
type: object
relative_path:
description: The path of the desired endpoint relative to the API’s base URL.
Query parameters are not accepted here; put them in `data` instead.
example: "/tasks/123"
type: string
required:
- relative_path
- method
type: object
25 changes: 25 additions & 0 deletions spec/data/large/BatchResponse.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
BatchResponse:
description: A response object returned from a batch request.
properties:
body:
description: The JSON body that the invoked endpoint returned.
example:
data:
completed: false
gid: '1967'
name: Hello, world!
notes: How are you today?
type: object
headers:
description: A map of HTTP headers specific to this result. This is primarily
used for returning a `Location` header to accompany a `201 Created` result. The
parent HTTP response will contain all common headers.
example:
location: "/tasks/1234"
type: object
status_code:
description: The HTTP status code that the invoked endpoint returned.
example: 200
type: integer
type: object
69 changes: 69 additions & 0 deletions spec/data/large/CustomFieldBase.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
CustomFieldBase:
allOf:
- "$ref": "#/components/schemas/CustomFieldCompact"
- properties:
currency_code:
description: ISO 4217 currency code to format this custom field. This will
be null if the `format` is not `currency`.
example: EUR
nullable: true
type: string
custom_label:
description: This is the string that appears next to the custom field value.
This will be null if the `format` is not `custom`.
example: gold pieces
nullable: true
type: string
custom_label_position:
description: Only relevant for custom fields with `custom` format. This depicts
where to place the custom label. This will be null if the `format` is not
`custom`.
enum:
- prefix
- suffix
example: suffix
type: string
description:
description: "[Opt In](/docs/input-output-options). The description of the
custom field."
example: Development team priority
type: string
enum_options:
description: "*Conditional*. Only relevant for custom fields of type `enum`.
This array specifies the possible values which an `enum` custom field can
adopt. To modify the enum options, refer to [working with enum options](/docs/create-an-enum-option)."
items:
"$ref": "#/components/schemas/EnumOption"
type: array
format:
description: The format of this custom field.
enum:
- currency
- identifier
- percentage
- custom
- none
example: custom
type: string
has_notifications_enabled:
description: "*Conditional*. This flag describes whether a follower of a task
with this field should receive inbox notifications from changes to this
field."
example: true
type: boolean
is_global_to_workspace:
description: This flag describes whether this custom field is available to
every container in the workspace. Before project-specific custom fields,
this field was always true.
example: true
readOnly: true
type: boolean
precision:
description: |-
Only relevant for custom fields of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive.
For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%.
The identifier format will always have a precision of 0.
example: 2
type: integer
type: object
Loading
Loading