From ba83439ae27cb5bb2350f055aa59063f3eaac476 Mon Sep 17 00:00:00 2001 From: Oleh Paduchak Date: Tue, 8 Jul 2025 17:32:37 +0300 Subject: [PATCH] Added GrtavyValet page --- gv-swagger-spec/swagger.yml | 11215 ++++++++++++++++++++++++++++++++++ gv.html | 15 + swagger-spec/swagger.yaml | 7 +- 3 files changed, 11235 insertions(+), 2 deletions(-) create mode 100644 gv-swagger-spec/swagger.yml create mode 100644 gv.html diff --git a/gv-swagger-spec/swagger.yml b/gv-swagger-spec/swagger.yml new file mode 100644 index 0000000..fd666ba --- /dev/null +++ b/gv-swagger-spec/swagger.yml @@ -0,0 +1,11215 @@ +components: + schemas: + AddonImp: + additionalProperties: false + properties: + attributes: + properties: + docstring: + readOnly: true + type: string + interface_docstring: + readOnly: true + type: string + name: + readOnly: true + type: string + type: object + id: {} + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + implemented_operations: + description: A related resource object from type addon-operations + properties: + data: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Implemented operations + type: object + type: object + type: + allOf: + - $ref: '#/components/schemas/AddonImpTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + AddonImpResponse: + properties: + data: + items: + $ref: '#/components/schemas/AddonImp' + type: array + required: + - data + type: object + AddonImpTypeEnum: + enum: + - addon-imps + type: string + AddonOperation: + additionalProperties: false + properties: + attributes: + properties: + capability: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + readOnly: true + type: string + docstring: + readOnly: true + type: string + kwargs_jsonschema: + readOnly: true + name: + readOnly: true + type: string + result_jsonschema: + readOnly: true + type: object + id: {} + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + implemented_by: + description: A related resource object from type addon-imps + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-imps + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Implemented by + type: object + type: object + type: + allOf: + - $ref: '#/components/schemas/AddonOperationTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + AddonOperationInvocation: + additionalProperties: false + properties: + attributes: + properties: + created: + format: date-time + readOnly: true + type: string + invocation_status: + description: '* `STARTING` - STARTING + + * `GOING` - GOING + + * `SUCCESS` - SUCCESS + + * `ERROR` - ERROR' + enum: + - STARTING + - GOING + - SUCCESS + - ERROR + readOnly: true + type: string + modified: + format: date-time + readOnly: true + type: string + operation_kwargs: {} + operation_name: + type: string + operation_result: + readOnly: true + required: + - operation_kwargs + - operation_name + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + by_user: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: By user + type: object + operation: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Operation + type: object + thru_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - AuthorizedAccount + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Thru account + type: object + thru_addon: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - ConfiguredAddon + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Thru addon + type: object + type: object + type: + allOf: + - $ref: '#/components/schemas/AddonOperationInvocationTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + AddonOperationInvocationRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + created: + format: date-time + readOnly: true + type: string + invocation_status: + description: '* `STARTING` - STARTING + + * `GOING` - GOING + + * `SUCCESS` - SUCCESS + + * `ERROR` - ERROR' + enum: + - STARTING + - GOING + - SUCCESS + - ERROR + readOnly: true + type: string + modified: + format: date-time + readOnly: true + type: string + operation_kwargs: {} + operation_name: + minLength: 1 + type: string + operation_result: + readOnly: true + required: + - operation_kwargs + - operation_name + type: object + relationships: + properties: + by_user: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: By user + type: object + operation: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Operation + type: object + thru_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - AuthorizedAccount + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Thru account + type: object + thru_addon: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - ConfiguredAddon + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Thru addon + type: object + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - addon-operation-invocations + type: string + required: + - type + type: object + required: + - data + type: object + AddonOperationInvocationResponse: + properties: + data: + $ref: '#/components/schemas/AddonOperationInvocation' + required: + - data + type: object + AddonOperationInvocationTypeEnum: + enum: + - addon-operation-invocations + type: string + AddonOperationResponse: + properties: + data: + items: + $ref: '#/components/schemas/AddonOperation' + type: array + required: + - data + type: object + AddonOperationTypeEnum: + enum: + - addon-operations + type: string + AuthorizedCitationAccount: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + default_root_folder: + type: string + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_citation_addons: + description: A related resource object from type configured-citation-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-citation-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured citation addons + type: object + external_citation_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-citation-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: External citation service + type: object + required: + - external_citation_service + type: object + type: + allOf: + - $ref: '#/components/schemas/AuthorizedCitationAccountTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + AuthorizedCitationAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + default_root_folder: + type: string + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_citation_addons: + description: A related resource object from type configured-citation-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - configured-citation-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + required: + - data + title: Configured citation addons + type: object + external_citation_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-citation-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External citation service + type: object + required: + - external_citation_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-citation-accounts + type: string + required: + - type + type: object + required: + - data + type: object + AuthorizedCitationAccountResponse: + properties: + data: + $ref: '#/components/schemas/AuthorizedCitationAccount' + required: + - data + type: object + AuthorizedCitationAccountTypeEnum: + enum: + - authorized-citation-accounts + type: string + AuthorizedComputingAccount: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_computing_addons: + description: A related resource object from type configured-computing-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-computing-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured computing addons + type: object + external_computing_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-computing-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: External computing service + type: object + required: + - external_computing_service + type: object + type: + allOf: + - $ref: '#/components/schemas/AuthorizedComputingAccountTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + AuthorizedComputingAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_computing_addons: + description: A related resource object from type configured-computing-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - configured-computing-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + required: + - data + title: Configured computing addons + type: object + external_computing_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-computing-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External computing service + type: object + required: + - external_computing_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-computing-accounts + type: string + required: + - type + type: object + required: + - data + type: object + AuthorizedComputingAccountResponse: + properties: + data: + $ref: '#/components/schemas/AuthorizedComputingAccount' + required: + - data + type: object + AuthorizedComputingAccountTypeEnum: + enum: + - authorized-computing-accounts + type: string + AuthorizedLinkAccount: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_link_addons: + description: A related resource object from type configured-link-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-link-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured link addons + type: object + external_link_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-link-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: External link service + type: object + required: + - external_link_service + type: object + type: + allOf: + - $ref: '#/components/schemas/AuthorizedLinkAccountTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + AuthorizedLinkAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_link_addons: + description: A related resource object from type configured-link-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - configured-link-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + required: + - data + title: Configured link addons + type: object + external_link_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-link-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External link service + type: object + required: + - external_link_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-link-accounts + type: string + required: + - type + type: object + required: + - data + type: object + AuthorizedLinkAccountResponse: + properties: + data: + $ref: '#/components/schemas/AuthorizedLinkAccount' + required: + - data + type: object + AuthorizedLinkAccountTypeEnum: + enum: + - authorized-link-accounts + type: string + AuthorizedStorageAccount: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + default_root_folder: + type: string + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + external_storage_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-storage-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: External storage service + type: object + required: + - external_storage_service + type: object + type: + allOf: + - $ref: '#/components/schemas/AuthorizedStorageAccountTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + AuthorizedStorageAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + default_root_folder: + type: string + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + external_storage_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-storage-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External storage service + type: object + required: + - external_storage_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-storage-accounts + type: string + required: + - type + type: object + required: + - data + type: object + AuthorizedStorageAccountResponse: + properties: + data: + $ref: '#/components/schemas/AuthorizedStorageAccount' + required: + - data + type: object + AuthorizedStorageAccountTypeEnum: + enum: + - authorized-storage-accounts + type: string + ConfiguredCitationAddon: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + root_folder: + type: string + required: + - connected_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-citation-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_citation_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-citation-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: External citation service + type: object + required: + - base_account + type: object + type: + allOf: + - $ref: '#/components/schemas/ConfiguredCitationAddonTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + ConfiguredCitationAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + minLength: 1 + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + root_folder: + type: string + required: + - connected_capabilities + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-citation-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_citation_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-citation-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External citation service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-citation-addons + type: string + required: + - type + type: object + required: + - data + type: object + ConfiguredCitationAddonResponse: + properties: + data: + $ref: '#/components/schemas/ConfiguredCitationAddon' + required: + - data + type: object + ConfiguredCitationAddonTypeEnum: + enum: + - configured-citation-addons + type: string + ConfiguredComputingAddon: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + required: + - connected_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-computing-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_computing_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-computing-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: External computing service + type: object + required: + - base_account + type: object + type: + allOf: + - $ref: '#/components/schemas/ConfiguredComputingAddonTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + ConfiguredComputingAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + minLength: 1 + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + required: + - connected_capabilities + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-computing-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_computing_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-computing-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External computing service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-computing-addons + type: string + required: + - type + type: object + required: + - data + type: object + ConfiguredComputingAddonResponse: + properties: + data: + $ref: '#/components/schemas/ConfiguredComputingAddon' + required: + - data + type: object + ConfiguredComputingAddonTypeEnum: + enum: + - configured-computing-addons + type: string + ConfiguredLinkAddon: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + resource_type: + description: '* `Audiovisual` - Audiovisual + + * `Award` - Award + + * `Book` - Book + + * `BookChapter` - BookChapter + + * `Collection` - Collection + + * `ComputationalNotebook` - ComputationalNotebook + + * `ConferencePaper` - ConferencePaper + + * `ConferenceProceeding` - ConferenceProceeding + + * `DataPaper` - DataPaper + + * `Dataset` - Dataset + + * `Dissertation` - Dissertation + + * `Event` - Event + + * `Image` - Image + + * `Instrument` - Instrument + + * `InteractiveResource` - InteractiveResource + + * `Journal` - Journal + + * `JournalArticle` - JournalArticle + + * `Model` - Model + + * `OutputManagementPlan` - OutputManagementPlan + + * `PeerReview` - PeerReview + + * `PhysicalObject` - PhysicalObject + + * `Preprint` - Preprint + + * `Project` - Project + + * `Report` - Report + + * `Service` - Service + + * `Software` - Software + + * `Sound` - Sound + + * `Standard` - Standard + + * `StudyRegistration` - StudyRegistration + + * `Text` - Text + + * `Workflow` - Workflow + + * `Other` - Other' + enum: + - Audiovisual + - Award + - Book + - BookChapter + - Collection + - ComputationalNotebook + - ConferencePaper + - ConferenceProceeding + - DataPaper + - Dataset + - Dissertation + - Event + - Image + - Instrument + - InteractiveResource + - Journal + - JournalArticle + - Model + - OutputManagementPlan + - PeerReview + - PhysicalObject + - Preprint + - Project + - Report + - Service + - Software + - Sound + - Standard + - StudyRegistration + - Text + - Workflow + - Other + - null + nullable: true + type: string + target_id: + nullable: true + type: string + target_url: + format: uri + readOnly: true + type: string + required: + - connected_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-link-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_link_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-link-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: External link service + type: object + required: + - base_account + type: object + type: + allOf: + - $ref: '#/components/schemas/ConfiguredLinkAddonTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + ConfiguredLinkAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + resource_type: + description: '* `Audiovisual` - Audiovisual + + * `Award` - Award + + * `Book` - Book + + * `BookChapter` - BookChapter + + * `Collection` - Collection + + * `ComputationalNotebook` - ComputationalNotebook + + * `ConferencePaper` - ConferencePaper + + * `ConferenceProceeding` - ConferenceProceeding + + * `DataPaper` - DataPaper + + * `Dataset` - Dataset + + * `Dissertation` - Dissertation + + * `Event` - Event + + * `Image` - Image + + * `Instrument` - Instrument + + * `InteractiveResource` - InteractiveResource + + * `Journal` - Journal + + * `JournalArticle` - JournalArticle + + * `Model` - Model + + * `OutputManagementPlan` - OutputManagementPlan + + * `PeerReview` - PeerReview + + * `PhysicalObject` - PhysicalObject + + * `Preprint` - Preprint + + * `Project` - Project + + * `Report` - Report + + * `Service` - Service + + * `Software` - Software + + * `Sound` - Sound + + * `Standard` - Standard + + * `StudyRegistration` - StudyRegistration + + * `Text` - Text + + * `Workflow` - Workflow + + * `Other` - Other' + enum: + - Audiovisual + - Award + - Book + - BookChapter + - Collection + - ComputationalNotebook + - ConferencePaper + - ConferenceProceeding + - DataPaper + - Dataset + - Dissertation + - Event + - Image + - Instrument + - InteractiveResource + - Journal + - JournalArticle + - Model + - OutputManagementPlan + - PeerReview + - PhysicalObject + - Preprint + - Project + - Report + - Service + - Software + - Sound + - Standard + - StudyRegistration + - Text + - Workflow + - Other + - null + nullable: true + type: string + target_id: + minLength: 1 + nullable: true + type: string + target_url: + format: uri + minLength: 1 + readOnly: true + type: string + required: + - connected_capabilities + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-link-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_link_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-link-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External link service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-link-addons + type: string + required: + - type + type: object + required: + - data + type: object + ConfiguredLinkAddonResponse: + properties: + data: + $ref: '#/components/schemas/ConfiguredLinkAddon' + required: + - data + type: object + ConfiguredLinkAddonTypeEnum: + enum: + - configured-link-addons + type: string + ConfiguredStorageAddon: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + root_folder: + type: string + required: + - connected_capabilities + type: object + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-storage-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_storage_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - external-storage-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + readOnly: true + required: + - data + title: External storage service + type: object + required: + - base_account + type: object + type: + allOf: + - $ref: '#/components/schemas/ConfiguredStorageAddonTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + type: object + ConfiguredStorageAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + root_folder: + type: string + required: + - connected_capabilities + type: object + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-storage-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_storage_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-storage-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External storage service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-storage-addons + type: string + required: + - type + type: object + required: + - data + type: object + ConfiguredStorageAddonResponse: + properties: + data: + $ref: '#/components/schemas/ConfiguredStorageAddon' + required: + - data + type: object + ConfiguredStorageAddonTypeEnum: + enum: + - configured-storage-addons + type: string + ExternalCitationService: + additionalProperties: false + properties: + attributes: + properties: + api_base_url_options: + items: + type: string + readOnly: true + type: array + auth_uri: + readOnly: true + type: string + configurable_api_root: + readOnly: true + type: string + credentials_format: + description: '* `UNSPECIFIED` - UNSPECIFIED + + * `OAUTH2` - OAUTH2 + + * `ACCESS_KEY_SECRET_KEY` - ACCESS_KEY_SECRET_KEY + + * `USERNAME_PASSWORD` - USERNAME_PASSWORD + + * `PERSONAL_ACCESS_TOKEN` - PERSONAL_ACCESS_TOKEN + + * `OAUTH1A` - OAUTH1A + + * `DATAVERSE_API_TOKEN` - DATAVERSE_API_TOKEN' + enum: + - UNSPECIFIED + - OAUTH2 + - ACCESS_KEY_SECRET_KEY + - USERNAME_PASSWORD + - PERSONAL_ACCESS_TOKEN + - OAUTH1A + - DATAVERSE_API_TOKEN + readOnly: true + type: string + display_name: + type: string + external_service_name: + readOnly: true + type: string + icon_url: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + supported_features: + items: + description: '* `FORKING_PARTIAL` - FORKING_PARTIAL + + * `PERMISSIONS_PARTIAL` - PERMISSIONS_PARTIAL' + enum: + - FORKING_PARTIAL + - PERMISSIONS_PARTIAL + type: string + readOnly: true + type: array + wb_key: + type: string + required: + - display_name + type: object + id: {} + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + addon_imp: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-imps + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Addon imp + type: object + required: + - addon_imp + type: object + type: + allOf: + - $ref: '#/components/schemas/ExternalCitationServiceTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + ExternalCitationServiceResponse: + properties: + data: + $ref: '#/components/schemas/ExternalCitationService' + required: + - data + type: object + ExternalCitationServiceTypeEnum: + enum: + - external-citation-services + type: string + ExternalComputingService: + additionalProperties: false + properties: + attributes: + properties: + api_base_url_options: + items: + type: string + readOnly: true + type: array + auth_uri: + readOnly: true + type: string + configurable_api_root: + readOnly: true + type: string + credentials_format: + description: '* `UNSPECIFIED` - UNSPECIFIED + + * `OAUTH2` - OAUTH2 + + * `ACCESS_KEY_SECRET_KEY` - ACCESS_KEY_SECRET_KEY + + * `USERNAME_PASSWORD` - USERNAME_PASSWORD + + * `PERSONAL_ACCESS_TOKEN` - PERSONAL_ACCESS_TOKEN + + * `OAUTH1A` - OAUTH1A + + * `DATAVERSE_API_TOKEN` - DATAVERSE_API_TOKEN' + enum: + - UNSPECIFIED + - OAUTH2 + - ACCESS_KEY_SECRET_KEY + - USERNAME_PASSWORD + - PERSONAL_ACCESS_TOKEN + - OAUTH1A + - DATAVERSE_API_TOKEN + readOnly: true + type: string + display_name: + type: string + icon_url: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + supported_features: + items: + description: '* `ADD_UPDATE_FILES_PARTIAL` - ADD_UPDATE_FILES_PARTIAL + + * `FORKING_PARTIAL` - FORKING_PARTIAL + + * `LOGS_PARTIAL` - LOGS_PARTIAL + + * `PERMISSIONS_PARTIAL` - PERMISSIONS_PARTIAL + + * `REGISTERING_PARTIAL` - REGISTERING_PARTIAL' + enum: + - ADD_UPDATE_FILES_PARTIAL + - FORKING_PARTIAL + - LOGS_PARTIAL + - PERMISSIONS_PARTIAL + - REGISTERING_PARTIAL + type: string + readOnly: true + type: array + wb_key: + type: string + required: + - display_name + type: object + id: {} + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + addon_imp: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-imps + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Addon imp + type: object + required: + - addon_imp + type: object + type: + allOf: + - $ref: '#/components/schemas/ExternalComputingServiceTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + ExternalComputingServiceResponse: + properties: + data: + $ref: '#/components/schemas/ExternalComputingService' + required: + - data + type: object + ExternalComputingServiceTypeEnum: + enum: + - external-computing-services + type: string + ExternalLinkService: + additionalProperties: false + properties: + attributes: + properties: + api_base_url_options: + items: + type: string + readOnly: true + type: array + auth_uri: + readOnly: true + type: string + configurable_api_root: + readOnly: true + type: string + credentials_format: + description: '* `UNSPECIFIED` - UNSPECIFIED + + * `OAUTH2` - OAUTH2 + + * `ACCESS_KEY_SECRET_KEY` - ACCESS_KEY_SECRET_KEY + + * `USERNAME_PASSWORD` - USERNAME_PASSWORD + + * `PERSONAL_ACCESS_TOKEN` - PERSONAL_ACCESS_TOKEN + + * `OAUTH1A` - OAUTH1A + + * `DATAVERSE_API_TOKEN` - DATAVERSE_API_TOKEN' + enum: + - UNSPECIFIED + - OAUTH2 + - ACCESS_KEY_SECRET_KEY + - USERNAME_PASSWORD + - PERSONAL_ACCESS_TOKEN + - OAUTH1A + - DATAVERSE_API_TOKEN + readOnly: true + type: string + display_name: + type: string + external_service_name: + readOnly: true + type: string + icon_url: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + supported_features: + items: + description: '* `ADD_UPDATE_FILES` - ADD_UPDATE_FILES + + * `DELETE_FILES` - DELETE_FILES + + * `FORKING` - FORKING + + * `FORKING_PARTIAL` - FORKING_PARTIAL + + * `LOGS` - LOGS + + * `LOGS_PARTIAL` - LOGS_PARTIAL + + * `PERMISSIONS` - PERMISSIONS + + * `REGISTERING` - REGISTERING + + * `FILE_VERSIONS` - FILE_VERSIONS' + enum: + - ADD_UPDATE_FILES + - DELETE_FILES + - FORKING + - FORKING_PARTIAL + - LOGS + - LOGS_PARTIAL + - PERMISSIONS + - REGISTERING + - FILE_VERSIONS + type: string + readOnly: true + type: array + supported_resource_types: + items: + description: '* `Audiovisual` - Audiovisual + + * `Award` - Award + + * `Book` - Book + + * `BookChapter` - BookChapter + + * `Collection` - Collection + + * `ComputationalNotebook` - ComputationalNotebook + + * `ConferencePaper` - ConferencePaper + + * `ConferenceProceeding` - ConferenceProceeding + + * `DataPaper` - DataPaper + + * `Dataset` - Dataset + + * `Dissertation` - Dissertation + + * `Event` - Event + + * `Image` - Image + + * `Instrument` - Instrument + + * `InteractiveResource` - InteractiveResource + + * `Journal` - Journal + + * `JournalArticle` - JournalArticle + + * `Model` - Model + + * `OutputManagementPlan` - OutputManagementPlan + + * `PeerReview` - PeerReview + + * `PhysicalObject` - PhysicalObject + + * `Preprint` - Preprint + + * `Project` - Project + + * `Report` - Report + + * `Service` - Service + + * `Software` - Software + + * `Sound` - Sound + + * `Standard` - Standard + + * `StudyRegistration` - StudyRegistration + + * `Text` - Text + + * `Workflow` - Workflow + + * `Other` - Other' + enum: + - Audiovisual + - Award + - Book + - BookChapter + - Collection + - ComputationalNotebook + - ConferencePaper + - ConferenceProceeding + - DataPaper + - Dataset + - Dissertation + - Event + - Image + - Instrument + - InteractiveResource + - Journal + - JournalArticle + - Model + - OutputManagementPlan + - PeerReview + - PhysicalObject + - Preprint + - Project + - Report + - Service + - Software + - Sound + - Standard + - StudyRegistration + - Text + - Workflow + - Other + type: string + readOnly: true + type: array + wb_key: + type: string + required: + - display_name + type: object + id: {} + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + addon_imp: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-imps + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Addon imp + type: object + required: + - addon_imp + type: object + type: + allOf: + - $ref: '#/components/schemas/ExternalLinkServiceTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + ExternalLinkServiceResponse: + properties: + data: + $ref: '#/components/schemas/ExternalLinkService' + required: + - data + type: object + ExternalLinkServiceTypeEnum: + enum: + - external-link-services + type: string + ExternalStorageService: + additionalProperties: false + properties: + attributes: + properties: + api_base_url_options: + items: + type: string + readOnly: true + type: array + auth_uri: + readOnly: true + type: string + configurable_api_root: + readOnly: true + type: string + credentials_format: + description: '* `UNSPECIFIED` - UNSPECIFIED + + * `OAUTH2` - OAUTH2 + + * `ACCESS_KEY_SECRET_KEY` - ACCESS_KEY_SECRET_KEY + + * `USERNAME_PASSWORD` - USERNAME_PASSWORD + + * `PERSONAL_ACCESS_TOKEN` - PERSONAL_ACCESS_TOKEN + + * `OAUTH1A` - OAUTH1A + + * `DATAVERSE_API_TOKEN` - DATAVERSE_API_TOKEN' + enum: + - UNSPECIFIED + - OAUTH2 + - ACCESS_KEY_SECRET_KEY + - USERNAME_PASSWORD + - PERSONAL_ACCESS_TOKEN + - OAUTH1A + - DATAVERSE_API_TOKEN + readOnly: true + type: string + display_name: + type: string + external_service_name: + readOnly: true + type: string + icon_url: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + max_concurrent_downloads: + maximum: 2147483647 + minimum: -2147483648 + type: integer + max_upload_mb: + maximum: 2147483647 + minimum: -2147483648 + type: integer + supported_features: + items: + description: '* `ADD_UPDATE_FILES` - ADD_UPDATE_FILES + + * `ADD_UPDATE_FILES_PARTIAL` - ADD_UPDATE_FILES_PARTIAL + + * `DELETE_FILES` - DELETE_FILES + + * `DELETE_FILES_PARTIAL` - DELETE_FILES_PARTIAL + + * `FORKING` - FORKING + + * `LOGS` - LOGS + + * `PERMISSIONS` - PERMISSIONS + + * `REGISTERING` - REGISTERING + + * `FILE_VERSIONS` - FILE_VERSIONS + + * `COPY_INTO` - COPY_INTO + + * `DOWNLOAD_AS_ZIP` - DOWNLOAD_AS_ZIP' + enum: + - ADD_UPDATE_FILES + - ADD_UPDATE_FILES_PARTIAL + - DELETE_FILES + - DELETE_FILES_PARTIAL + - FORKING + - LOGS + - PERMISSIONS + - REGISTERING + - FILE_VERSIONS + - COPY_INTO + - DOWNLOAD_AS_ZIP + type: string + readOnly: true + type: array + wb_key: + type: string + required: + - max_concurrent_downloads + - max_upload_mb + - display_name + type: object + id: {} + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + addon_imp: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - addon-imps + title: Resource Type Name + type: string + required: + - id + - type + type: object + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Addon imp + type: object + required: + - addon_imp + type: object + type: + allOf: + - $ref: '#/components/schemas/ExternalStorageServiceTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + ExternalStorageServiceResponse: + properties: + data: + $ref: '#/components/schemas/ExternalStorageService' + required: + - data + type: object + ExternalStorageServiceTypeEnum: + enum: + - external-storage-services + type: string + PaginatedExternalCitationServiceList: + properties: + data: + items: + $ref: '#/components/schemas/ExternalCitationService' + type: array + links: + properties: + first: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + last: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + next: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + prev: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + required: + - count + - next + - prev + type: object + meta: + properties: + pagination: + properties: + count: + example: 2 + type: integer + page: + example: 1 + type: integer + pages: + example: 1 + type: integer + required: + - count + - next + - prev + type: object + required: + - pagination + type: object + required: + - meta + - data + - links + type: object + PaginatedExternalComputingServiceList: + properties: + data: + items: + $ref: '#/components/schemas/ExternalComputingService' + type: array + links: + properties: + first: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + last: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + next: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + prev: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + required: + - count + - next + - prev + type: object + meta: + properties: + pagination: + properties: + count: + example: 2 + type: integer + page: + example: 1 + type: integer + pages: + example: 1 + type: integer + required: + - count + - next + - prev + type: object + required: + - pagination + type: object + required: + - meta + - data + - links + type: object + PaginatedExternalLinkServiceList: + properties: + data: + items: + $ref: '#/components/schemas/ExternalLinkService' + type: array + links: + properties: + first: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + last: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + next: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + prev: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + required: + - count + - next + - prev + type: object + meta: + properties: + pagination: + properties: + count: + example: 2 + type: integer + page: + example: 1 + type: integer + pages: + example: 1 + type: integer + required: + - count + - next + - prev + type: object + required: + - pagination + type: object + required: + - meta + - data + - links + type: object + PaginatedExternalStorageServiceList: + properties: + data: + items: + $ref: '#/components/schemas/ExternalStorageService' + type: array + links: + properties: + first: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + last: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + next: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + prev: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + required: + - count + - next + - prev + type: object + meta: + properties: + pagination: + properties: + count: + example: 2 + type: integer + page: + example: 1 + type: integer + pages: + example: 1 + type: integer + required: + - count + - next + - prev + type: object + required: + - pagination + type: object + required: + - meta + - data + - links + type: object + PaginatedResourceReferenceList: + properties: + data: + items: + $ref: '#/components/schemas/ResourceReference' + type: array + links: + properties: + first: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + last: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + next: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + prev: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + required: + - count + - next + - prev + type: object + meta: + properties: + pagination: + properties: + count: + example: 2 + type: integer + page: + example: 1 + type: integer + pages: + example: 1 + type: integer + required: + - count + - next + - prev + type: object + required: + - pagination + type: object + required: + - meta + - data + - links + type: object + PaginatedUserReferenceList: + properties: + data: + items: + $ref: '#/components/schemas/UserReference' + type: array + links: + properties: + first: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + last: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + next: + example: http://api.example.org/accounts/?page[number]=3 + format: uri + nullable: true + type: string + prev: + example: http://api.example.org/accounts/?page[number]=1 + format: uri + nullable: true + type: string + required: + - count + - next + - prev + type: object + meta: + properties: + pagination: + properties: + count: + example: 2 + type: integer + page: + example: 1 + type: integer + pages: + example: 1 + type: integer + required: + - count + - next + - prev + type: object + required: + - pagination + type: object + required: + - meta + - data + - links + type: object + PatchedAuthorizedCitationAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + default_root_folder: + type: string + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + id: {} + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_citation_addons: + description: A related resource object from type configured-citation-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - configured-citation-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + required: + - data + title: Configured citation addons + type: object + external_citation_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-citation-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External citation service + type: object + required: + - external_citation_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-citation-accounts + type: string + required: + - type + - id + type: object + required: + - data + type: object + PatchedAuthorizedComputingAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + id: {} + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_computing_addons: + description: A related resource object from type configured-computing-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - configured-computing-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + required: + - data + title: Configured computing addons + type: object + external_computing_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-computing-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External computing service + type: object + required: + - external_computing_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-computing-accounts + type: string + required: + - type + - id + type: object + required: + - data + type: object + PatchedAuthorizedLinkAccountRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + api_base_url: + format: uri + nullable: true + type: string + auth_url: + minLength: 1 + readOnly: true + type: string + authorized_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + authorized_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + credentials: + writeOnly: true + credentials_available: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + id: + format: uuid + readOnly: true + type: string + initiate_oauth: + type: boolean + writeOnly: true + required: + - authorized_capabilities + type: object + id: {} + relationships: + properties: + account_owner: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - user-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Account owner + type: object + authorized_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized operations + type: object + configured_link_addons: + description: A related resource object from type configured-link-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - configured-link-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + required: + - data + title: Configured link addons + type: object + external_link_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-link-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: External link service + type: object + required: + - external_link_service + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - authorized-link-accounts + type: string + required: + - type + - id + type: object + required: + - data + type: object + PatchedConfiguredCitationAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + minLength: 1 + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + root_folder: + type: string + required: + - connected_capabilities + type: object + id: {} + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-citation-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_citation_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-citation-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External citation service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-citation-addons + type: string + required: + - type + - id + type: object + required: + - data + type: object + PatchedConfiguredComputingAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + minLength: 1 + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + required: + - connected_capabilities + type: object + id: {} + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-computing-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_computing_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-computing-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External computing service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-computing-addons + type: string + required: + - type + - id + type: object + required: + - data + type: object + PatchedConfiguredLinkAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + resource_type: + description: '* `Audiovisual` - Audiovisual + + * `Award` - Award + + * `Book` - Book + + * `BookChapter` - BookChapter + + * `Collection` - Collection + + * `ComputationalNotebook` - ComputationalNotebook + + * `ConferencePaper` - ConferencePaper + + * `ConferenceProceeding` - ConferenceProceeding + + * `DataPaper` - DataPaper + + * `Dataset` - Dataset + + * `Dissertation` - Dissertation + + * `Event` - Event + + * `Image` - Image + + * `Instrument` - Instrument + + * `InteractiveResource` - InteractiveResource + + * `Journal` - Journal + + * `JournalArticle` - JournalArticle + + * `Model` - Model + + * `OutputManagementPlan` - OutputManagementPlan + + * `PeerReview` - PeerReview + + * `PhysicalObject` - PhysicalObject + + * `Preprint` - Preprint + + * `Project` - Project + + * `Report` - Report + + * `Service` - Service + + * `Software` - Software + + * `Sound` - Sound + + * `Standard` - Standard + + * `StudyRegistration` - StudyRegistration + + * `Text` - Text + + * `Workflow` - Workflow + + * `Other` - Other' + enum: + - Audiovisual + - Award + - Book + - BookChapter + - Collection + - ComputationalNotebook + - ConferencePaper + - ConferenceProceeding + - DataPaper + - Dataset + - Dissertation + - Event + - Image + - Instrument + - InteractiveResource + - Journal + - JournalArticle + - Model + - OutputManagementPlan + - PeerReview + - PhysicalObject + - Preprint + - Project + - Report + - Service + - Software + - Sound + - Standard + - StudyRegistration + - Text + - Workflow + - Other + - null + nullable: true + type: string + target_id: + minLength: 1 + nullable: true + type: string + target_url: + format: uri + minLength: 1 + readOnly: true + type: string + required: + - connected_capabilities + type: object + id: {} + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-link-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_link_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-link-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External link service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-link-addons + type: string + required: + - type + - id + type: object + required: + - data + type: object + PatchedConfiguredStorageAddonRequest: + properties: + data: + additionalProperties: false + properties: + attributes: + properties: + authorized_resource_uri: + minLength: 1 + type: string + writeOnly: true + connected_capabilities: + items: + description: '* `ACCESS` - ACCESS + + * `UPDATE` - UPDATE' + enum: + - ACCESS + - UPDATE + type: string + type: array + connected_operation_names: + items: + minLength: 1 + type: string + readOnly: true + type: array + current_user_is_owner: + readOnly: true + type: boolean + display_name: + maxLength: 256 + nullable: true + type: string + external_service_name: + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + root_folder: + type: string + required: + - connected_capabilities + type: object + id: {} + relationships: + properties: + authorized_resource: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Authorized resource + type: object + base_account: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - authorized-storage-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + required: + - data + title: Base account + type: object + connected_operations: + description: The identifier of the related object. + properties: + data: + properties: + id: + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - addon-operations + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: Connected operations + type: object + external_storage_service: + description: The identifier of the related object. + properties: + data: + properties: + id: + format: uuid + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share + common attributes and relationships. + enum: + - external-storage-services + title: Resource Type Name + type: string + required: + - id + - type + type: object + readOnly: true + required: + - data + title: External storage service + type: object + required: + - base_account + type: object + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + enum: + - configured-storage-addons + type: string + required: + - type + - id + type: object + required: + - data + type: object + ResourceReference: + additionalProperties: false + properties: + attributes: + properties: + resource_uri: + format: uri + maxLength: 200 + type: string + required: + - resource_uri + type: object + id: + format: uuid + type: string + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + configured_citation_addons: + description: A related resource object from type configured-citation-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-citation-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured citation addons + type: object + configured_computing_addons: + description: A related resource object from type configured-computing-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-computing-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured computing addons + type: object + configured_link_addons: + description: A related resource object from type configured-link-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-link-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured link addons + type: object + configured_storage_addons: + description: A related resource object from type configured-storage-addons + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - configured-storage-addons + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured storage addons + type: object + required: + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: object + type: + allOf: + - $ref: '#/components/schemas/ResourceReferenceTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + ResourceReferenceResponse: + properties: + data: + $ref: '#/components/schemas/ResourceReference' + required: + - data + type: object + ResourceReferenceTypeEnum: + enum: + - resource-references + type: string + UserReference: + additionalProperties: false + properties: + attributes: + properties: + user_uri: + format: uri + maxLength: 200 + type: string + required: + - user_uri + type: object + id: + format: uuid + type: string + links: + properties: + self: + example: http://api.example.org/accounts/123 + format: uri + nullable: false + type: string + type: object + relationships: + properties: + authorized_citation_accounts: + description: A related resource object from type authorized-citation-accounts + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-citation-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Authorized citation accounts + type: object + authorized_computing_accounts: + description: A related resource object from type authorized-computing-accounts + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-computing-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Authorized computing accounts + type: object + authorized_link_accounts: + description: A related resource object from type authorized-citation-accounts + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-citation-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Authorized link accounts + type: object + authorized_storage_accounts: + description: A related resource object from type authorized-storage-accounts + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - authorized-storage-accounts + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Authorized storage accounts + type: object + configured_resources: + description: A related resource object from type resource-references + properties: + data: + items: + properties: + id: + description: The identifier of the related object. + title: Resource Identifier + type: string + type: + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common + attributes and relationships. + enum: + - resource-references + title: Resource Type Name + type: string + required: + - id + - type + type: object + type: array + links: + properties: + related: + example: http://api.example.org/accounts/123 + format: uri + nullable: true + type: string + type: object + required: + - data + title: Configured resources + type: object + required: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: object + type: + allOf: + - $ref: '#/components/schemas/UserReferenceTypeEnum' + description: The [type](https://jsonapi.org/format/#document-resource-object-identification) + member is used to describe resource objects that share common attributes + and relationships. + required: + - type + - id + type: object + UserReferenceResponse: + properties: + data: + $ref: '#/components/schemas/UserReference' + required: + - data + type: object + UserReferenceTypeEnum: + enum: + - user-references + type: string +info: + description: Addons service designed for use with OSF + title: GravyValet API + version: 1.0.0 +openapi: 3.0.3 +paths: + /v1/addon-imps/: + get: + description: viewset for read-only access to any `StaticDataclassModel` + operationId: addon_imps_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - addon-imps + /v1/addon-imps/{id}/: + get: + description: viewset for read-only access to any `StaticDataclassModel` + operationId: addon_imps_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - addon-imps + /v1/addon-imps/{id}/implemented_operations: + get: + description: Fetch all related AddonOperations to this AddonImp + operationId: addon_imps_retrieve_2_related_implemented_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: + - addon-imps + /v1/addon-operation-invocations/: + post: + description: Perform some action using external service, for instance list files + on storage provider. In order to perform such action you need to include configured_addon + relationship + operationId: addon_operation_invocations_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationInvocationRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddonOperationInvocationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AddonOperationInvocationRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationInvocationResponse' + description: '' + tags: + - addon-operation-invocations + /v1/addon-operation-invocations/{id}/: + get: + description: Get singular instance of addon operation invocation by it's pk. + May be useful to view action log + operationId: addon_operation_invocations_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operation-invocations] + schema: + items: + enum: + - url + - invocation_status + - operation_kwargs + - operation_result + - operation + - by_user + - thru_account + - thru_addon + - created + - modified + - operation_name + type: string + type: array + - description: A UUID string identifying this addon operation invocation. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - thru_account + - thru_addon + - operation + - by_user + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationInvocationResponse' + description: '' + tags: + - addon-operation-invocations + /v1/addon-operation-invocations/{id}/by_user: + get: + description: Fetch AddonOperationInvocation's UserReference + operationId: addon_operation_invocations_retrieve_2_related_by_user + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A UUID string identifying this User Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserReferenceResponse' + description: '' + tags: &id001 + - addon-operation-invocations + /v1/addon-operation-invocations/{id}/operation: + get: + description: Fetch AddonOperationInvocation's AddonOperation + operationId: addon_operation_invocations_retrieve_2_related_operation + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id001 + /v1/addon-operation-invocations/{id}/thru_account: + get: + description: Fetch AddonOperationInvocation's AuthorizedStorageAccount + operationId: addon_operation_invocations_retrieve_2_related_thru_account + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-storage-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_storage_addons + - credentials + - default_root_folder + - external_storage_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Storage Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_storage_service + - configured_storage_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountResponse' + description: '' + tags: *id001 + /v1/addon-operation-invocations/{id}/thru_addon: + get: + description: Fetch AddonOperationInvocation's ConfiguredStorageAddon + operationId: addon_operation_invocations_retrieve_2_related_thru_addon + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-storage-addons] + schema: + items: + enum: + - id + - url + - display_name + - root_folder + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_storage_service + - current_user_is_owner + - external_service_name + type: string + type: array + - description: A UUID string identifying this Configured Storage Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_storage_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonResponse' + description: '' + tags: *id001 + /v1/addon-operations/: + get: + description: viewset for read-only access to any `StaticDataclassModel` + operationId: addon_operations_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: + - addon-operations + /v1/addon-operations/{id}/: + get: + description: viewset for read-only access to any `StaticDataclassModel` + operationId: addon_operations_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: + - addon-operations + /v1/addon-operations/{id}/implemented_by: + get: + description: Fetch AddonOperation's AddonImp + operationId: addon_operations_retrieve_2_related_implemented_by + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - addon-operations + /v1/authorized-citation-accounts/: + post: + description: Create new authorized citation account for given external citation + service. For OAuth services it's required to create account with `"initiate_oauth"=true` + in order to proceed with OAuth flow + operationId: authorized_citation_accounts_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountResponse' + description: '' + tags: + - authorized-citation-accounts + /v1/authorized-citation-accounts/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_citation_accounts_destroy + parameters: + - description: A UUID string identifying this Authorized Citation Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - authorized-citation-accounts + get: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_citation_accounts_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-citation-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_citation_addons + - credentials + - default_root_folder + - external_citation_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Citation Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_citation_service + - configured_citation_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountResponse' + description: '' + tags: + - authorized-citation-accounts + patch: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_citation_accounts_partial_update + parameters: + - description: A UUID string identifying this Authorized Citation Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedAuthorizedCitationAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedAuthorizedCitationAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedAuthorizedCitationAccountRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountResponse' + description: '' + tags: + - authorized-citation-accounts + /v1/authorized-citation-accounts/{id}/account_owner: + get: + description: Fetch AuthorizedCitationAccount's UserReference + operationId: authorized_citation_accounts_retrieve_2_related_account_owner + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A UUID string identifying this User Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserReferenceResponse' + description: '' + tags: &id002 + - authorized-citation-accounts + /v1/authorized-citation-accounts/{id}/authorized_operations: + get: + description: Fetch all related AddonOperations to this AuthorizedCitationAccount + operationId: authorized_citation_accounts_retrieve_2_related_authorized_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id002 + /v1/authorized-citation-accounts/{id}/configured_citation_addons: + get: + description: Fetch all related ConfiguredCitationAddons to this AuthorizedCitationAccount + operationId: authorized_citation_accounts_retrieve_2_related_configured_citation_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-citation-addons] + schema: + items: + enum: + - id + - url + - display_name + - root_folder + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_service_name + - external_citation_service + - current_user_is_owner + type: string + type: array + - description: A UUID string identifying this Configured Citation Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_citation_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonResponse' + description: '' + tags: *id002 + /v1/authorized-citation-accounts/{id}/external_citation_service: + get: + description: Fetch AuthorizedCitationAccount's ExternalCitationService + operationId: authorized_citation_accounts_retrieve_2_related_external_citation_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-citation-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - wb_key + - external_service_name + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Citation Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalCitationServiceResponse' + description: '' + security: + - {} + tags: *id002 + /v1/authorized-computing-accounts/: + post: + description: "Create new authorized computing account for given external computing\ + \ service.\n For OAuth services it's required to create account with `\"initiate_oauth\"\ + =true` in order to proceed with OAuth flow" + operationId: authorized_computing_accounts_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountResponse' + description: '' + tags: + - authorized-computing-accounts + /v1/authorized-computing-accounts/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_computing_accounts_destroy + parameters: + - description: A UUID string identifying this Authorized Computing Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - authorized-computing-accounts + get: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_computing_accounts_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-computing-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_computing_addons + - credentials + - external_computing_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Computing Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_computing_service + - configured_computing_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountResponse' + description: '' + tags: + - authorized-computing-accounts + patch: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_computing_accounts_partial_update + parameters: + - description: A UUID string identifying this Authorized Computing Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedAuthorizedComputingAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedAuthorizedComputingAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedAuthorizedComputingAccountRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountResponse' + description: '' + tags: + - authorized-computing-accounts + /v1/authorized-computing-accounts/{id}/account_owner: + get: + description: Fetch AuthorizedComputingAccount's UserReference + operationId: authorized_computing_accounts_retrieve_2_related_account_owner + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A UUID string identifying this User Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserReferenceResponse' + description: '' + tags: &id003 + - authorized-computing-accounts + /v1/authorized-computing-accounts/{id}/authorized_operations: + get: + description: Fetch all related AddonOperations to this AuthorizedComputingAccount + operationId: authorized_computing_accounts_retrieve_2_related_authorized_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id003 + /v1/authorized-computing-accounts/{id}/configured_computing_addons: + get: + description: Fetch all related ConfiguredComputingAddons to this AuthorizedComputingAccount + operationId: authorized_computing_accounts_retrieve_2_related_configured_computing_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-computing-addons] + schema: + items: + enum: + - id + - url + - display_name + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_service_name + - external_computing_service + - current_user_is_owner + type: string + type: array + - description: A UUID string identifying this Configured Computing Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_computing_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonResponse' + description: '' + tags: *id003 + /v1/authorized-computing-accounts/{id}/external_computing_service: + get: + description: Fetch AuthorizedComputingAccount's ExternalComputingService + operationId: authorized_computing_accounts_retrieve_2_related_external_computing_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-computing-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - supported_features + - icon_url + - wb_key + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Computing Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalComputingServiceResponse' + description: '' + security: + - {} + tags: *id003 + /v1/authorized-link-accounts/: + post: + description: "Create new authorized link account for given external link service.\n\ + \ For OAuth services it's required to create account with `\"initiate_oauth\"\ + =true` in order to proceed with OAuth flow" + operationId: authorized_link_accounts_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountResponse' + description: '' + tags: + - authorized-link-accounts + /v1/authorized-link-accounts/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_link_accounts_destroy + parameters: + - description: A UUID string identifying this Authorized Link Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - authorized-link-accounts + get: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_link_accounts_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-link-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_link_addons + - credentials + - external_link_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Link Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_link_service + - configured_link_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountResponse' + description: '' + tags: + - authorized-link-accounts + patch: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_link_accounts_partial_update + parameters: + - description: A UUID string identifying this Authorized Link Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedAuthorizedLinkAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedAuthorizedLinkAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedAuthorizedLinkAccountRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountResponse' + description: '' + tags: + - authorized-link-accounts + /v1/authorized-link-accounts/{id}/account_owner: + get: + description: Fetch AuthorizedLinkAccount's UserReference + operationId: authorized_link_accounts_retrieve_2_related_account_owner + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A UUID string identifying this User Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserReferenceResponse' + description: '' + tags: &id004 + - authorized-link-accounts + /v1/authorized-link-accounts/{id}/authorized_operations: + get: + description: Fetch all related AddonOperations to this AuthorizedLinkAccount + operationId: authorized_link_accounts_retrieve_2_related_authorized_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id004 + /v1/authorized-link-accounts/{id}/configured_link_addons: + get: + description: Fetch all related ConfiguredLinkAddons to this AuthorizedLinkAccount + operationId: authorized_link_accounts_retrieve_2_related_configured_link_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-link-addons] + schema: + items: + enum: + - id + - display_name + - target_url + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_link_service + - current_user_is_owner + - external_service_name + - resource_type + - target_id + type: string + type: array + - description: A UUID string identifying this Configured Link Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_link_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonResponse' + description: '' + tags: *id004 + /v1/authorized-link-accounts/{id}/external_link_service: + get: + description: Fetch AuthorizedLinkAccount's ExternalLinkService + operationId: authorized_link_accounts_retrieve_2_related_external_link_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-link-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_resource_types + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Link Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalLinkServiceResponse' + description: '' + security: + - {} + tags: *id004 + /v1/authorized-storage-accounts/: + post: + description: "Create new authorized storage account for given external storage\ + \ service.\n For OAuth services it's required to create account with `\"initiate_oauth\"\ + =true` in order to proceed with OAuth flow" + operationId: authorized_storage_accounts_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountResponse' + description: '' + tags: + - authorized-storage-accounts + /v1/authorized-storage-accounts/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_storage_accounts_destroy + parameters: + - description: A UUID string identifying this Authorized Storage Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - authorized-storage-accounts + get: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_storage_accounts_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-storage-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_storage_addons + - credentials + - default_root_folder + - external_storage_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Storage Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_storage_service + - configured_storage_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountResponse' + description: '' + tags: + - authorized-storage-accounts + patch: + description: viewset allowing create, retrieve, update, delete + operationId: authorized_storage_accounts_partial_update + parameters: + - description: A UUID string identifying this Authorized Storage Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '200': + description: No response body + tags: + - authorized-storage-accounts + /v1/authorized-storage-accounts/{id}/account_owner: + get: + description: Fetch AuthorizedStorageAccount's UserReference + operationId: authorized_storage_accounts_retrieve_2_related_account_owner + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A UUID string identifying this User Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserReferenceResponse' + description: '' + tags: &id005 + - authorized-storage-accounts + /v1/authorized-storage-accounts/{id}/authorized_operations: + get: + description: Fetch all related AddonOperations to this AuthorizedStorageAccount + operationId: authorized_storage_accounts_retrieve_2_related_authorized_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id005 + /v1/authorized-storage-accounts/{id}/external_storage_service: + get: + description: Fetch AuthorizedStorageAccount's ExternalStorageService + operationId: authorized_storage_accounts_retrieve_2_related_external_storage_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-storage-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - max_concurrent_downloads + - max_upload_mb + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Storage Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalStorageServiceResponse' + description: '' + security: + - {} + tags: *id005 + /v1/configured-citation-addons/: + post: + description: "Create new configured citation addon for given authorized citation\ + \ account, linking it to desired project.\n To configure it properly, you\ + \ must specify `root_folder` on the provider's side.\n Note that everything\ + \ under this folder is going to be accessible to everyone who has access to\ + \ this project" + operationId: configured_citation_addons_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonResponse' + description: '' + tags: + - configured-citation-addons + /v1/configured-citation-addons/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: configured_citation_addons_destroy + parameters: + - description: A UUID string identifying this Configured Citation Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - configured-citation-addons + get: + description: viewset allowing create, retrieve, update, delete + operationId: configured_citation_addons_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-citation-addons] + schema: + items: + enum: + - id + - url + - display_name + - root_folder + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_service_name + - external_citation_service + - current_user_is_owner + type: string + type: array + - description: A UUID string identifying this Configured Citation Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_citation_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonResponse' + description: '' + tags: + - configured-citation-addons + patch: + description: viewset allowing create, retrieve, update, delete + operationId: configured_citation_addons_partial_update + parameters: + - description: A UUID string identifying this Configured Citation Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedConfiguredCitationAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedConfiguredCitationAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfiguredCitationAddonRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonResponse' + description: '' + tags: + - configured-citation-addons + /v1/configured-citation-addons/{id}/authorized_resource: + get: + description: Fetch ConfiguredCitationAddon's ResourceReference + operationId: configured_citation_addons_retrieve_2_related_authorized_resource + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: A UUID string identifying this Resource Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ResourceReferenceResponse' + description: '' + tags: &id006 + - configured-citation-addons + /v1/configured-citation-addons/{id}/base_account: + get: + description: Fetch ConfiguredCitationAddon's AuthorizedCitationAccount + operationId: configured_citation_addons_retrieve_2_related_base_account + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-citation-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_citation_addons + - credentials + - default_root_folder + - external_citation_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Citation Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_citation_service + - configured_citation_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountResponse' + description: '' + tags: *id006 + /v1/configured-citation-addons/{id}/connected_operations: + get: + description: Fetch all related AddonOperations to this ConfiguredCitationAddon + operationId: configured_citation_addons_retrieve_2_related_connected_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id006 + /v1/configured-citation-addons/{id}/external_citation_service: + get: + description: Fetch ConfiguredCitationAddon's ExternalCitationService + operationId: configured_citation_addons_retrieve_2_related_external_citation_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-citation-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - wb_key + - external_service_name + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Citation Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalCitationServiceResponse' + description: '' + security: + - {} + tags: *id006 + /v1/configured-computing-addons/: + post: + description: "Create new configured computing addon for given authorized computing\ + \ account, linking it to desired project.\n To configure it properly, you\ + \ must specify `root_folder` on the provider's side.\n Note that everything\ + \ under this folder is going to be accessible to everyone who has access to\ + \ this project" + operationId: configured_computing_addons_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonResponse' + description: '' + tags: + - configured-computing-addons + /v1/configured-computing-addons/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: configured_computing_addons_destroy + parameters: + - description: A UUID string identifying this Configured Computing Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - configured-computing-addons + get: + description: viewset allowing create, retrieve, update, delete + operationId: configured_computing_addons_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-computing-addons] + schema: + items: + enum: + - id + - url + - display_name + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_service_name + - external_computing_service + - current_user_is_owner + type: string + type: array + - description: A UUID string identifying this Configured Computing Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_computing_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonResponse' + description: '' + tags: + - configured-computing-addons + patch: + description: viewset allowing create, retrieve, update, delete + operationId: configured_computing_addons_partial_update + parameters: + - description: A UUID string identifying this Configured Computing Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedConfiguredComputingAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedConfiguredComputingAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfiguredComputingAddonRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonResponse' + description: '' + tags: + - configured-computing-addons + /v1/configured-computing-addons/{id}/authorized_resource: + get: + description: Fetch ConfiguredComputingAddon's ResourceReference + operationId: configured_computing_addons_retrieve_2_related_authorized_resource + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: A UUID string identifying this Resource Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ResourceReferenceResponse' + description: '' + tags: &id007 + - configured-computing-addons + /v1/configured-computing-addons/{id}/base_account: + get: + description: Fetch ConfiguredComputingAddon's AuthorizedComputingAccount + operationId: configured_computing_addons_retrieve_2_related_base_account + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-computing-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_computing_addons + - credentials + - external_computing_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Computing Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_computing_service + - configured_computing_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountResponse' + description: '' + tags: *id007 + /v1/configured-computing-addons/{id}/connected_operations: + get: + description: Fetch all related AddonOperations to this ConfiguredComputingAddon + operationId: configured_computing_addons_retrieve_2_related_connected_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id007 + /v1/configured-computing-addons/{id}/external_computing_service: + get: + description: Fetch ConfiguredComputingAddon's ExternalComputingService + operationId: configured_computing_addons_retrieve_2_related_external_computing_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-computing-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - supported_features + - icon_url + - wb_key + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Computing Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalComputingServiceResponse' + description: '' + security: + - {} + tags: *id007 + /v1/configured-link-addons/: + post: + description: "Create new configured link addon for given authorized link account,\ + \ linking it to desired project.\n To configure it properly, you must specify\ + \ `root_folder` on the provider's side.\n Note that everything under this\ + \ folder is going to be accessible to everyone who has access to this project" + operationId: configured_link_addons_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonResponse' + description: '' + tags: + - configured-link-addons + /v1/configured-link-addons/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: configured_link_addons_destroy + parameters: + - description: A UUID string identifying this Configured Link Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - configured-link-addons + get: + description: viewset allowing create, retrieve, update, delete + operationId: configured_link_addons_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-link-addons] + schema: + items: + enum: + - id + - display_name + - target_url + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_link_service + - current_user_is_owner + - external_service_name + - resource_type + - target_id + type: string + type: array + - description: A UUID string identifying this Configured Link Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_link_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonResponse' + description: '' + tags: + - configured-link-addons + patch: + description: viewset allowing create, retrieve, update, delete + operationId: configured_link_addons_partial_update + parameters: + - description: A UUID string identifying this Configured Link Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedConfiguredLinkAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedConfiguredLinkAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfiguredLinkAddonRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonResponse' + description: '' + tags: + - configured-link-addons + /v1/configured-link-addons/{id}/authorized_resource: + get: + description: Fetch ConfiguredLinkAddon's ResourceReference + operationId: configured_link_addons_retrieve_2_related_authorized_resource + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: A UUID string identifying this Resource Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ResourceReferenceResponse' + description: '' + tags: &id008 + - configured-link-addons + /v1/configured-link-addons/{id}/base_account: + get: + description: Fetch ConfiguredLinkAddon's AuthorizedLinkAccount + operationId: configured_link_addons_retrieve_2_related_base_account + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-link-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_link_addons + - credentials + - external_link_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Link Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_link_service + - configured_link_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedLinkAccountResponse' + description: '' + tags: *id008 + /v1/configured-link-addons/{id}/connected_operations: + get: + description: Fetch all related AddonOperations to this ConfiguredLinkAddon + operationId: configured_link_addons_retrieve_2_related_connected_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id008 + /v1/configured-link-addons/{id}/external_link_service: + get: + description: Fetch ConfiguredLinkAddon's ExternalLinkService + operationId: configured_link_addons_retrieve_2_related_external_link_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-link-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_resource_types + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Link Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalLinkServiceResponse' + description: '' + security: + - {} + tags: *id008 + /v1/configured-link-addons/{id}/verified-links/: + get: + description: viewset allowing create, retrieve, update, delete + operationId: configured_link_addons_verified_links_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-link-addons] + schema: + items: + enum: + - id + - display_name + - target_url + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_link_service + - current_user_is_owner + - external_service_name + - resource_type + - target_id + type: string + type: array + - description: A UUID string identifying this Configured Link Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_link_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonResponse' + description: '' + tags: + - configured-link-addons + /v1/configured-storage-addons/: + post: + description: "Create new configured storage addon for given authorized storage\ + \ account, linking it to desired project.\n To configure it properly, you\ + \ must specify `root_folder` on the provider's side.\n Note that everything\ + \ under this folder is going to be accessible to everyone who has access to\ + \ this project" + operationId: configured_storage_addons_create + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonRequest' + required: true + responses: + '201': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonResponse' + description: '' + tags: + - configured-storage-addons + /v1/configured-storage-addons/{id}/: + delete: + description: viewset allowing create, retrieve, update, delete + operationId: configured_storage_addons_destroy + parameters: + - description: A UUID string identifying this Configured Storage Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + responses: + '204': + description: No response body + tags: + - configured-storage-addons + get: + description: viewset allowing create, retrieve, update, delete + operationId: configured_storage_addons_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-storage-addons] + schema: + items: + enum: + - id + - url + - display_name + - root_folder + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_storage_service + - current_user_is_owner + - external_service_name + type: string + type: array + - description: A UUID string identifying this Configured Storage Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_storage_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonResponse' + description: '' + tags: + - configured-storage-addons + patch: + description: viewset allowing create, retrieve, update, delete + operationId: configured_storage_addons_partial_update + parameters: + - description: A UUID string identifying this Configured Storage Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PatchedConfiguredStorageAddonRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedConfiguredStorageAddonRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfiguredStorageAddonRequest' + required: true + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonResponse' + description: '' + tags: + - configured-storage-addons + /v1/configured-storage-addons/{id}/authorized_resource: + get: + description: Fetch ConfiguredStorageAddon's ResourceReference + operationId: configured_storage_addons_retrieve_2_related_authorized_resource + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: A UUID string identifying this Resource Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ResourceReferenceResponse' + description: '' + tags: &id009 + - configured-storage-addons + /v1/configured-storage-addons/{id}/base_account: + get: + description: Fetch ConfiguredStorageAddon's AuthorizedStorageAccount + operationId: configured_storage_addons_retrieve_2_related_base_account + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-storage-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_storage_addons + - credentials + - default_root_folder + - external_storage_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Storage Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_storage_service + - configured_storage_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountResponse' + description: '' + tags: *id009 + /v1/configured-storage-addons/{id}/connected_operations: + get: + description: Fetch all related AddonOperations to this ConfiguredStorageAddon + operationId: configured_storage_addons_retrieve_2_related_connected_operations + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-operations] + schema: + items: + enum: + - url + - name + - docstring + - capability + - kwargs_jsonschema + - result_jsonschema + - implemented_by + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_by + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonOperationResponse' + description: '' + security: + - {} + tags: *id009 + /v1/configured-storage-addons/{id}/external_storage_service: + get: + description: Fetch ConfiguredStorageAddon's ExternalStorageService + operationId: configured_storage_addons_retrieve_2_related_external_storage_service + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-storage-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - max_concurrent_downloads + - max_upload_mb + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Storage Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalStorageServiceResponse' + description: '' + security: + - {} + tags: *id009 + /v1/external-citation-services/: + get: + description: Get the list of all available external citation services + operationId: external_citation_services_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-citation-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - wb_key + - external_service_name + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + - description: A page number within the paginated result set. + in: query + name: page[number] + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page[size] + required: false + schema: + type: integer + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PaginatedExternalCitationServiceList' + description: '' + security: + - {} + tags: + - external-citation-services + /v1/external-citation-services/{id}/: + get: + description: "This mixin provides a helper attributes to select or prefetch\ + \ related models\nbased on the include specified in the URL.\n\n__all__ can\ + \ be used to specify a prefetch which should be done regardless of the include\n\ + \n\n.. code:: python\n\n # When MyViewSet is called with ?include=author\ + \ it will prefetch author and authorbio\n class MyViewSet(viewsets.ModelViewSet):\n\ + \ queryset = Book.objects.all()\n prefetch_for_includes = {\n\ + \ '__all__': [],\n 'category.section': ['category']\n\ + \ }\n select_for_includes = {\n '__all__': [],\n\ + \ 'author': ['author', 'author__authorbio'],\n }" + operationId: external_citation_services_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-citation-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - wb_key + - external_service_name + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Citation Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalCitationServiceResponse' + description: '' + security: + - {} + tags: + - external-citation-services + /v1/external-citation-services/{id}/addon_imp: + get: + description: Fetch ExternalCitationService's AddonImp + operationId: external_citation_services_retrieve_2_related_addon_imp + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - external-citation-services + /v1/external-computing-services/: + get: + description: Get the list of all available external computing services + operationId: external_computing_services_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-computing-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - supported_features + - icon_url + - wb_key + - api_base_url_options + type: string + type: array + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + - description: A page number within the paginated result set. + in: query + name: page[number] + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page[size] + required: false + schema: + type: integer + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PaginatedExternalComputingServiceList' + description: '' + security: + - {} + tags: + - external-computing-services + /v1/external-computing-services/{id}/: + get: + description: "This mixin provides a helper attributes to select or prefetch\ + \ related models\nbased on the include specified in the URL.\n\n__all__ can\ + \ be used to specify a prefetch which should be done regardless of the include\n\ + \n\n.. code:: python\n\n # When MyViewSet is called with ?include=author\ + \ it will prefetch author and authorbio\n class MyViewSet(viewsets.ModelViewSet):\n\ + \ queryset = Book.objects.all()\n prefetch_for_includes = {\n\ + \ '__all__': [],\n 'category.section': ['category']\n\ + \ }\n select_for_includes = {\n '__all__': [],\n\ + \ 'author': ['author', 'author__authorbio'],\n }" + operationId: external_computing_services_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-computing-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - configurable_api_root + - supported_features + - icon_url + - wb_key + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Computing Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalComputingServiceResponse' + description: '' + security: + - {} + tags: + - external-computing-services + /v1/external-computing-services/{id}/addon_imp: + get: + description: Fetch ExternalComputingService's AddonImp + operationId: external_computing_services_retrieve_2_related_addon_imp + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - external-computing-services + /v1/external-link-services/: + get: + description: Get the list of all available external link services + operationId: external_link_services_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-link-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_resource_types + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + - description: A page number within the paginated result set. + in: query + name: page[number] + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page[size] + required: false + schema: + type: integer + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PaginatedExternalLinkServiceList' + description: '' + security: + - {} + tags: + - external-link-services + /v1/external-link-services/{id}/: + get: + description: "This mixin provides a helper attributes to select or prefetch\ + \ related models\nbased on the include specified in the URL.\n\n__all__ can\ + \ be used to specify a prefetch which should be done regardless of the include\n\ + \n\n.. code:: python\n\n # When MyViewSet is called with ?include=author\ + \ it will prefetch author and authorbio\n class MyViewSet(viewsets.ModelViewSet):\n\ + \ queryset = Book.objects.all()\n prefetch_for_includes = {\n\ + \ '__all__': [],\n 'category.section': ['category']\n\ + \ }\n select_for_includes = {\n '__all__': [],\n\ + \ 'author': ['author', 'author__authorbio'],\n }" + operationId: external_link_services_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-link-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_resource_types + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Link Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalLinkServiceResponse' + description: '' + security: + - {} + tags: + - external-link-services + /v1/external-link-services/{id}/addon_imp: + get: + description: Fetch ExternalLinkService's AddonImp + operationId: external_link_services_retrieve_2_related_addon_imp + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - external-link-services + /v1/external-storage-services/: + get: + description: Get the list of all available external storage services + operationId: external_storage_services_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-storage-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - max_concurrent_downloads + - max_upload_mb + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + - description: A page number within the paginated result set. + in: query + name: page[number] + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page[size] + required: false + schema: + type: integer + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PaginatedExternalStorageServiceList' + description: '' + security: + - {} + tags: + - external-storage-services + /v1/external-storage-services/{id}/: + get: + description: "This mixin provides a helper attributes to select or prefetch\ + \ related models\nbased on the include specified in the URL.\n\n__all__ can\ + \ be used to specify a prefetch which should be done regardless of the include\n\ + \n\n.. code:: python\n\n # When MyViewSet is called with ?include=author\ + \ it will prefetch author and authorbio\n class MyViewSet(viewsets.ModelViewSet):\n\ + \ queryset = Book.objects.all()\n prefetch_for_includes = {\n\ + \ '__all__': [],\n 'category.section': ['category']\n\ + \ }\n select_for_includes = {\n '__all__': [],\n\ + \ 'author': ['author', 'author__authorbio'],\n }" + operationId: external_storage_services_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[external-storage-services] + schema: + items: + enum: + - id + - addon_imp + - auth_uri + - credentials_format + - max_concurrent_downloads + - max_upload_mb + - display_name + - url + - wb_key + - external_service_name + - configurable_api_root + - supported_features + - icon_url + - api_base_url_options + type: string + type: array + - description: A UUID string identifying this External Storage Service. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - addon_imp + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ExternalStorageServiceResponse' + description: '' + security: + - {} + tags: + - external-storage-services + /v1/external-storage-services/{id}/addon_imp: + get: + description: Fetch ExternalStorageService's AddonImp + operationId: external_storage_services_retrieve_2_related_addon_imp + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[addon-imps] + schema: + items: + enum: + - url + - name + - docstring + - interface_docstring + - implemented_operations + type: string + type: array + - in: path + name: id + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - implemented_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AddonImpResponse' + description: '' + security: + - {} + tags: + - external-storage-services + /v1/resource-references/: + get: + description: Get resource reference by resource_uri. Even through this is a + list method, this endpoint returns only one entity + operationId: resource_references_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: Filter by resource_uri. This filter must be uniquely identifying. + in: query + name: filter[resource_uri] + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + - description: A page number within the paginated result set. + in: query + name: page[number] + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page[size] + required: false + schema: + type: integer + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PaginatedResourceReferenceList' + description: '' + tags: + - resource-references + /v1/resource-references/{id}/: + get: + description: Get resource reference by it's pk + operationId: resource_references_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: A UUID string identifying this Resource Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ResourceReferenceResponse' + description: '' + tags: + - resource-references + /v1/resource-references/{id}/configured_citation_addons: + get: + description: Fetch all related ConfiguredCitationAddons to this ResourceReference + operationId: resource_references_retrieve_2_related_configured_citation_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-citation-addons] + schema: + items: + enum: + - id + - url + - display_name + - root_folder + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_service_name + - external_citation_service + - current_user_is_owner + type: string + type: array + - description: A UUID string identifying this Configured Citation Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_citation_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredCitationAddonResponse' + description: '' + tags: &id010 + - resource-references + /v1/resource-references/{id}/configured_computing_addons: + get: + description: Fetch all related ConfiguredComputingAddons to this ResourceReference + operationId: resource_references_retrieve_2_related_configured_computing_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-computing-addons] + schema: + items: + enum: + - id + - url + - display_name + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_service_name + - external_computing_service + - current_user_is_owner + type: string + type: array + - description: A UUID string identifying this Configured Computing Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_computing_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredComputingAddonResponse' + description: '' + tags: *id010 + /v1/resource-references/{id}/configured_link_addons: + get: + description: Fetch all related ConfiguredLinkAddons to this ResourceReference + operationId: resource_references_retrieve_2_related_configured_link_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-link-addons] + schema: + items: + enum: + - id + - display_name + - target_url + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_link_service + - current_user_is_owner + - external_service_name + - resource_type + - target_id + type: string + type: array + - description: A UUID string identifying this Configured Link Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_link_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredLinkAddonResponse' + description: '' + tags: *id010 + /v1/resource-references/{id}/configured_storage_addons: + get: + description: Fetch all related ConfiguredStorageAddons to this ResourceReference + operationId: resource_references_retrieve_2_related_configured_storage_addons + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[configured-storage-addons] + schema: + items: + enum: + - id + - url + - display_name + - root_folder + - base_account + - authorized_resource + - authorized_resource_uri + - connected_capabilities + - connected_operations + - connected_operation_names + - external_storage_service + - current_user_is_owner + - external_service_name + type: string + type: array + - description: A UUID string identifying this Configured Storage Addon. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - base_account + - external_storage_service + - authorized_resource + - connected_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ConfiguredStorageAddonResponse' + description: '' + tags: *id010 + /v1/user-references/: + get: + description: Get user reference by user_uri. Even through this is a list method, + this endpoint returns only one entity + operationId: user_references_list + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: Filter by user_uri. This filter must be uniquely identifying. + in: query + name: filter[user_uri] + required: true + schema: + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A page number within the paginated result set. + in: query + name: page[number] + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page[size] + required: false + schema: + type: integer + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/PaginatedUserReferenceList' + description: '' + tags: + - user-references + /v1/user-references/{id}/: + get: + description: Get user reference by it's pk + operationId: user_references_retrieve + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[user-references] + schema: + items: + enum: + - url + - user_uri + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + - description: A UUID string identifying this User Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - authorized_storage_accounts + - authorized_citation_accounts + - authorized_computing_accounts + - authorized_link_accounts + - configured_resources + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/UserReferenceResponse' + description: '' + tags: + - user-references + /v1/user-references/{id}/authorized_citation_accounts: + get: + description: Fetch all related AuthorizedCitationAccounts to this UserReference + operationId: user_references_retrieve_2_related_authorized_citation_accounts + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-citation-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_citation_addons + - credentials + - default_root_folder + - external_citation_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Citation Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_citation_service + - configured_citation_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountResponse' + description: '' + tags: &id011 + - user-references + /v1/user-references/{id}/authorized_computing_accounts: + get: + description: Fetch all related AuthorizedComputingAccounts to this UserReference + operationId: user_references_retrieve_2_related_authorized_computing_accounts + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-computing-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_computing_addons + - credentials + - external_computing_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Computing Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_computing_service + - configured_computing_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedComputingAccountResponse' + description: '' + tags: *id011 + /v1/user-references/{id}/authorized_link_accounts: + get: + description: Fetch all related AuthorizedCitationAccounts to this UserReference + operationId: user_references_retrieve_2_related_authorized_link_accounts + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-citation-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_citation_addons + - credentials + - default_root_folder + - external_citation_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Citation Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_citation_service + - configured_citation_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedCitationAccountResponse' + description: '' + tags: *id011 + /v1/user-references/{id}/authorized_storage_accounts: + get: + description: Fetch all related AuthorizedStorageAccounts to this UserReference + operationId: user_references_retrieve_2_related_authorized_storage_accounts + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[authorized-storage-accounts] + schema: + items: + enum: + - id + - url + - display_name + - account_owner + - api_base_url + - auth_url + - authorized_capabilities + - authorized_operations + - authorized_operation_names + - configured_storage_addons + - credentials + - default_root_folder + - external_storage_service + - initiate_oauth + - credentials_available + type: string + type: array + - description: A UUID string identifying this Authorized Storage Account. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - account_owner + - external_storage_service + - configured_storage_addons + - authorized_operations + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/AuthorizedStorageAccountResponse' + description: '' + tags: *id011 + /v1/user-references/{id}/configured_resources: + get: + description: Fetch all related ResourceReferences to this UserReference + operationId: user_references_retrieve_2_related_configured_resources + parameters: + - description: endpoint return only specific fields in the response on a per-type + basis by including a fields[TYPE] query parameter. + explode: false + in: query + name: fields[resource-references] + schema: + items: + enum: + - url + - resource_uri + - configured_storage_addons + - configured_link_addons + - configured_citation_addons + - configured_computing_addons + type: string + type: array + - description: A UUID string identifying this Resource Reference. + in: path + name: id + required: true + schema: + format: uuid + type: string + - description: include query parameter to allow the client to customize which + related resources should be returned. + explode: false + in: query + name: include + schema: + items: + enum: + - configured_storage_addons + - configured_citation_addons + - configured_link_addons + - configured_computing_addons + type: string + type: array + responses: + '200': + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/ResourceReferenceResponse' + description: '' + tags: *id011 diff --git a/gv.html b/gv.html new file mode 100644 index 0000000..82ac642 --- /dev/null +++ b/gv.html @@ -0,0 +1,15 @@ + + + + OSF APIv2 Documentation + + + + + + + + + + + diff --git a/swagger-spec/swagger.yaml b/swagger-spec/swagger.yaml index 2cac001..68c4036 100644 --- a/swagger-spec/swagger.yaml +++ b/swagger-spec/swagger.yaml @@ -14,6 +14,9 @@ info: - Comprehensive error handling and descriptive error codes - OAuth-based authentication and authorization + ## [Addons Service Documentation](/gv) + To view Addons Service documetation, please click [here](/gv) + version: '2.0' termsOfService: 'https://osf.io/terms_of_use/' contact: @@ -1110,7 +1113,7 @@ tags: description: >- **Personal Access Tokens** allow users to authenticate API requests without credentials. - Tokens support fine-grained permissions (scopes) to control API access levels. + Tokens support fine-grained permissions (scopes) to control API access levels. - name: Applications description: >- **OAuth2 Applications** allow external services to securely authenticate and interact with OSF resources via OAuth2. @@ -2124,7 +2127,7 @@ paths: /scopes/{scope_id}/: $ref: 'scopes/scope_detail.yaml' - + ############################ # ACTIONS # ############################