Skip to content

Commit e10b6a5

Browse files
committed
fix: restore resource links
1 parent 1542757 commit e10b6a5

2 files changed

Lines changed: 84 additions & 82 deletions

File tree

docs/v1/affinity_api_docs.md

Lines changed: 80 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -442,15 +442,15 @@ GET /field-values Response:
442442
4. Locate field values for a given set of fields (optional)
443443

444444
1. Query
445-
GET /fields
445+
[`GET /fields`](#get-fields)
446446
to get all fields. If the given set of fields are all list-specific, it is helpful to pass along the
447-
list_id
447+
`list_id`
448448
parameter to prefilter the results
449449
2. Filter results of
450-
GET /fields
450+
[`GET /fields`](#get-fields)
451451
by field name to get the appropriate field ID
452452
3. Cross-reference the
453-
field_id
453+
`field_id`
454454
from Step 3 with the field ID
455455

456456
```
@@ -490,12 +490,12 @@ GET /lists Response:
490490
2. Locate the appropriate status field:
491491

492492
1. Query
493-
GET /fields
493+
[`GET /fields`](#get-fields)
494494
to get all fields. If the given set of fields are all list-specific, it is helpful to pass along the list_id parameter to prefilter the results
495495
2. Filter results of
496-
GET /fields
496+
[`GET /fields`](#get-fields)
497497
by field name and cross-reference the
498-
list_id
498+
`list_id`
499499
with the appropriate list ID from Step 1 to confirm you have the appropriate status field
500500

501501
```
@@ -693,12 +693,12 @@ GET /relationships-strengths Response:
693693

694694
## Useful Resources
695695

696-
- Postman Collection
696+
- [Postman Collection](/postman/collection.json)
697697
(Right-click and save as JSON then import into
698-
Postman
698+
[Postman](https://www.postman.com/)
699699
)
700-
- Affinity Zapier Integrations
701-
- Affinity Tray Connectors
700+
- [Affinity Zapier Integrations](https://zapier.com/apps/affinity/integrations)
701+
- [Affinity Tray Connectors](https://tray.io/documentation/connectors/service/affinity)
702702

703703
# Partner With Us
704704

@@ -5249,60 +5249,58 @@ curl "https://api.affinity.co/rate-limit" -u :$API_KEY
52495249
**2024-07-17**
52505250

52515251
- At least one associated person, company, opportunity, or parent note must be specified when
5252-
creating a note
5252+
[creating a note](#create-a-new-note)
52535253
.
52545254

52555255
**2024-05-01**
52565256

5257-
- /interactions
5257+
- `/interactions`
52585258
now restricts the duration between
5259-
start_time
5259+
`start_time`
52605260
and
5261-
end_time
5261+
`end_time`
52625262
to a maximum of one year
5263-
- /interactions
5263+
- `/interactions`
52645264
now ensures that the provided
5265-
start_time
5265+
`start_time`
52665266
is before the provided
5267-
end_time
5267+
`end_time`
52685268
year
5269-
- /interactions
5269+
- `/interactions`
52705270
now has a maximum
5271-
page_size
5271+
`page_size`
52725272
of 100.
52735273

52745274
**2023-08-07**
52755275

52765276
- Added
5277-
associated_person_ids
5277+
`associated_person_ids`
52785278
,
5279-
interaction_person_ids
5279+
`interaction_person_ids`
52805280
,
5281-
interaction_id
5281+
`interaction_id`
52825282
, and
5283-
interaction_type
5283+
`interaction_type`
52845284
to
5285-
the note resource
5285+
[the note resource](#the-note-resource)
52865286
. The
5287-
person_ids
5287+
`person_ids`
52885288
,
5289-
associated_person_ids
5289+
`associated_person_ids`
52905290
, and
5291-
interaction_person_ids
5291+
`interaction_person_ids`
52925292
properties on a note should now reflect the various ways a note can be tied to a person.
52935293

52945294
**2023-07-27**
52955295

52965296
- datetime values in webhook bodies and API responses are ISO 8601-formatted date strings. For example:
5297-
"2023-06-21T16:00:28.315-07:00"
5297+
`"2023-06-21T16:00:28.315-07:00"`
52985298
.
52995299

53005300
**2023-07-17**
53015301

53025302
- Add information about
5303-
notes with
5304-
type
5305-
1
5303+
[notes with `type` 1](#the-note-resource)
53065304
.
53075305

53085306
**2023-07-03**
@@ -5312,173 +5310,173 @@ curl "https://api.affinity.co/rate-limit" -u :$API_KEY
53125310
**2023-06-13**
53135311

53145312
- The
5315-
created_at
5313+
`created_at`
53165314
parameter on the
5317-
POST endpoint for notes
5315+
[POST endpoint for notes](#create-a-new-note)
53185316
no longer accepts timestamps in the future.
53195317

53205318
**2023-05-17**
53215319

53225320
- Added
5323-
403 error code
5321+
[403 error code](#requests-amp-responses)
53245322
for permissions-related errors.
53255323

53265324
**2023-03-27**
53275325

53285326
- Added the ability to
5329-
create a List
5327+
[create a List](#create-a-new-list)
53305328
.
53315329
- Updated
5332-
Postman collection
5330+
[Postman collection](#useful-resources)
53335331
to help developers get started.
53345332
- Added
5335-
documentation
5333+
[documentation](#formatting-content-as-html)
53365334
on formatting options for HTML notes.
53375335

53385336
**2023-03-09**
53395337

53405338
- Account for chat messages when returning interaction info on the GET endpoints for
5341-
Persons
5339+
[Persons](#persons)
53425340
and
5343-
Organizations
5341+
[Organizations](#organizations)
53445342
.
53455343

53465344
**2023-02-28**
53475345

53485346
- Added the ability to
5349-
create HTML notes
5347+
[create HTML notes](#create-a-new-note)
53505348
.
53515349
- Added the ability to
5352-
create a note within a thread
5350+
[create a note within a thread](#create-a-new-note)
53535351
.
53545352

53555353
**2023-02-10**
53565354

53575355
- Added
5358-
Rate Limit Headers
5356+
[Rate Limit Headers](#rate-limit-headers)
53595357
section to the
5360-
Rate Limits
5358+
[Rate Limits](#rate-limits)
53615359
documentation.
53625360

53635361
**2023-02-08**
53645362

53655363
- Added
5366-
created_at
5364+
`created_at`
53675365
and
5368-
updated_at
5366+
`updated_at`
53695367
timestamps to
5370-
Field Values
5368+
[Field Values](#field-values)
53715369
.
53725370
- Added an
5373-
updated_at
5371+
`updated_at`
53745372
timestamp to
5375-
Notes
5373+
[Notes](#notes)
53765374
.
53775375

53785376
**2023-02-07**
53795377

53805378
- Added the ability to retrieve Current Organization column data on
5381-
Persons
5379+
[Persons](#persons)
53825380
.
53835381

53845382
**2022-09-06**
53855383

53865384
- Added
5387-
Rate Limit
5385+
[Rate Limit](#rate-limit)
53885386
endpoint and documentation. Moved from a daily to a per minute per user limit. Monthly per account limits remain the same.
53895387

53905388
**2022-09-02**
53915389

53925390
- Added
5393-
entity_type
5391+
`entity_type`
53945392
and
5395-
exclude_dropdown_options
5393+
`exclude_dropdown_options`
53965394
documentation to
5397-
Fields
5395+
[Fields](#fields)
53985396
.
53995397

54005398
**2022-05-05**
54015399

54025400
- Added
5403-
enrichment_source
5401+
`enrichment_source`
54045402
documentation to
5405-
Fields
5403+
[Fields](#fields)
54065404
.
54075405

54085406
**2022-04-11**
54095407

54105408
- Added
5411-
Partner With Us
5409+
[Partner With Us](#partner-with-us)
54125410
section.
54135411

54145412
**2022-03-21**
54155413

54165414
- Added
5417-
opportunity_ids
5415+
`opportunity_ids`
54185416
fields to person and organization responses.
54195417

54205418
**2022-02-23**
54215419

54225420
- Added
5423-
Interactions API
5421+
[Interactions API](#interactions)
54245422
documentation.
54255423

54265424
**2022-02-17**
54275425

54285426
- Updated
5429-
GET entity files
5427+
[GET entity files](#get-all-files)
54305428
and entity file webhooks to exclude non-user uploaded files.
54315429

54325430
**2022-02-03**
54335431

54345432
- Added
5435-
Whoami API
5433+
[Whoami API](#whoami)
54365434
documentation.
54375435

54385436
**2022-02-01**
54395437

54405438
- Added
5441-
Reminder API
5439+
[Reminder API](#reminders)
54425440
documentation.
54435441
- Added
5444-
Reminder webhook
5442+
[Reminder webhook](/#webhooks)
54455443
events.
54465444

54475445
**2022-01-28**
54485446

54495447
- Added
5450-
organization.merged
5448+
`organization.merged`
54515449
event to
5452-
Webhooks
5450+
[Webhooks](#webhooks)
54535451
.
54545452
- Added
5455-
mentioned_person_ids
5453+
`mentioned_person_ids`
54565454
and
5457-
is_meeting
5455+
`is_meeting`
54585456
fields to
5459-
Notes
5457+
[Notes](#notes)
54605458
.
54615459

54625460
**2021-11-22**
54635461

54645462
- Added link out to
5465-
Help Center
5463+
[Help Center](https://support.affinity.co/s/article/Types-of-webhooks-available-with-Affinity-s-API)
54665464
for webhook responses
54675465

54685466
**2021-11-19**
54695467

54705468
- Updated
5471-
GET field values changes
5469+
[GET field values changes](#get-field-values-changes)
54725470
to be filterable by
5473-
action_type
5471+
`action_type`
54745472
,
5475-
person
5473+
`person`
54765474
,
5477-
organization
5475+
`organization`
54785476
,
5479-
opportunity
5477+
`opportunity`
54805478
or
5481-
list_entry
5479+
`list_entry`
54825480
by passing in the appropriate parameter.
54835481

54845482
**2021-10-15**
@@ -5494,25 +5492,25 @@ curl "https://api.affinity.co/rate-limit" -u :$API_KEY
54945492

54955493
- Revamped API documentation
54965494
- Added
5497-
Common Use Cases
5495+
[Common Use Cases](#common-use-cases)
54985496
section.
54995497
- Added
5500-
Rate Limits
5498+
[Rate Limits](#rate-limits)
55015499
section.
55025500
- Updates to
5503-
PUT
5501+
`PUT`
55045502
and
5505-
POST
5503+
`POST`
55065504
cURL examples.
55075505

55085506
**2021-08-18**
55095507

55105508
- Fixed typo in the API docs where
5511-
entity_id
5509+
`entity_id`
55125510
and
5513-
creator_id
5511+
`creator_id`
55145512
was in path paramaters when they should be inside the payload parameters for
5515-
Create a New List Entry
5513+
[Create a New List Entry](#create-a-new-list-entry)
55165514
.
55175515

55185516
**2021-07-28**

tools/v1_sync_pipeline/sync_v1_docs.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -559,6 +559,10 @@ def render_block(self, node) -> List[str]: # noqa: ANN001
559559
if node.name == "hr":
560560
return ["---"]
561561

562+
if node.name in {"a", "span", "strong", "em", "b", "i", "code"}:
563+
rendered = self.render_inline(node)
564+
return [rendered] if rendered else []
565+
562566
if node.name == "blockquote":
563567
text = self.render_inline_children(node).strip()
564568
if text.lower() in {"example request", "example response"}:

0 commit comments

Comments
 (0)