Skip to content

Commit

Permalink
chore: relationship request -> pending relationship
Browse files Browse the repository at this point in the history
  • Loading branch information
@Magnus-Kuhn
Magnus-Kuhn committed Jul 8, 2024
1 parent c748ab0 commit e299869
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/modules/coreHttpApi/openapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3056,7 +3056,7 @@ paths:
type: string
format: date-time
example: 2023-01-01
description: A timestamp that describes when this relationship template expires. Expired templates cannot be used to create relationship requests anymore.
description: A timestamp that describes when this relationship template expires. Expired templates cannot be used to create pending relationships anymore.

This comment has been minimized.

Sign in to view

Copy link
@jkoenig134

jkoenig134 Jul 8, 2024

Member

Why pending? I'd just say relationships here.

This comment has been minimized.

Sign in to view

Copy link
@Magnus-Kuhn

Magnus-Kuhn Jul 8, 2024

Author Contributor

eh... you should see my documentation PR :D
I just decided to follow the style I've already seen in the documentation to have clunky but consistent wording, I'd be fine with not doing it like this

This comment has been minimized.

Sign in to view

Copy link
@jkoenig134

jkoenig134 Jul 8, 2024 •
edited
Loading

Member

In most cases it's totally ok to talk about pending relationships. but if we talk about creating a relationship we should not talk about creating a pending relationship as this is the only thing we can do. we can't create an Active relationship for example.

This comment has been minimized.

Sign in to view

Copy link
@Magnus-Kuhn

Magnus-Kuhn Jul 8, 2024

Author Contributor

I start with "create pending relationship" to explain, and stick with it to be consistent. I assume that integrators read the documentation (I think the incoming relationship vs pending relationship is similar - it depends on the documentation)

This comment has been minimized.

Sign in to view

Copy link
@jkoenig134

jkoenig134 Jul 8, 2024 •
edited
Loading

Member

IMO it's to verbose. One other word to understand. Let's remove it here and discuss other occurrences in the docs.

This comment has been minimized.

Sign in to view

Copy link
@Magnus-Kuhn

Magnus-Kuhn Jul 8, 2024

Author Contributor

alright
content:
allOf:
- $ref: "#/components/schemas/RelationshipTemplateContent"
Expand Down

0 comments on commit e299869

Please sign in to comment.