api/yaml/openapi/components/schemas/Organisation.yaml (28 lines of code) (raw):

######################################################################## # Organisation # ######################################################################## properties: sourceCount: description: The number of sources in this organisation example: 45 type: integer docCount: description: The number of source objects gathered from this organisation example: 973624 type: integer id: description: the ID of the organisation, can be anything. example: demo type: string description: description: A short (optional) description of the organisation example: demo, inc. is awesome type: string name: description: The name of the organisation to create example: Kibble, Inc. type: string admins: description: An array containing the IDs of the admins of this org type: array exammple: ['foo@bar', 'bar@foo'] required: - id - name