Skip to content

Api 641 add relationship type api endpoints #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SajedHassan wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Api 641 add relationship type api endpoints #19

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
54e9d2e
Add read only for the symmetrical property.
Jun 17, 2021
eff3119
Fix typos | CR API-641
Jun 18, 2021
67e8a68
Rename relationship types query parameter | CR API-641
Jun 18, 2021
1bbcd2a
Address review comments | CR API-641
Jun 22, 2021
04ebcd1
Merge branch 'API-641-add-relationship-api-endpoints' into API-641-ad…
Jun 22, 2021
3991e44
Fix typos in relationship types responses | CR API-641
Jun 24, 2021
7098436
Rename relationship type writable json attribute | CR API-641
Jun 25, 2021
4796db4
Rename relationship type writable json attribute | CR API-641
Jun 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 21 additions & 24 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3336,13 +3336,16 @@ paths:
properties:
variants:
type: array
description: The relationship variants.
minItems: 1
maxItems: 2
description: The relationship variants
items:
type: object
properties:
name:
type: string
description: The relationship variant name.
maxLength: 35 chars
description: The relationship variant name
example: Partner
responses:
201:
Expand All @@ -3359,12 +3362,8 @@ paths:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
relationship_types:
type: array
items:
properties:
relationship_type:
$ref: '#/components/schemas/Relationship_Type'
relationship_type:
$ref: '#/components/schemas/Relationship_Type'
400:
$ref: '#/components/responses/400'
401:
Expand Down Expand Up @@ -3400,7 +3399,7 @@ paths:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
deal:
relationship_type:
$ref: '#/components/schemas/Relationship_Type'
400:
$ref: '#/components/responses/400'
Expand Down Expand Up @@ -3429,7 +3428,9 @@ paths:
properties:
variants:
type: array
description: The relationship variants.
minItems: 1
maxItems: 2
description: The relationship variants
items:
type: object
properties:
Expand All @@ -3440,7 +3441,8 @@ paths:
example: 5aaa9b059007ba08c9ebaf59
name:
type: string
description: The relationship variant name.
maxLength: 35 chars
description: The relationship variant name
example: Partner
responses:
200:
Expand All @@ -3457,7 +3459,7 @@ paths:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
deal:
relationship_type:
$ref: '#/components/schemas/Relationship_Type'
400:
$ref: '#/components/responses/400'
Expand Down Expand Up @@ -8990,7 +8992,7 @@ components:
description: >-
The relationship types that identifies the relationships between the contacts.
required:
- relationship_variants
- variants
properties:
id:
type: string
Expand All @@ -9000,11 +9002,13 @@ components:
example: 5aaa9b059007ba08c9ebaf58
symmetrical:
type: boolean
description: Is the relationship symmetrical? (read only).
description: Is the relationship symmetrical? (read only)
readOnly: true
example: true
relationship_variants:
variants:
type: array
minItems: 1
maxItems: 2
items:
type: object
properties:
Expand All @@ -9016,6 +9020,7 @@ components:
example: 5aaa9b059007ba08c9ebaf59
name:
type: string
maxLength: 35 chars
description: The relationship variant name
example: Partner
created_at:
Expand Down Expand Up @@ -10815,18 +10820,10 @@ components:
name: search
in: query
required: false
description: Search relationship types by relationship variants
description: Search relationship types by relationship variant name
schema:
type: string
example: Partner
query_relationships_search:
name: search
in: query
required: false
description: Search relationships by contact name or relationship-variant name
schema:
type: string
example: Jack Aranda
query_contacts_owner_id:
name: owner_id
in: query
Expand Down